Accounting · Payables & Receivables
AR Credit / Debit Memos
A posted invoice is never edited. A credit memo reduces what is owed, a debit memo increases it, and both net against the invoice they correct.
/api/accounting/ar-memosPublished as /api/v1/ar-memosDownload specification (OpenAPI 3.1) Screen: AR Credit / Debit Memos
Overview
| Package | Accounting |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The caller's roles must hold Accounting › AR Credit / Debit Memos on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen. |
| Table | acct.ar_memos · kept per company (and organisational unit where it has one) |
| Record | Read only; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
8 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/accounting/ar-memosList ar credit / debit memos
Query parameters
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"col":"status","op":"eq","value":"open"} |
<field>=<value> | Shorthand for "field is value" |
Response 200
{
"rows": [
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"invoice_no": "INV-000001",
"customer_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"source_module": "text",
"source_ref": "text",
"invoice_date": "2026-10-30",
"due_date": "2026-10-30",
"currency": "USD",
"subtotal": "1250.00",
"tax": "1250.00",
"total": "1250.00",
"amount_paid": "1250.00",
"status": "draft"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/accounting/ar-memos?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/accounting/ar-memos/{id}Read one ar memos
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"invoice_no": "INV-000001",
"customer_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"source_module": "text",
"source_ref": "text",
"invoice_date": "2026-10-30",
"due_date": "2026-10-30",
"currency": "USD",
"subtotal": "1250.00",
"tax": "1250.00",
"total": "1250.00",
"amount_paid": "1250.00",
"status": "draft"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/accounting/ar-memos/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/ar-memosPost ar credit / debit memos
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/accounting/ar-memos" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/ar-memos/{id}/copyCopy
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
overrides, preview, withLinesResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/accounting/ar-memos/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'PUT/api/accounting/ar-memos/{id}Put ar credit / debit memos
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X PUT "https://demo.tranxact.ai/api/accounting/ar-memos/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/accounting/ar-memos/{id}Delete ar credit / debit memos
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/accounting/ar-memos/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/ar-memos/createCreate
Request body
The keys this action reads (* = required; "one of" lists the only values):
documentType, relatedInvoiceId, partyId, invoiceDate, reason, currency, exchangeRate, linesResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/accounting/ar-memos/create" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"documentType":"value","relatedInvoiceId":"value","partyId":"value","invoiceDate":"value","reason":"value","currency":"value"}'POST/api/accounting/ar-memos/{id}/postPost
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/accounting/ar-memos/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/post" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a ar memos, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
invoice_no | text | read only | Invoice no |
customer_account_id | uuid | read only | Customer account id |
patient_id | uuid | read only | Patient id |
source_module | text | read only | Source module |
source_ref | text | read only | Source ref |
invoice_date | date | read only | Invoice date |
due_date | date | read only | Due date |
currency | text | read only | Currency |
subtotal | numeric | read only | Subtotal |
tax | numeric | read only | Tax |
total | numeric | read only | Total |
amount_paid | numeric | read only | Amount paid |
status | text | read only | Status |
journal_id | uuid | read only | Journal id |
created_at | timestamp with time zone | read only | Created at |
org_unit_id | uuid | read only | Org unit id |
cost_center_id | uuid | read only | Cost center id |
profit_center_id | uuid | read only | Profit center id |
document_type | text | read only | Document type |
related_invoice_id | uuid | read only | Related invoice id |
memo_reason | text | read only | Memo reason |
cancelled_at | timestamp with time zone | read only | Cancelled at |
cancelled_by | uuid | read only | Cancelled by |
cancel_reason | text | read only | Cancel reason |
reversed_by_id | uuid | read only | Reversed by id |
reverses_id | uuid | read only | Reverses id |
customer_name | text | read only | Customer name |
related_invoice_no | text | read only | Related invoice no |
cost_center_code | text | read only | Cost center code |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold Accounting › AR Credit / Debit Memos for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused by the same validation as the screen; the error names the field and why |
Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.