Invoices

Search invoices.

Search invoices. Returns a list containing basic information for the invoices. The ID in each result entry can be used to fetch complete invoice details with the GET /invoices/{invoiceId} endpoint. Supports purchase, purchase order, sales, sales order, self-assessed tax, travel and expense (bill of charges) invoices.

get/invoices

Request

  • Base URL: https://pts-api.procountor.com/api
  • URL: https://pts-api.procountor.com/api/invoices
  • Auth: HTTP bearer

Query parameters

statusstring[]

Invoice status

startDatestring date

Start date of the search (invoice billing date)

endDatestring date

End date of the search (invoice billing date)

createdStartDatestring date-time

Start date of the search (invoice created date)

createdEndDatestring date-time

End date of the search (invoice created date)

versionStartDatestring date-time

Start date of the search (invoice updated date)

versionEndDatestring date-time

End date of the search (invoice updated date)

dueStartDatestring date

Start date of the search (invoice due date)

dueEndDatestring date

End date of the search (invoice due date)

typesstring[]

Invoice types. Supports more than one invoice status, separated by comma

businessPartnerIdinteger

Search invoices with given business partner ID

factoringContractIdinteger

Search invoices with given factoring contract Id

originalInvoiceNumberstring

Search invoices with given original invoice number

invoiceNumberinteger

Search invoices with given invoice number

productIdinteger[]

Search invoices containing a row with the given product ID. Supports multiple values separated by comma. Maximum 200 values.

searchTermstring

Search invoices by searchTerm. Allows searching by counterpartyAddress.name, invoiceNumber and additionalInformation.

isOfferboolean

Search invoices with given isOffer value. Supported only for SALES_ORDER type.

previousIdinteger

Previous invoice ID for pagination

orderById'ASC' | 'DESC'

Order the results by invoice ID

orderByDate'ASC' | 'DESC'

Order the results by date

orderByCreated'ASC' | 'DESC'

Order the results by created date

orderByVersion'ASC' | 'DESC'

Order the results by version (updated date)

sizeinteger

Page size for the results. Maximum value: 200.

pageinteger

Page number for the results

invoiceChannelstring[]

Invoice channel

Response

Invoices were successfully found.

Example response

{
  "results": [
    {
      "type": "PURCHASE_INVOICE",
      "status": "UNFINISHED",
      "created": "2017-09-27T12:12:42",
      "version": "2017-09-27T12:12:42",
      "counterParty": {
        "counterPartyAddress": {
          "country": "SWEDEN"
        }
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.