InvoiceDTO¶
Example Json Object
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "displayId": "string",
6 "invoiceDate": "2019-08-24",
7 "invoiceName": "string",
8 "tax": 0,
9 "invoiceStatusId": 0,
10 "invoiceStatusName": "string",
11 "invoiceStatusType": "string",
12 "invoiceItemIds": [
13 0
14 ],
15 "documentIds": [
16 0
17 ],
18 "workOrderId": 0,
19 "workOrderDisplayId": "string",
20 "totalAmount": 0,
21 "vendorName": "string",
22 "premiseId": 0,
23 "premiseDisplayId": "string",
24 "vendorDisplayId": "string"
25}
📄 Description: Data transfer object representing an invoice, encapsulating essential details such as amounts, dates, and customer information to facilitate efficient billing and financial tracking.
Properties
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
id |
integer(int64) |
false |
none |
Unique identifier for the resource |
createdBy |
string |
false |
none |
Username of who created this resource |
createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
displayId |
string |
false |
none |
Unique identifier for the display |
invoiceDate |
string(date) |
false |
none |
Date of the invoice |
invoiceName |
string |
false |
none |
Name of the invoice |
tax |
number |
true |
none |
Represents the total tax amount applicable to the invoice, ensuring accurate financial reporting and compliance. |
invoiceStatusId |
integer(int64) |
false |
none |
Unique identifier for the invoice status |
invoiceStatusName |
string |
false |
none |
Name of the invoice status |
invoiceStatusType |
string |
false |
none |
Type of the invoice status |
invoiceItemIds |
[integer] |
false |
none |
Array of unique identifiers for individual invoice items associated with the invoice, facilitating precise tracking and management of billing details. |
documentIds |
[integer] |
false |
none |
Array of unique identifiers for the invoices associated with the transaction, enabling efficient tracking and management of financial documents. |
workOrderId |
integer(int64) |
false |
none |
Unique identifier for the work order |
workOrderDisplayId |
string |
false |
none |
Unique identifier for the work order display |
totalAmount |
number |
false |
none |
Amount of total |
vendorName |
string |
false |
none |
Name of the vendor |
premiseId |
integer(int64) |
false |
none |
Unique identifier for the premise |
premiseDisplayId |
string |
false |
none |
Unique identifier for the premise display |
vendorDisplayId |
string |
false |
none |
Unique identifier for the vendor display |