DocCloud API

GetSettlementAmountsQuery

The following routes are available for this service:
GET	/settlement/amounts	Calculate amounts for filtered settlements

**SettlementFilterQueryBase** Parameters:
Name	Parameter	Data Type	Required
IsIncome	form	bool?	No
IsCleared	form	bool?	No
InvoiceNumber	form	string	No
RecipientId	form	List<uint>	No
CurrencyId	form	List<uint>	No
PaymentTypeId	form	List<int>	No
SettlementAmountFrom	form	decimal?	No
SettlementAmountTo	form	decimal?	No
RegulatedAmountFrom	form	decimal?	No
RegulatedAmountTo	form	decimal?	No
ToRegulateFrom	form	decimal?	No
ToRegulateTo	form	decimal?	No
SellDateFrom	form	DateTime?	No
SellDateTo	form	DateTime?	No
PaymentDueDateFrom	form	DateTime?	No
PaymentDueDateTo	form	DateTime?	No
CreatedDateFrom	form	DateTime?	No
CreatedDateTo	form	DateTime?	No

**PaginatedOrderedRequestBase** Parameters:
Name	Parameter	Data Type	Required
OrderBy	form	string	No
SortType	form	string	No
Pages	form	int	No
Amount	form	int	No

**BaseResponse<T>** Parameters:
Name	Parameter	Data Type	Required
MultipleResult	form	IList<T>	No
Total	form	int	No
Offset	form	int	No

**BaseSingleResponse<T>** Parameters:
Name	Parameter	Data Type	Required	Description
Result	form	T	No

**SettlementAmountsDto** Parameters:
Name	Parameter	Data Type	Required
Incomes	form	decimal	No
Outgoings	form	decimal	No
CurrencyId	form	uint	No

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

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

GET /settlement/amounts HTTP/1.1 
Host: api.chmuradokumentow.pl 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"total":0,"offset":0,"result":{"incomes":0,"outgoings":0,"currencyId":0}}