DocCloud API

<back to all web services

ListRecipientFilterQuery

Requires Authentication
The following routes are available for this service:
GET/recipient/filterGet All Filter Recipients
ListRecipientFilterQuery Parameters:
NameParameterData TypeRequiredDescription
NamequerystringNo
NipquerystringNo
RegonquerystringNo
KrsquerystringNo
StreetNamequerystringNo
TownquerystringNo
CountryquerystringNo
CatIdqueryList<uint>No
TypeIdqueryList<uint>No
CountryIdqueryList<int>No
PaginatedOrderedRequestBase Parameters:
NameParameterData TypeRequiredDescription
OrderByformstringNo
SortTypeformstringNo
PagesformintNo
AmountformintNo
MultipleResultBaseResponse<T> Parameters:
NameParameterData TypeRequiredDescription
MultipleResultformIList<T>No
AmountformlongNo
RecipientDto Parameters:
NameParameterData TypeRequiredDescription
ShortNameformstringNo
NameformstringNo
NipformstringNo
RegonformstringNo
KrsformstringNo
CatIdformuintNo
TypeIdformintNo
RecipientCTypeformstringNo
DescriptionformstringNo
StreetNameformstringNo
StreetNumberformstringNo
StreetFlatNumberformstringNo
PostalCodeformstringNo
TownformstringNo
CountryIdformintNo
IsoCountryformstringNo
CountryformstringNo
EmailformstringNo
WebSiteformstringNo
PhoneNumberformstringNo
FaxNumberformstringNo
PhoneNumber1formstringNo
MobileNumberformstringNo
BankAccNameformstringNo
BankAccNumberformstringNo
DefaultPaymentTypeformstringNo
DefaultPaymentTermformuintNo
DefaultDiscountformdecimalNo
DefaultCurrencyIdformuintNo
DefaultCurrencyformstringNo
CategoryIdformuintNo
CategoryNameformstringNo
BaseKeyDto Parameters:
NameParameterData TypeRequiredDescription
CreatedByIdformuintNo
ModifiedByIdformuintNo
CreatedDateformDateTimeNo
ModifiedDateformDateTimeNo
IdformuintNo

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.

GET /recipient/filter HTTP/1.1 
Host: api.chmuradokumentow.pl 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"amount":0}