DocCloud API

<back to all web services

ListJpkDocumentQuery

Requires Authentication
The following routes are available for this service:
GET/jpk/documentList jpk documents
BaseResponse<T> Parameters:
NameParameterData TypeRequiredDescription
MultipleResultformIList<T>No
TotalformintNo
OffsetformintNo
BaseSingleResponse<T> Parameters:
NameParameterData TypeRequiredDescription
ResultformTNo
JpkDocumentDto Parameters:
NameParameterData TypeRequiredDescription
JpkDateformDateTimeNo
StatusformintNo
IsMonthlyformboolNo
TaxTemplateIdformuintNo
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 /jpk/document 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":{"jpkDate":"0001-01-01T00:00:00.0000000Z","status":0,"isMonthly":false,"taxTemplateId":0,"createdById":0,"modifiedById":0,"createdDate":"0001-01-01T00:00:00.0000000Z","modifiedDate":"0001-01-01T00:00:00.0000000Z","id":0}}