v1

latestOpenAPI 3.1.0Apache 2.02026-07-2498321298.8 KB

Documents

Update document

Update an accounting document.

patch/accounting/v2beta/documents/{id}

Path parameters

idstring required

Atlar resource ID.

Headers

If-Matchstring

ETag (version) of resource to be updated.

Response

The updated 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.

The type of accounting document from the ERP system.

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

The reference of the document.

referencesobject required

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.

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.

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