Credit note
Credit notes issued against invoices.
Part of Financials in the register catalog.
- Register ID
credit_noteUse this name to ask for the register. The API calls it a shelf ID.- Each record is
- An eventSomething that happened at a point in time.
- Status
- PlannedDefined ahead of the connector that will fill it.
- Data
- OrganisationPrivate to each organisation's own workspace.
- Version
- v1Current version.
Connectors
Connected today
Demiton keeps this register current from these systems now.
No system fills this register yet.
On the roadmap
Systems in the planned connector rollout that can fill this register. Partial means the system holds only some of its fields.
None planned yet.
Fields
20 fields: 8 required, 12 optional.
Required
Every record carries these fields.
- external_idText
The source system's own credit note id.
Example:
BC-CN-100542- source_systemText
Which bound system emitted the row.
Example:
D365_BUSINESS_CENTRAL- directionText
Whether this is a receivable credit or a payable credit.
Example:
payable- counterpartyText
The customer or supplier the credit is with.
Example:
Sunshine Coast Quarries Pty Ltd- issued_onDate
The credit note's date.
Example:
2026-06-18- statusText
Draft, authorised, paid or voided.
Example:
authorised- totalMoney amount
The credit note total including tax.
Example:
8250- currencyText
The currency the credit note is in.
Example:
AUD
Optional
Present when the source system records them.
- numberText
The credit note number.
Example:
CN-100542- referenceText
The counterparty's reference.
Example:
Returned aggregate - PO 44120- due_onDate
When the credit falls due.
- subtotalMoney amount
The total before tax.
Example:
7500- total_taxMoney amount
The tax on the credit note.
Example:
750- currency_rateDecimal number
The exchange rate applied.
- remaining_creditMoney amount
Credit not yet allocated.
Example:
8250- applied_amountMoney amount
Credit already applied.
- fully_paid_onDate
When the credit was fully used.
- line_itemsList
The credit note's lines.
- allocationsList
Which invoices the credit was applied to.
- legal_entityText
The legal entity that holds the credit note.
Example:
Bridgeworks Group Pty Ltd
Example record
A sample from Bridgeworks Group, Demiton's demonstration company. The values are illustrative; the shape is exactly what the contract describes.
{ "counterparty": "Sunshine Coast Quarries Pty Ltd", "currency": "AUD", "direction": "payable", "external_id": "BC-CN-100542", "issued_on": "2026-06-18", "legal_entity": "Bridgeworks Group Pty Ltd", "number": "CN-100542", "reference": "Returned aggregate - PO 44120", "remaining_credit": 8250, "source_system": "D365_BUSINESS_CENTRAL", "status": "authorised", "subtotal": 7500, "total": 8250, "total_tax": 750}Use this contract
The contract is a standard JSON Schema (draft 2020-12) document, so any JSON Schema validator can check a record against it. Keywords starting with x-demiton- add Demiton's own meaning, such as units and requiredness, and validators ignore them.
https://docs.demiton.io/registers/credit_note/v1.jsonShow the full JSON Schema
Loading the schema…
Talk to the team
Tell us what you run - your ERP, field, payroll and document systems - and we will show you the registers Demiton would keep current from them, on your data, in a 30-minute call.