Sign in

v1

latestOpenAPI 3.0.22026-07-223907721.1 MB
accountingData

Query Accounting Data

Delivers a paginated overview of finalized accounting transactions, including invoices, credits, and their cancellations and corrections.

get/v2/accountingData

Query parameters

fromstring date-time

Filters documents starting from a specific date and time

tostring date-time

Filters documents up to a specific date and time

companyIdstring uuid

Represents a key for identifying a firm within the application.

Example:b45f6432-2462-4c6f-b00f-1d9d01000000

Gets the unique identifier for the firm.

type0 | 1 | 2 | 3 | 4 | 5 | 6 | 7

0 = SalesInvoice, 1 = SalesCredit, 2 = SalesInvoiceCorrection, 3 = SalesInvoiceCancellation, 4 = SalesCreditCancellation, 5 = SalesInvoiceCorrectionCancellation, 6 = SalesLiquidation, 7 = SalesLiquidationCancellation

Specifies the type of document. 0 = Invoice, 1 = Credit, 2 = Invoice correction, 3 = Invoice cancellation, 4 = credit cancellation, 5 = invoice correction cancellation

exportCurrencyInDepartureCountryboolean

If true, exports total sums in the currency of the departure country

pageNumberinteger

Number of the page of items to fetch.

pageSizeinteger

Size of the page that is specified by pageNumber.

Headers

x-tenant-idstring uuid required

The tenant ID for the target ERP instance.

x-runasstring

The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.

x-companyidstring

The Company-Id (int or uuid) of the company on whose behalf the request is executed.

Response

Provides a detailed overview of all non-pending sales orders, including invoices, credits, invoice corrections, invoice cancellations, credit cancellations, and invoice correction cancellations, along with their associated line items

totalItemsinteger

Gets or sets the total number of items available in the data source.

pageNumberinteger

Gets or sets the current page number in the paginated list.

pageSizeinteger

Gets or sets the number of items per page in the paginated list.

totalPagesinteger

Gets the total number of pages based on the total number of items and the page size.

hasPreviousPageboolean

Gets a value indicating whether there is a previous page available in the paginated list.

hasNextPageboolean

Gets a value indicating whether there is a next page available.

nextPageNumberinteger

Gets the number of the next page if there is one; otherwise, returns the total number of pages.

previousPageNumberinteger

Gets the number of the previous page. If there is no previous page, it returns 1.

Example response

{
  "items": [
    {
      "salesInvoiceCorrectionId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "salesInvoiceId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "salesOrderId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "companyId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "billingAddress": {
        "id": "b45f6432-2462-4c6f-b00f-1d9d01000000"
      },
      "shipmentAddress": {
        "id": "b45f6432-2462-4c6f-b00f-1d9d01000000"
      },
      "accountDataLineItems": [
        {
          "salesInvoiceCorrectionLineItemId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
          "salesInvoiceLineItemId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
          "itemId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
          "taxClassId": "b45f6432-2462-4c6f-b00f-1d9d01000000"
        }
      ]
    }
  ]
}