ALaltera-co
Sales

Get invoice data

Changed on

Retrieve data for a particular invoice available in the system

This endpoint may be used as a base for new invoice data that we wish to create based on a set of related invoices

If you wish to generate such object base you will need to provide both:

  • related parameter, listing the related invoices
  • invoiceType of the new invoice we wish to create

The return object will be a temporary invoice object you may further extend before saving it.

Missing, permanently deleted and other-company invoices return 404 NOT_FOUND with a generic message. Own soft-deleted invoices return 404 NOT_FOUND with "Invoice has been deleted" and no invoice data. This applies to ref and related lookups. For CORRECTION, rows come from the referenced document, without applying later corrections automatically. Reference the previous correction to use its stored after-correction state.

get/sales/invoice

Request

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

Query parameters

refinteger
Example:36891

InvoiceId identificator of the exact invoice we wish to retrieve

unknown

Comma delimited list of related invoices we wish to create a reference from. For CORRECTION this copies the referenced invoice, not the cumulative state after previous corrections. For a correction of a correction, pass the previous correction identifier.

invoiceType'SALES' | 'CORRECTION' | 'INTERIM_FINAL'
Example:CORRECTION

Invoice type for the new invoice we wish to create based on related invoices

Response

OK

resultstring

Example response

{
  "data": {
    "invoice": {
      "basicInformation": {
        "invoiceType": "SALES",
        "currency": "EUR",
        "language": "en"
      },
      "invoicePosition": [
        {
          "gtu": "2"
        }
      ]
    },
    "relatedInvoices": [
      {
        "basicInformation": {
          "invoiceType": "SALES",
          "currency": "EUR",
          "language": "en"
        },
        "invoicePosition": [
          {
            "gtu": "2"
          }
        ]
      }
    ]
  }
}

Changes

  • 45544bcb4e8aRevision changes
    • breaking

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

    • breaking

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

    • info

      added the non-success response with the status

    • info

      added the non-success response with 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

    • 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

  • 901474a58f63Revision changes
    • info

      added the optional property to the response with the status