Credit Note¶
Refund document.
API Name: CreditNote
Fields¶
| Field | Type | Description |
|---|---|---|
name |
varchar | Credit note number (readOnly) |
automaticReferenceIdentifier |
multiIncrement | Automatic number (OD{YY}-{number}) |
status |
enum | Credit note status |
account |
link | Customer |
reasonOfRefund |
varchar | Refund reason (required, max 50) |
dateInvoiced |
date | Issue date |
dueDate |
date | Due date |
amount |
currency | Amount (calculated) |
grandTotalAmount |
floatCurrency | Total amount (calculated) |
invoices |
linkMultiple | Linked invoices |
warehouse |
link | Warehouse (optional) |
assignedUser |
link | Assigned user |
Enum Values¶
status:
| Value | Description | Color |
|---|---|---|
Issued |
Issued | primary |
Sent |
Sent | info |
Paid |
Paid | success |
Canceled |
Canceled | danger |
Due |
Overdue | danger |
Relationships¶
| Relationship | Type | Target Entity | Description |
|---|---|---|---|
account |
belongsTo | Account | Customer |
items |
hasMany | CreditNoteItem | Items |
invoices |
hasMany | Invoice | Linked invoices |