Match entries

Match existing entries in the accounting system

POST /consumers/{consumer_id}/accounting/matching

Match entries

cURL

curl --request POST \
  --url https://api.chift.eu/consumers/{consumer_id}/accounting/matching \
  --header 'Content-Type: application/json' \
  --data '
{
  "entries": [
    "<string>"
  ],
  "partner_id": "<string>"
}
'

200

Example

{
  "matching_number": "<string>",
  "balance": 123
}

Path Parameters

consumer_id · string<uuid> · required

Query Parameters

folder_id · string | null

Id of the accounting folder instance. A folder represents a legal entity within the system. Required when the multiple folders feature is enabled.

Body

application/json

entries · string[] · required

List of entries to match. Must contain at least 2 entries. Entries are typically journal entry id, invoice id or financial entry id.

Minimum array length: 2

partner_id · string · required

Id of the thirdparty (customer, supplier or employee) in the accounting system . All entries are must be linked to one same partner.

Response

200

application/json

Successful Response

matching_number · string · required

Unique 'number' of the matching operation in the accounting system.

balance · number · required

Balance of the matching operation. This is the sum of all entries in the matching operation. It should be zero if the matching is complete.