Document

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

Request

  • Base URL
    https://api.timesheet.io
  • URL
    https://api.timesheet.io/v1/documents
  • Auth
    • HTTP bearer
    • or API key in header Authorization

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

startDatestring

Inclusive lower bound on the document date (yyyy-MM-dd)

endDatestring

Inclusive upper bound on the document date (yyyy-MM-dd)

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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