Proforma Invoice¶
Advance invoice.
API Name: ProformaInvoice
Fields¶
| Field | Type | Description |
|---|---|---|
name |
varchar | Proforma number (readOnly) |
automaticReferenceIdentifier |
multiIncrement | Automatic number (VZ{YY}-{number}) |
status |
enum | Proforma status |
account |
link | Customer (required) |
dateInvoiced |
date | Issue date |
dueDate |
date | Due date |
amount |
currency | Amount (calculated) |
grandTotalAmount |
floatCurrency | Total amount (calculated) |
paid |
floatCurrency | Paid (calculated) |
remainingToPay |
floatCurrency | Remaining to pay (calculated) |
invoice |
link | Final invoice |
assignedUser |
link | Assigned user |
Enum Values¶
status:
| Value | Description | Color |
|---|---|---|
Issued |
Issued | primary |
Sent |
Sent | info |
Partially Paid |
Partially Paid | warning |
Paid |
Paid | success |
Canceled |
Canceled | danger |
Due |
Overdue | danger |
Overpaid |
Overpaid | success |
Relationships¶
| Relationship | Type | Target Entity | Description |
|---|---|---|---|
account |
belongsTo | Account | Customer |
items |
hasMany | ProformaInvoiceItem | Items |
invoice |
belongsTo | Invoice | Final invoice |
payments |
hasChildren | Payment | Payments |
issuedTaxDocuments |
hasMany | IssuedTaxDocument | Tax documents |