Sign in
Document

List documents

Retrieves a paginated list of documents based on filter criteria. Documents can be filtered by organization, type, status, and template flag. Results can be sorted and ordered according to specified parameters.

get/v1/documents

Query parameters

organizationIdstring

Organization ID to filter documents by

type0 | 1 | 2

Document type to filter by: 0 = Invoice, 1 = Timesheet, 2 = Work Record

status'paid' | 'unpaid' | 'approved' | 'notApproved'

Document status to filter by: paid, unpaid, approved, notApproved

templateboolean

Filter by template flag. If true, returns only document templates

sort'date' | 'created' | 'name' | 'customer'

Field to sort results by

order'asc' | 'desc'

Sort order: asc or desc

pageinteger

Page number for pagination

limitinteger

Maximum number of results per page

Response

Successfully retrieved list of documents

Changes

Changed in 1 of the 3 revisions of this API.2

  • 207f2c0646202See the full diff
    • ○

      added the optional property items/items/showSignature to the response with the 200 status (media type: application/json)

      response-optional-property-added

    • ○

      added the optional property items/items/showSignature to the response with the 200 status (media type: application/xml)

      response-optional-property-added