Finance document

Get list of accounting documents.

List of accounting documents

get/rest/api/finance/documents/

Query parameters

type1 | 5 | 10 | 31

Type of accounting document (1-Invoice, 5-Receipt, 10-Proforma, 31-Corrective invoice)

hasDocumentDocumentType1 | 2

A DocumentDocument of the specified type is created (1-printed, 2-exported to an external platform)

hasNotDocumentDocumentType1 | 2

A DocumentDocument of the specified type is not created (1-printed, 2-exported to an external platform)

isFiscalboolean

Only for type Receipt type (type=5)

documentConfig[]integer[]

ID of <a href='#tag/Finance-document/operation/get_rest_finance_document_configs_index'>accounting document numbering series</a>

invoiceBeforestring date-time

Date of finance document invoice at before date, takes the value of ISO 8601 date encoded to URL, e.g. 2022-03-01T14:40:33+0200

invoiceAfterstring date-time

Date of finance document invoice at after date, takes the value of ISO 8601 date encoded to URL, e.g. 2022-03-01T14:40:33+0200

offsetinteger

Position indicator (0-beginning, 1-skips one record, 256 - skips 256 records)

limitinteger

Limit of returned results, max 512 records

Response

Returns list of accounting documents

totalCountinteger

Number of matching results

currentOffsetinteger

Current list offset

pageResultCountinteger

Number of results per page

Example response

{
  "documents": [
    {
      "id": 3148,
      "documentNumber": "INV/3/12/2023",
      "originalAmountTotalWithTax": "123.00",
      "originalAmountTotalWithoutTax": "100.00",
      "originalCurrencyExchangeValue": "1.0000",
      "originalCurrency": "PLN",
      "currency": "PLN",
      "createdAt": "2023-11-24T08:33:07+0100",
      "invoicedAt": "2023-11-20",
      "soldAt": "2023-11-20",
      "documentReceiver": {
        "id": 1121,
        "name": "Jan Kowalski",
        "companyName": "Kowalsky Sp. z o.o.",
        "companyTaxNumber": "1573091058",
        "streetName": "ul. Pawia",
        "streetNumber": "9",
        "city": "Kraków",
        "zipCode": "31-154",
        "country": "PL",
        "type": "company"
      },
      "documentIssuer": {
        "id": 1121,
        "name": "Jan Kowalski",
        "companyName": "Kowalsky Sp. z o.o.",
        "companyTaxNumber": "1573091058",
        "streetName": "ul. Pawia",
        "streetNumber": "9",
        "city": "Kraków",
        "zipCode": "31-154",
        "country": "PL",
        "type": "company"
      },
      "documentItems": [
        {
          "id": 329,
          "quantity": 1,
          "name": "FV/1/12/2020",
          "sku": "P44/3-T1.2",
          "ean": "400638133393",
          "unit": "Szt."
        }
      ],
      "paymentType": 3,
      "orderId": "MA250302531"
    }
  ],
  "totalCount": 7398,
  "pageResultCount": 64
}

Changes

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