Sintropix Allocations API: Match and Settle Ledger Lines

An Allocation settles one debit line against one credit line on an Open-Item Account. The match endpoint lets you auto-allocate a selection of lines. This page covers the full CRUD for Allocations plus the match operation. All amounts are integers in the minor unit of the currency (for example, cents).

Entities with Books. An Allocation, and every pair inside a match, must stay within a single Book (or between two common lines). Crossing Books is refused with RECONCILIATION_ALLOCATION_LINES_IN_DIFFERENT_BOOKS_ERROR for a single Allocation or RECONCILIATION_MATCH_LINES_IN_DIFFERENT_BOOKS_ERROR for a match.

Open in the app. This resource has a page in the Sintropix web app at https://app.sintropix.com/{entityId}/entries/{entryId}, where each id in braces is the same UUID as in the API route or response. Allocations have no page of their own: link the Ledger Entry being settled, or /{entityId}/open-items for the full list. When you mention a record to a user, include that link. See Link to the App for the full URL grammar.

GET /api/entities/:entityId/ledger/allocations

List the Allocations of a set of Ledger Entry Lines. Returns every Allocation where either the debit or credit side is one of the lines in scope. Name the lines directly with lineIds, or pass entryId to read the Allocations of every line of one Ledger Entry in a single request.

Path param: entityId (UUID)
Query params: pass exactly one of the two below. Passing both, or neither, returns 400.

Param	Type	Required	Description
`lineIds`	UUID[]	One of	1 to 100 line ids. Repeat the parameter for each id (`?lineIds=A&lineIds=B`). Duplicate ids are read once.
`entryId`	UUID	One of	A live Ledger Entry (`active` or `reversed`). Scopes the read to every line of that entry.

Success response: an array of Allocation objects with the fields below
Status: 200

If any id in lineIds is not a line of the Entity, Sintropix returns 404 with LEDGER_ENTRY_LINE_NOT_FOUND_ERROR and the missing lineId in params. If entryId names no live entry of the Entity, Sintropix returns 404 with LEDGER_ENTRY_NOT_FOUND_ERROR.

The single lineId query parameter is no longer accepted. To read the Allocations of one line, pass it as lineIds=$LINE_ID.

Field	Type	Description
`id`	UUID	Allocation id
`entityId`	UUID	Owning Entity
`debitLineId`	UUID	Settled debit line
`creditLineId`	UUID	Settled credit line
`accountId`	UUID	Open-Item Account
`amount`	integer	Settled amount
`createdAt`	ISO datetime	Creation timestamp
`updatedAt`	ISO datetime	Last update timestamp

# Allocations of two lines
curl "https://api.sintropix.com/api/entities/$ENTITY_ID/ledger/allocations?lineIds=$LINE_ID_1&lineIds=$LINE_ID_2" \
  -H "x-api-key: $SINTROPIX_API_KEY"

# Allocations of every line of one entry
curl "https://api.sintropix.com/api/entities/$ENTITY_ID/ledger/allocations?entryId=$ENTRY_ID" \
  -H "x-api-key: $SINTROPIX_API_KEY"

POST /api/entities/:entityId/ledger/allocations

Create a single Allocation between two lines. The caller supplies the idempotency id. The debit line must be on the debit side, the credit line on the credit side, both must belong to the same Open-Item Account, and the amount must not exceed either line’s open amount.

Path param: entityId (UUID)
Body:

Field	Type	Required	Description
`id`	UUID	Yes	Client-supplied idempotency id
`debitLineId`	UUID	Yes	Debit line id
`creditLineId`	UUID	Yes	Credit line id
`amount`	integer	Yes	Positive settlement amount

Success response: the created Allocation object (same fields as the list response)
Status: 201

{
  "id": "33333333-3333-4333-8333-333333333333",
  "entityId": "aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa",
  "debitLineId": "11111111-1111-4111-8111-111111111111",
  "creditLineId": "22222222-2222-4222-8222-222222222222",
  "accountId": "99999999-9999-4999-8999-999999999999",
  "amount": 100,
  "createdAt": "2026-01-15T14:02:11.000Z",
  "updatedAt": "2026-01-15T14:02:11.000Z"
}

curl -X POST https://api.sintropix.com/api/entities/$ENTITY_ID/ledger/allocations \
  -H "Content-Type: application/json" \
  -H "x-api-key: $SINTROPIX_API_KEY" \
  -H "x-audit-actor: my-agent" \
  -d '{
    "id": "33333333-3333-4333-8333-333333333333",
    "debitLineId": "11111111-1111-4111-8111-111111111111",
    "creditLineId": "22222222-2222-4222-8222-222222222222",
    "amount": 100
  }'

POST /api/entities/:entityId/ledger/allocations/bulk

Create up to 100 Allocations in a single request and transaction. Each element has the body of the single create, including its own client-supplied id. The whole batch runs against the same Open-Item Account constraints as the single-create endpoint.

Path param: entityId (UUID)
Body: { allocations: [...] }, 1 to 100 elements, each with the fields of the single create
Success response: an array of the created Allocation objects (same fields as the list response), in input order
Status: 201

curl -X POST https://api.sintropix.com/api/entities/$ENTITY_ID/ledger/allocations/bulk \
  -H "Content-Type: application/json" \
  -H "x-api-key: $SINTROPIX_API_KEY" \
  -H "x-audit-actor: my-agent" \
  -d '{
    "allocations": [
      {
        "id": "33333333-3333-4333-8333-333333333333",
        "debitLineId": "11111111-1111-4111-8111-111111111111",
        "creditLineId": "22222222-2222-4222-8222-222222222222",
        "amount": 100
      }
    ]
  }'

Bulk endpoints run as one database transaction. If any element fails validation or a domain rule, the whole batch is rejected and the response identifies the offending element by its zero-based elementIndex.

DELETE /api/entities/:entityId/ledger/allocations/:allocationId

Delete an Allocation. This restores the open amounts of the two lines it settled.

Path params: entityId (UUID), allocationId (UUID)
Success response: the deleted Allocation object (same fields as the list response)
Status: 200

curl -X DELETE https://api.sintropix.com/api/entities/$ENTITY_ID/ledger/allocations/$ALLOCATION_ID \
  -H "x-api-key: $SINTROPIX_API_KEY" \
  -H "x-audit-actor: my-agent"

POST /api/entities/:entityId/ledger/allocations/match

Auto-match a selection of Open-Item lines. The selection is split by side, greedily decomposed into debit/credit pairs, and every resulting Allocation is created in one transaction. The selection must contain at least two lines, at least one debit and one credit, and all lines must belong to the same Open-Item Account.

Path param: entityId (UUID)
Body:

Field	Type	Required	Description
`lineIds`	UUID[]	Yes	At least 2 line ids to match

Success response: the Allocations written and every line they changed
Status: 201

Field	Type	Description
`allocations`	array	Allocation objects created by the match (same fields as the list response)
`settledLines`	array	Every line the match changed, each with the fields below
`openTotal`	integer	Open amount of the whole account after the match

Each item in settledLines:

Field	Type	Description
`id`	UUID	Line id
`entryId`	UUID	Parent entry
`accountId`	UUID	Open-Item Account
`entityId`	UUID	Owning Entity
`functionalAmount`	integer	Nonnegative magnitude
`side`	enum	`debit` or `credit`
`partnerId`	UUID or null	Counterparty partner
`partnerName`	string or null	Name of the partner
`partnerWebsite`	string or null	Website of the partner, as a bare domain (`acme.cl`); `null` when it has none
`transactionCurrency`	string or null	Foreign currency code, if any
`transactionAmount`	integer or null	Amount in the foreign currency
`transactionFxRate`	decimal string or null	Rate used for conversion
`openAmount`	integer or null	Amount still unsettled after the match
`entryDate`	ISO date	Date of the parent entry
`entryMemo`	string or null	Memo of the parent entry
`settlementStatus`	enum	`open`, `partial`, or `settled`
`invoiceId`	UUID or null	The Invoice whose Control Line this line is; `null` for any other line
`invoiceDocumentNumber`	string or null	Document number of that Invoice
`createdAt`	ISO datetime	Creation timestamp
`updatedAt`	ISO datetime	Last update timestamp

curl -X POST https://api.sintropix.com/api/entities/$ENTITY_ID/ledger/allocations/match \
  -H "Content-Type: application/json" \
  -H "x-api-key: $SINTROPIX_API_KEY" \
  -H "x-audit-actor: my-agent" \
  -d '{
    "lineIds": [
      "11111111-1111-4111-8111-111111111111",
      "22222222-2222-4222-8222-222222222222",
      "33333333-3333-4333-8333-333333333333"
    ]
  }'

Domain error codes

Code	Meaning
`RECONCILIATION_ALLOCATION_NOT_FOUND_ERROR`	Allocation does not exist
`RECONCILIATION_ALLOCATION_NETS_REVERSAL_ERROR`	Allocation would net a reversal entry
`RECONCILIATION_ALLOCATION_ID_CONFLICT_ERROR`	Allocation id already used
`RECONCILIATION_ALLOCATION_DEBIT_AND_CREDIT_LINE_IDS_CANNOT_BE_THE_SAME_ERROR`	Debit and credit lines must differ
`RECONCILIATION_ALLOCATION_DEBIT_LINE_NOT_FOUND_ERROR`	Debit line not found
`RECONCILIATION_ALLOCATION_CREDIT_LINE_NOT_FOUND_ERROR`	Credit line not found
`RECONCILIATION_ALLOCATION_DEBIT_LINE_MUST_BE_DEBIT_ERROR`	Debit line is not on the debit side
`RECONCILIATION_ALLOCATION_CREDIT_LINE_MUST_BE_CREDIT_ERROR`	Credit line is not on the credit side
`RECONCILIATION_ALLOCATION_LINES_ON_DIFFERENT_ACCOUNTS_ERROR`	Lines belong to different accounts
`RECONCILIATION_ALLOCATION_ACCOUNT_MUST_BE_OPEN_ITEM_ERROR`	Account is not an Open-Item Account
`RECONCILIATION_ALLOCATION_ON_SUSPENSE_ACCOUNT_ERROR`	Lines on the Suspense Account cannot be allocated
`RECONCILIATION_ALLOCATION_AMOUNT_EXCEEDS_OPEN_AMOUNT_ERROR`	Amount exceeds one of the line’s open amounts
`RECONCILIATION_MATCH_LINE_NOT_FOUND_ERROR`	One or more line ids not found
`RECONCILIATION_MATCH_LINES_ON_DIFFERENT_ACCOUNTS_ERROR`	Selection spans multiple accounts
`RECONCILIATION_MATCH_NOTHING_TO_MATCH_ERROR`	Selection contains no debit/credit pair
`RECONCILIATION_ALLOCATION_LINES_IN_DIFFERENT_BOOKS_ERROR`	Allocation would settle lines from two different Books
`RECONCILIATION_MATCH_LINES_IN_DIFFERENT_BOOKS_ERROR`	Match would settle a selection spanning two Books
`LEDGER_ENTRY_LINE_NOT_FOUND_ERROR`	A line named in `lineIds` does not exist (list)
`LEDGER_ENTRY_NOT_FOUND_ERROR`	`entryId` names no live entry (list)

Status codes

Status	Meaning
200	Success (GET, DELETE)
201	Created (POST allocation, POST match)
400	Validation error
401	Unauthenticated
403	Forbidden
404	Resource not found
409	Domain rule violation

Get Started

Ledger

Banking

Documents

Reports & Audit

Sources & Integrations

Platform

Sintropix Allocations API: Match and Settle Ledger Lines

GET /api/entities/:entityId/ledger/allocations

POST /api/entities/:entityId/ledger/allocations

POST /api/entities/:entityId/ledger/allocations/bulk

DELETE /api/entities/:entityId/ledger/allocations/:allocationId

POST /api/entities/:entityId/ledger/allocations/match

Domain error codes

Status codes

​GET /api/entities/:entityId/ledger/allocations

​POST /api/entities/:entityId/ledger/allocations

​POST /api/entities/:entityId/ledger/allocations/bulk

​DELETE /api/entities/:entityId/ledger/allocations/:allocationId

​POST /api/entities/:entityId/ledger/allocations/match

​Domain error codes

​Status codes

GET /api/entities/:entityId/ledger/allocations

POST /api/entities/:entityId/ledger/allocations

POST /api/entities/:entityId/ledger/allocations/bulk

DELETE /api/entities/:entityId/ledger/allocations/:allocationId

POST /api/entities/:entityId/ledger/allocations/match

Domain error codes

Status codes