DocCloud API

ClearSettlementCommand

The following routes are available for this service:
PATCH	/settlement/clear/{id}	Clear settlement

**ClearSettlementCommand** Parameters:
Name	Parameter	Data Type	Required	Description
Id	path	ulong	No
Documents	query	IList<CashBankRecordDocumentDto>	No

**CashBankRecordDocumentDto** Parameters:
Name	Parameter	Data Type	Required
InvoiceNumber	form	string	No
InvoiceSellDate	form	DateTime	No
InvoiceDeadLine	form	DateTime	No
CashBankRecordNumber	form	string	No
RegulatedAmount	form	decimal	No
CashBankRecordId	form	ulong	No
SettlementId	form	ulong	No
IsDeleted	form	bool	No

**BaseKeyLongDto** Parameters:
Name	Parameter	Data Type	Required
CreatedById	form	uint	No
ModifiedById	form	uint	No
CreatedDate	form	DateTime	No
ModifiedDate	form	DateTime	No
Id	form	ulong	No

**PostOperationResult<T>** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	T	No

**OperationResult** Parameters:
Name	Parameter	Data Type	Required
Code	form	string	No
ResponseStatus	form	ResponseStatus	No
Result	form	Object	No
IsSuccess	form	bool	No

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/clear/{id} HTTP/1.1 
Host: api.chmuradokumentow.pl 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"id":0}

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}