Accounts5

Audit logs1

Connections6

Counterparties6

Credit Transfers14

Direct Debits13

Documents6

Entities5

External Accounts5

Forecasted Transactions10

GL Accounts4

GL Classifications7

GL Entities4

Investments8

Mandates5

OAuth1

Pending Transactions4

Regulatory Reporting1

Transactions6

Webhooks8

Webhooks

Events (webhooks)1

Documents

Create document

Changed on Nov 3, 2026

Create an accounting document, typically from a custom ERP integration.

classification and reconciliationStatus are assigned by the server from glEntries and reconciliation state. Re-posting the same provenance.vendorId with identical payload returns the existing document; a conflicting payload returns 409.

post/accounting/v2beta/documents

Request

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

Request body

glEntityIdstring required

The Atlar general ledger entity id that this document is associated with.

ERP document category. Typical reconciliation roles:

INVOICE, CREDIT_MEMO, PURCHASE_ORDER, EXPENSE_REPORT — usually SOURCE (open balance on remainingAmount).
PAYMENT — usually INSTRUCTION (posts to a bank GL account).
JOURNAL_ENTRY, TRANSFER — SOURCE or INSTRUCTION depending on glEntries (bank lines imply INSTRUCTION).

datestring date required

full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21.

issueDatestring date

full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21.

descriptionstring required

The description of the document.

referencestring

Primary business reference for matching (e.g. invoice or payment number).

referencesobject required

Additional keyed references for matching and search (e.g. memo, check number).

voidedboolean required

Whether the document is voided in the accounting system.

reconciliationMatchIdstring

Match ID when mirroring ERP state. Only valid with reconciliationStatus RECONCILED; otherwise leave unset.

outgoingDocumentIdstring

Outgoing document ID when this ERP row was created from an Atlar reconciliation push. Writable on create; read-only on the stored document once set.

vendorCreatedstring date-time required

When the document was created in the originating external system.

vendorResourceUrlstring

The URL to the document in the originating external system, to help navigate to the document in the originating external system. This differs from the provenance URL, which is the endpoint URL from where it was fetched from.

Example request

{
  "glEntityId": "01925d46-2dd4-7ceb-b929-ed9aa3a9481e",
  "amount": {
    "baseAmount": {
      "currency": "EUR",
      "value": 1502
    },
    "instructedAmount": {
      "currency": "EUR",
      "value": 1502
    }
  },
  "remainingAmount": {
    "baseAmount": {
      "currency": "EUR",
      "value": 1502
    },
    "instructedAmount": {
      "currency": "EUR",
      "value": 1502
    }
  },
  "date": "2022-05-07",
  "issueDate": "2022-05-07",
  "description": "Invoice #10001",
  "reference": "INV-10001",
  "references": {
    "memo": "Some memo reference"
  },
  "glEntries": [
    {
      "vendorBankAccountId": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
      "glClassificationIds": [
        "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8"
      ],
      "amount": {
        "baseAmount": {
          "currency": "EUR",
          "value": 1502
        },
        "instructedAmount": {
          "currency": "EUR",
          "value": 1502
        }
      }
    }
  ],
  "appliedDocuments": [
    {
      "amount": {
        "currency": "EUR",
        "value": 1502
      },
      "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"
  }
}

Response

The created document.

idstring required

Unique resource identifier.

organizationIdstring required

Unique resource identifier for an Organization.

glEntityIdstring required

The Atlar general ledger entity id that this document is associated with.

ERP document category. Typical reconciliation roles:

INVOICE, CREDIT_MEMO, PURCHASE_ORDER, EXPENSE_REPORT — usually SOURCE (open balance on remainingAmount).
PAYMENT — usually INSTRUCTION (posts to a bank GL account).
JOURNAL_ENTRY, TRANSFER — SOURCE or INSTRUCTION depending on glEntries (bank lines imply INSTRUCTION).

classification'SOURCE' | 'INSTRUCTION' required

Classification of a document based on whether it affects a bank GL account:

SOURCE: A document with no child ledger entries affecting a GL account of type BANK (e.g. an invoice).
INSTRUCTION: A document with child ledger entries affecting a GL account of type BANK (e.g. a payment).

datestring date required

full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21.

issueDatestring date required

full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21.

descriptionstring required

The description of the document.

referencestring

Primary business reference used in matching (e.g. invoice or payment number). Prefer this over ad-hoc keys in references when a single main reference exists.

referencesobject required

Additional keyed references for matching and search (e.g. memo, check number). Keys are exposed as document.references.* in reconciliation rules.

voidedboolean required

Whether the document is voided in the accounting system.

reconciliationStatus'OPEN' | 'MATCHED' | 'RECONCILED' | 'IGNORED' required

The reconciliation status of a document:

OPEN: Not yet matched to any counterpart.
MATCHED: Matched but the reconciliation match is not yet approved.
RECONCILED: Part of an approved reconciliation match.
IGNORED: Ignored from reconciliation.

reconciliationMatchIdstring

Unique resource identifier.

outgoingDocumentIdstring

Unique resource identifier.

vendorCreatedstring date-time required

When the document was created in the originating external system.

vendorResourceUrlstring

versioninteger required

Resource version. Starts at value 1 when the resource is created and increases by one for each successive update.

etagstring required

ETag based on the resource version. This can be passed along in If-Match HTTP header when updating a resource to perform a conditional update.

createdstring date-time required

Time at which the resource was created.

updatedstring date-time required

Time at which the resource was last updated.

Example response

{
  "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"
}

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

Create document

Request

Request body

Example request

Response 201Created

Example response

Changes

Response