API Reference

Create document

post
https://api.atlar.com/accounting/v2beta/documents

Create a new accounting document.

Body Params
string
required

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

string
enum
required

The type of document.

Allowed:
amount
object
required

The amount of the document.

remainingAmount
object

The remaining (unapplied or unpaid) portion of the document´s total amount. For SOURCE documents, this indicates how much remains to be paid or settled. For example, an unpaid invoice shows the outstanding amount; for a customer payment awaiting deposit, it reflects the undeposited value. For INSTRUCTION documents, this field shows the portion of the payment that has been applied to reduce the remaining amount of the linked SOURCE document.

date
required

The document date (e.g. a due date for an invoice or a transaction date for a payment).

string
required
length between 1 and 255

The description of the document.

string
length between 1 and 255

The reference of the document.

references
object
required

The references of the document.

counterparty
object

Details about the counterparty (e.g. a customer or vendor).

boolean
required

Whether the document is voided in the accounting system.

string
enum
required

The reconciliation status of the document.

Allowed:
string

The reconciliation match that this document is associated with.

glEntries
array of objects
required
length ≥ 1

The general ledger entries for this document.

glEntries*
string
required
string
required
amount
object
required
string
enum
required
Allowed:
appliedDocuments
array of objects

The sibling relationship between documents, the documents that are applied to this document (e.g. payments applied to an invoice and vice versa).

appliedDocuments
provenance
object
required

Metadata capturing the source and history of this document, including when it was created and its identifier in the originating external system.

date-time
required

When the document was created in the originating external system.

string

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.

currencyExchange
object

The currency exchange from the ledger entity's currency to the document's currency. Only present if the document's currency is different from the ledger entity's currency.

Responses

Updated about 21 hours ago

Language
Credentials
Basic
base64
:
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated about 21 hours ago