DocCloud API

ListSettlementQuery

The following routes are available for this service:
GET	/settlement	List 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

**MultipleResultBaseResponse<T>** Parameters:
Name	Parameter	Data Type	Required	Description
MultipleResult	form	IList<T>	No
Amount	form	long	No

**SettlementDto** Parameters:
Name	Parameter	Data Type	Required
InvoiceId	form	ulong	No
IsIncome	form	bool	No
DocumentNumber	form	string	No
Interest	form	decimal	No
SellDate	form	DateTime	No
PaymentDueDate	form	DateTime	No
Amount	form	decimal	No
RegulatedAmount	form	decimal	No
IsCleared	form	bool	No
IsMarkedClear	form	bool	No
ClearedDate	form	DateTime	No
ToRegulate	form	decimal	No
Outgoing	form	decimal	No
Income	form	decimal	No
Currency	form	string	No
CurrencyId	form	uint	No
PaymentTypeId	form	int	No
Description	form	string	No
CategoryName	form	string	No
CategoryId	form	uint	No
Recipient	form	RecipientDto	No
Documents	form	IList<CashBankRecordDocumentDto>	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

**RecipientDto** Parameters:
Name	Parameter	Data Type	Required
ShortName	form	string	No
Name	form	string	No
Nip	form	string	No
Regon	form	string	No
Krs	form	string	No
CatId	form	uint	No
TypeId	form	int	No
RecipientCType	form	string	No
Description	form	string	No
StreetName	form	string	No
StreetNumber	form	string	No
StreetFlatNumber	form	string	No
PostalCode	form	string	No
Town	form	string	No
CountryId	form	int	No
IsoCountry	form	string	No
Country	form	string	No
Email	form	string	No
WebSite	form	string	No
PhoneNumber	form	string	No
FaxNumber	form	string	No
PhoneNumber1	form	string	No
MobileNumber	form	string	No
BankAccName	form	string	No
BankAccNumber	form	string	No
DefaultPaymentType	form	string	No
DefaultPaymentTerm	form	uint	No
DefaultDiscount	form	decimal	No
DefaultCurrencyId	form	uint	No
DefaultCurrency	form	string	No
CategoryId	form	uint	No
CategoryName	form	string	No

**BaseKeyDto** Parameters:
Name	Parameter	Data Type	Required
CreatedById	form	uint	No
ModifiedById	form	uint	No
CreatedDate	form	DateTime	No
ModifiedDate	form	DateTime	No
Id	form	uint	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

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 HTTP/1.1 
Host: api.chmuradokumentow.pl 
Accept: text/csv

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

{"amount":0}