Get documents

Changed on Nov 3, 2026

Get multiple accounting documents in a batch request.

Provide either ids (latest versions) or idvs (specific versions encoded as <id>@<version>). The two parameters are mutually exclusive; exactly one must be provided.

get/accounting/v2beta/documents:batch

Request

Base URL
https://api.atlar.com
Auth
HTTP basic
TypeScript
https://skmtc.dev/atlar/apis/atlar-api-v2/docs/accounting/v2beta/documents:batch/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

idsstring[]

Atlar resource IDs (latest versions). Mutually exclusive with idvs. Exactly one of ids or idvs must be provided.

idvsstring[]

Atlar resource IDs at specific versions, each encoded as <id>@<version> (e.g. a1b2c3d4-e5f6-7890-abcd-ef1234567890@3). Mutually exclusive with ids. Exactly one of ids or idvs must be provided.

[
  "a1b2c3d4-e5f6-7890-abcd-ef1234567890@3"
]

Response

List of documents.

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",
      "outgoingDocumentId": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
      "glEntries": [
        {
          "id": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
          "glAccountId": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
          "vendorBankAccountId": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
          "glClassificationIds": [
            "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"
    }
  ],
  "failures": [
    {
      "id": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
      "version": 3,
      "code": "not_found",
      "error": "Internal server error (timeout)"
    }
  ]
}

Changes

Nov 3, 2026b49df1e4b3e9 Revision changes
- breaking
  the response property ////// became optional for the status
- warning
  added the new EXPENSE_REPORT enum value to the ///// response property for the response status
- warning
  added the new EXPENSE_REPORT enum value to the /// response property for the response status
- warning
  added the new GL_ENTITY enum value to the //// response property for the response status
- warning
  added the new application/pdf enum value to the ///////// response property for the response status
- warning
  added the new application/pdf enum value to the ///////// response property for the response status
- warning
  added the new application/vnd.adyen.balance-platform.statement-report+csv enum value to the ///////// response property for the response status
- warning
  added the new application/vnd.adyen.balance-platform.statement-report+csv enum value to the ///////// response property for the response status
- warning
  added the new application/vnd.atlar.connectivity.v2.instrument-product-statement+json enum value to the ///////// response property for the response status
- warning
  added the new application/vnd.atlar.connectivity.v2.instrument-product-statement+json enum value to the ///////// response property for the response status
- warning
  added the new application/vnd.blackrock.cachematrix.balance+csv enum value to the ///////// response property for the response status
- warning
  added the new application/vnd.blackrock.cachematrix.balance+csv enum value to the ///////// response property for the response status
- warning
  added the new application/vnd.blackrock.cachematrix.transactions+csv enum value to the ///////// response property for the response status
- warning
  added the new application/vnd.blackrock.cachematrix.transactions+csv enum value to the ///////// response property for the response status
- warning
  added the new application/vnd.deutsche.wealth-online+csv enum value to the ///////// response property for the response status
- warning
  added the new application/vnd.deutsche.wealth-online+csv enum value to the ///////// response property for the response status
- warning
  added the new application/vnd.ebics.hac.v25+xml enum value to the ///////// response property for the response status
- warning
  added the new application/vnd.ebics.hac.v25+xml enum value to the ///////// response property for the response status
- warning
  added the new application/vnd.ebics.hac.v30+xml enum value to the ///////// response property for the response status
- warning
  added the new application/vnd.ebics.hac.v30+xml enum value to the ///////// response property for the response status
- warning
  added the new application/vnd.ebics.htd.v30+xml enum value to the ///////// response property for the response status
- warning
  added the new application/vnd.ebics.htd.v30+xml enum value to the ///////// response property for the response status
- warning
  added the new application/vnd.edi.997 enum value to the ///////// response property for the response status
- warning
  added the new application/vnd.edi.997 enum value to the ///////// response property for the response status
- warning
  added the new application/vnd.iso20022.camt.053.001.12+xml enum value to the ///////// response property for the response status
- warning
  added the new application/vnd.iso20022.camt.053.001.12+xml enum value to the ///////// response property for the response status
- warning
  added the new application/vnd.iso20022.pacs.002.001.10+xml enum value to the ///////// response property for the response status
- warning
  added the new application/vnd.iso20022.pacs.002.001.10+xml enum value to the ///////// response property for the response status
- warning
  added the new application/vnd.iso20022.pain.008.001.08+xml enum value to the ///////// response property for the response status
- warning
  added the new application/vnd.iso20022.pain.008.001.08+xml enum value to the ///////// response property for the response status
- warning
  added the new application/vnd.jpm.daily-feed+zip enum value to the ///////// response property for the response status
- warning
  added the new application/vnd.jpm.daily-feed+zip enum value to the ///////// response property for the response status
- warning
  added the new application/vnd.jpm.morgan-money.balance-report+csv enum value to the ///////// response property for the response status
- warning
  added the new application/vnd.jpm.morgan-money.balance-report+csv enum value to the ///////// response property for the response status
- warning
  added the new application/vnd.jpm.morgan-money.transaction-report+csv enum value to the ///////// response property for the response status
- warning
  added the new application/vnd.jpm.morgan-money.transaction-report+csv enum value to the ///////// response property for the response status
- warning
  added the new application/vnd.jpm.soci.cash-balance+csv enum value to the ///////// response property for the response status
- warning
  added the new application/vnd.jpm.soci.cash-balance+csv enum value to the ///////// response property for the response status
- warning
  added the new application/vnd.jpm.soci.holdings+csv enum value to the ///////// response property for the response status
- warning
  added the new application/vnd.jpm.soci.holdings+csv enum value to the ///////// response property for the response status
- warning
  added the new application/vnd.jpm.soci.transactions+csv enum value to the ///////// response property for the response status
- warning
  added the new application/vnd.jpm.soci.transactions+csv enum value to the ///////// response property for the response status
- warning
  added the new application/vnd.m2.m006.m001+xml enum value to the ///////// response property for the response status
- warning
  added the new application/vnd.m2.m006.m001+xml enum value to the ///////// response property for the response status
- warning
  added the new application/vnd.m2.m006.m005+xml enum value to the ///////// response property for the response status
- warning
  added the new application/vnd.m2.m006.m005+xml enum value to the ///////// response property for the response status
- warning
  added the new application/vnd.nordea.investments.abasec.pos+csv enum value to the ///////// response property for the response status
- warning
  added the new application/vnd.nordea.investments.abasec.pos+csv enum value to the ///////// response property for the response status
- warning
  added the new application/vnd.nordea.investments.abasec.tra+csv enum value to the ///////// response property for the response status
- warning
  added the new application/vnd.nordea.investments.abasec.tra+csv enum value to the ///////// response property for the response status
- warning
  added the new application/zip enum value to the ///////// response property for the response status
- warning
  added the new application/zip enum value to the ///////// response property for the response status
- warning
  added the new text/csv enum value to the ///////// response property for the response status
- warning
  added the new text/csv enum value to the ///////// response property for the response status
- info
  the security scope gl_entities:read was added to the endpoint's security scheme basicAuth
- info
  added the new optional query request parameter idvs
- info
  the query request parameter ids became optional
- 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

Operation history