Invoice¶
Main sales tax document.
API Name: Invoice
Fields¶
| Field | Type | Description |
|---|---|---|
name |
varchar | Invoice number (readOnly) |
referenceIdentifier |
varchar | Reference number (max 30) |
automaticReferenceIdentifier |
multiIncrement | Automatic number (VF{YY}-{number}) |
status |
enum | Invoice status |
account |
link | Customer (required) |
billingAddress |
address | Billing address |
shippingAddress |
address | Shipping address |
billingContact |
link | Billing contact |
shippingContact |
link | Shipping contact |
dateInvoiced |
date | Issue date (default: today) |
dueDate |
date | Due date (default: +7 days) |
datePaid |
date | Payment date |
duzp |
date | Tax point date |
amount |
currency | Amount excl. VAT (calculated) |
amountCurrency |
varchar | Currency (default: CZK) |
grandTotalAmount |
floatCurrency | Total amount (calculated) |
taxAmount |
floatCurrency | VAT (calculated) |
discountAmount |
floatCurrency | Discount (calculated) |
preDiscountedAmount |
floatCurrency | Amount before discount (calculated) |
rounding |
floatCurrency | Rounding (calculated) |
paid |
floatCurrency | Paid (calculated) |
paidAdvances |
floatCurrency | Paid advances (calculated) |
remainingToPay |
floatCurrency | Remaining to pay (calculated) |
numberOfOverdueDays |
int | Days overdue (calculated) |
isOverdue |
bool | Overdue (calculated) |
isDueSoon |
bool | Due soon (calculated) |
dueSoonDays |
int | Alert days (default: 5) |
paymentMethod |
enum | Payment method |
constantSymbol |
varchar | Constant symbol (max 10) |
variableSymbol |
varchar | Variable symbol (max 10) |
specificSymbol |
varchar | Specific symbol (max 10) |
vatId |
vatId | Customer VAT ID |
vatIdSk |
vatId | VAT ID (SK) |
sicCode |
varchar | Company ID (max 20) |
reverseCharge |
bool | Reverse charge |
foreignInvoicing |
bool | Foreign invoicing |
discount |
percentage | Total discount |
shippingCost |
floatCurrency | Shipping |
wrappingCost |
floatCurrency | Wrapping |
taxRate |
percentage | Base VAT rate |
taxClass |
link | Tax class |
roundTo |
enum | Round to |
totalAmountRounding |
enum | Rounding type |
supplyCode |
enum | Supply code |
weight |
float | Weight (calculated) |
textBeforeItems |
text | Text before items |
textAfterItems |
text | Text after items |
description |
text | Description |
note |
text | Note |
currencyRates |
jsonObject | Currency rates |
assignedUser |
link | Assigned user (required) |
Enum Values¶
status:
| Value | Description | Color |
|---|---|---|
Draft |
Draft | - |
Issued |
Issued | primary |
In Review |
In Review | warning |
Sent |
Sent | info |
Confirmed |
Confirmed | info |
Partially Paid |
Partially Paid | warning |
Paid |
Paid | success |
Overpaid |
Overpaid | success |
Canceled |
Canceled | danger |
paymentMethod:
| Value | Description |
|---|---|
|
Unspecified |
BankTransfer |
Bank Transfer |
Card |
Card |
Cash |
Cash |
CashOnDelivery |
Cash on Delivery |
collection |
Direct Debit |
roundTo:
| Value | Description |
|---|---|
roundToCrowns |
To crowns |
roundTo50H |
To 50 hellers |
roundTo10H |
To 10 hellers |
totalAmountRounding:
| Value | Description |
|---|---|
noRounding |
No rounding |
mathematicalRounding |
Mathematical |
roundUp |
Round up |
roundDown |
Round down |
Relationships¶
| Relationship | Type | Target Entity | Description |
|---|---|---|---|
account |
belongsTo | Account | Customer |
items |
hasMany | InvoiceItem | Items |
quote |
belongsTo | Quote | Quote |
salesOrder |
belongsTo | SalesOrder | Sales Order |
proformaInvoices |
hasMany | ProformaInvoice | Proformas |
creditNotes |
hasMany | CreditNote | Credit Notes |
payments |
hasChildren | Payment | Payments |
advanceDeductions |
hasMany | AdvanceDeductionItem | Advance deductions |
discounts |
hasChildren | Discount | Discounts |
summaryVatRates |
hasMany | SummaryVatRates | VAT summary |
taxClass |
belongsTo | TaxClass | Tax class |
businessUnit |
belongsTo | BusinessUnit | Business unit |