ALaltera-co
Sales

List available invoices

Changed on

Gets a list of invoices created in the system for your company.

get/sales

Request

  • Base URL
    https://api.altera.co
  • URL
    https://api.altera.co/sales
  • Auth
    API key in header Authorization

Query parameters

documentsPerPage'10' | '20' | '50' | '100'

Defines the amount of invoices polled per page

pageNumberstring

Defines the page we want to poll

sortBy'INVOICE_NUMBER' | 'ISSUE_DATE' | 'SALE_DATE' | 'DUE_DATE' | 'AMOUNT_GROSS' | 'CONTRACTOR_NAME'
Example:ISSUE_DATE
order'ASC' | 'DESC'
Example:DESC
searchPhrasestring

Case-insensitive substring search over invoice number, buyer and seller names and tax IDs, registration plate, additionalDetails and invoice line product names. Internal debit-note metadata is excluded. This is free-text search, without external-reference uniqueness or an idempotency guarantee.

contractorNamestring
unknown
paymentStatus'PAID' | 'UNPAID' | 'OVERDUE'
Example:OVERDUE

Response

OK

resultstring

Example response

{
  "result": "OK",
  "data": {
    "invoices": [
      {
        "basicInformation": {
          "invoiceType": "SALES",
          "currency": "EUR",
          "language": "en"
        },
        "invoicePosition": [
          {
            "gtu": "2"
          }
        ]
      }
    ]
  }
}

Changes

  • 45544bcb4e8aRevision changes
    • breaking

      the response property ///// became nullable for the status

    • info

      added the non-success response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

  • f1d82ac65775Revision changes
    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status