v1

latestOpenAPI 3.1.0Apache 2.02026-07-2498321298.8 KB

Documents

List documents

Returns a list of accounting documents.

get/accounting/v2beta/documents

Query parameters

limitinteger

Limit the number of items in resulting query response.

tokenstring

If a query response contains a non-empty nextToken, use that value as token query parameter to continue pagination.

glEntityIdstring

Unique resource identifier.

Example:2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8

Filter by GL entity ID.

reconciliationMatchIdstring

Unique resource identifier.

Example:2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8

Filter by reconciliation match ID.

Response

A list of documents.

nextTokenstring required

Pagination token for next page. The value will be a non-empty string if there are more resources to be fetched. The value will be an empty string if there are no more resources to be fetched.

tokenstring required

The pagination token that was used for this request. The value will be an empty string if no token query parameter was provided with the request.

limitinteger required

The page limit that was used for this request.

Example response

{
  "items": [
    {
      "id": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
      "organizationId": "0160f6ab-5741-49e1-af46-9138927e547e",
      "glEntityId": "01925d46-2dd4-7ceb-b929-ed9aa3a9481e",
      "amount": {
        "baseAmount": {
          "currency": "EUR",
          "stringValue": "15.02",
          "value": 1502
        },
        "instructedAmount": {
          "currency": "EUR",
          "stringValue": "15.02",
          "value": 1502
        }
      },
      "remainingAmount": {
        "baseAmount": {
          "currency": "EUR",
          "stringValue": "15.02",
          "value": 1502
        },
        "instructedAmount": {
          "currency": "EUR",
          "stringValue": "15.02",
          "value": 1502
        }
      },
      "date": "2022-05-07",
      "issueDate": "2022-05-07",
      "invoiceDetails": {
        "settledDate": "2022-05-07"
      },
      "description": "Invoice #10001",
      "reference": "INV-10001",
      "reconciliationStatus": "OPEN",
      "reconciliationMatchId": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
      "glEntries": [
        {
          "id": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
          "glAccountId": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
          "amount": {
            "baseAmount": {
              "currency": "EUR",
              "stringValue": "15.02",
              "value": 1502
            },
            "instructedAmount": {
              "currency": "EUR",
              "stringValue": "15.02",
              "value": 1502
            }
          }
        }
      ],
      "appliedDocuments": [
        {
          "amount": {
            "currency": "EUR",
            "stringValue": "15.02",
            "value": 1502
          },
          "targetDocumentId": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
          "date": "2022-05-07"
        }
      ],
      "provenance": {
        "resource": {
          "contentType": "application/vnd.iso20022.camt.053.001.02+xml"
        }
      },
      "currencyExchange": {
        "sourceCurrency": "EUR",
        "targetCurrency": "SEK",
        "unitCurrency": "EUR",
        "exchangeRate": "11.21320"
      },
      "version": 1,
      "etag": "version:3",
      "created": "2022-05-04T18:31:12.889104898Z",
      "updated": "2022-05-04T18:47:32.213842599Z"
    }
  ],
  "nextToken": "eyIxIjogIlRoaXMgaXMgYSBkdW1teSBwYWdpbmF0aW9uIHRva2VuLiJ9",
  "token": "eyIwIjogIlRoaXMgaXMgYSBkdW1teSBwYWdpbmF0aW9uIHRva2VuLiJ9",
  "limit": 100
}

All 99 operations