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 .jsv suffix or ?format=jsv

HTTP + JSV

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/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	total: 0,
	offset: 0,
	result: 
	{
		jpkDate: 0001-01-01,
		status: 0,
		isMonthly: False,
		taxTemplateId: 0,
		createdById: 0,
		modifiedById: 0,
		createdDate: 0001-01-01,
		modifiedDate: 0001-01-01,
		id: 0
	}
}