DocCloud API

<back to all web services

SettlementMarkAsClearedCommand

Requires Authentication
The following routes are available for this service:
PATCH/settlement/markclearedMark settlement as cleared
SettlementMarkAsClearedCommand Parameters:
NameParameterData TypeRequiredDescription
InvoiceIdqueryulongNo
IsIncomequeryboolNo
MarkClearedqueryboolNo
PostOperationResult<T> Parameters:
NameParameterData TypeRequiredDescription
IdformTNo
OperationResult Parameters:
NameParameterData TypeRequiredDescription
CodeformstringNo
ResponseStatusformResponseStatusNo
ResultformObjectNo
IsSuccessformboolNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PATCH /settlement/markcleared HTTP/1.1 
Host: api.chmuradokumentow.pl 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"invoiceId":0,"isIncome":false,"markCleared":false}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"id":0,"code":"FAIL","responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"result":{},"isSuccess":false}