TRANXACT.AI Help

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.

Type REST8 operationsBase path /api/accounting/ar-memosPublished as /api/v1/ar-memos

Download specification (OpenAPI 3.1) Screen: AR Credit / Debit Memos

Overview

PackageAccounting
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe 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.
Tableacct.ar_memos · kept per company (and organisational unit where it has one)
RecordRead only; key id
RulesThe 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

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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, withLines

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/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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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, lines

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/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

NameTypeDescription
idstring (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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
invoice_notextread onlyInvoice no
customer_account_iduuidread onlyCustomer account id
patient_iduuidread onlyPatient id
source_moduletextread onlySource module
source_reftextread onlySource ref
invoice_datedateread onlyInvoice date
due_datedateread onlyDue date
currencytextread onlyCurrency
subtotalnumericread onlySubtotal
taxnumericread onlyTax
totalnumericread onlyTotal
amount_paidnumericread onlyAmount paid
statustextread onlyStatus
journal_iduuidread onlyJournal id
created_attimestamp with time zoneread onlyCreated at
org_unit_iduuidread onlyOrg unit id
cost_center_iduuidread onlyCost center id
profit_center_iduuidread onlyProfit center id
document_typetextread onlyDocument type
related_invoice_iduuidread onlyRelated invoice id
memo_reasontextread onlyMemo reason
cancelled_attimestamp with time zoneread onlyCancelled at
cancelled_byuuidread onlyCancelled by
cancel_reasontextread onlyCancel reason
reversed_by_iduuidread onlyReversed by id
reverses_iduuidread onlyReverses id
customer_nametextread onlyCustomer name
related_invoice_notextread onlyRelated invoice no
cost_center_codetextread onlyCost center code

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold Accounting › AR Credit / Debit Memos for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused 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.