InvoiceDto

Example Json Object

  1{
  2  "id": 0,
  3  "displayId": "string",
  4  "name": "string",
  5  "invoiceType": "VENDOR_INV",
  6  "state": "INV_DRAFT",
  7  "externalDocumentNumber": "string",
  8  "purchaseOrderReference": "string",
  9  "invoiceDate": "2019-08-24",
 10  "dueDate": "2019-08-24",
 11  "notes": "string",
 12  "billingPeriodFromDate": "2019-08-24",
 13  "billingPeriodToDate": "2019-08-24",
 14  "currency": {
 15    "id": 0,
 16    "displayId": "string",
 17    "status": "CREATED",
 18    "name": "string",
 19    "decimalPoints": 0
 20  },
 21  "vendor": {
 22    "id": 0,
 23    "displayId": "string",
 24    "status": "CREATED",
 25    "name": "string",
 26    "erpSystemDisplayId": "string"
 27  },
 28  "company": {
 29    "id": 0,
 30    "displayId": "string",
 31    "status": "CREATED",
 32    "erpSystemId": 0,
 33    "erpSystemDisplayId": "string",
 34    "countryId": 0,
 35    "countryDisplayId": "string",
 36    "name": "string",
 37    "postingPeriodVariantId": 0,
 38    "fiscalVariantId": 0
 39  },
 40  "netAmount": 0,
 41  "taxAmount": 0,
 42  "totalAmount": 0,
 43  "netAmountBalance": 0,
 44  "taxAmountBalance": 0,
 45  "paymentTerm": {
 46    "id": 0,
 47    "displayId": "string",
 48    "status": "CREATED",
 49    "name": "string"
 50  },
 51  "paymentMethod": {
 52    "id": 0,
 53    "displayId": "string",
 54    "status": "CREATED",
 55    "name": "string",
 56    "type": "string"
 57  },
 58  "paymentBlock": {
 59    "id": 0,
 60    "displayId": "string",
 61    "status": "CREATED",
 62    "name": "string"
 63  },
 64  "defaultCostCenter": {
 65    "id": 0,
 66    "displayId": "string",
 67    "status": "CREATED",
 68    "name": "string",
 69    "erpSystemId": 0
 70  },
 71  "defaultProfitCenter": {
 72    "id": 0,
 73    "displayId": "string",
 74    "status": "CREATED",
 75    "name": "string",
 76    "validTo": "2019-08-24",
 77    "erpSystemId": 0,
 78    "erpSystemDisplayId": "string"
 79  },
 80  "invoiceLineItems": [
 81    {
 82      "id": 0,
 83      "displayId": "string",
 84      "expenseCategory": {
 85        "id": 0,
 86        "displayId": "string",
 87        "status": "CREATED",
 88        "name": "string",
 89        "expenseCategoryType": "PAYMENT"
 90      },
 91      "description": "string",
 92      "unitOfMeasure": {
 93        "id": 0,
 94        "displayId": "string",
 95        "status": "CREATED",
 96        "name": "string",
 97        "erpSystemId": 0
 98      },
 99      "quantity": 0,
100      "unitPrice": 0,
101      "taxJurisdiction": {
102        "id": 0,
103        "displayId": "string",
104        "status": "CREATED",
105        "name": "string",
106        "erpSystemId": 0,
107        "schema": "string",
108        "countryDisplayId": "string"
109      },
110      "taxCode": {
111        "id": 0,
112        "displayId": "string",
113        "status": "CREATED",
114        "name": "string",
115        "erpSystemId": 0
116      },
117      "taxExpenseAccount": {
118        "id": 0,
119        "displayId": "string",
120        "generalLedgerAccountName": "string",
121        "generalLedgerAccountCode": "string",
122        "openItemManagement": true,
123        "accountCategory": "BALANCESHEET",
124        "shortName": "string",
125        "longName": "string"
126      },
127      "taxLineItems": [
128        {
129          "id": 0,
130          "taxRate": 0.1,
131          "taxAmount": 0,
132          "taxType": "string",
133          "invoiceLineItemId": 0
134        }
135      ],
136      "workBreakdownStructure": {
137        "id": 0,
138        "displayId": "string",
139        "status": "CREATED",
140        "name": "string",
141        "erpSystemId": 0
142      },
143      "costCenter": {
144        "id": 0,
145        "displayId": "string",
146        "status": "CREATED",
147        "name": "string",
148        "erpSystemId": 0
149      },
150      "profitCenter": {
151        "id": 0,
152        "displayId": "string",
153        "status": "CREATED",
154        "name": "string",
155        "validTo": "2019-08-24",
156        "erpSystemId": 0,
157        "erpSystemDisplayId": "string"
158      },
159      "functionalArea": {
160        "id": 0,
161        "displayId": "string",
162        "status": "CREATED",
163        "name": "string",
164        "erpSystemId": 0
165      },
166      "businessArea": {
167        "id": 0,
168        "displayId": "string",
169        "status": "CREATED",
170        "name": "string",
171        "erpSystemId": 0
172      },
173      "segment": {
174        "id": 0,
175        "displayId": "string",
176        "status": "CREATED",
177        "name": "string",
178        "erpSystemId": 0
179      },
180      "network": {
181        "id": 0,
182        "displayId": "string",
183        "status": "CREATED",
184        "name": "string",
185        "erpSystemId": 0
186      },
187      "internalOrderType": {
188        "id": 0,
189        "displayId": "string",
190        "status": "CREATED",
191        "name": "string",
192        "erpSystemId": 0
193      },
194      "internalOrder": {
195        "id": 0,
196        "displayId": "string",
197        "status": "CREATED",
198        "name": "string",
199        "erpSystemId": 0,
200        "internalOrderTypeId": 0
201      },
202      "additionalCurrencies": [
203        {
204          "id": 0,
205          "amount": 0,
206          "currency": {
207            "id": 0,
208            "displayId": "string",
209            "status": "CREATED",
210            "name": "string",
211            "decimalPoints": 0
212          },
213          "conversionRate": 0,
214          "conversionDate": "2019-08-24",
215          "translationDateType": "DOCUMENT_DATE",
216          "amountType": "NET_AMOUNT",
217          "currencyDefinitionType": "CONTRACT_CURRENCY",
218          "invoiceEntryId": 0,
219          "invoiceEntryDisplayId": "string"
220        }
221      ],
222      "scheduledPaymentMatches": [
223        {
224          "id": 0,
225          "fromId": 0,
226          "toId": 0,
227          "amount": 0
228        }
229      ],
230      "goodsReceiptLineItemLinks": [
231        {
232          "id": 0,
233          "fromId": 0,
234          "toId": 0,
235          "linkedQuantity": 0
236        }
237      ],
238      "invoiceId": 0,
239      "invoiceDisplayId": "string",
240      "invoiceState": "INV_DRAFT",
241      "vendorPaymentId": 0,
242      "purchaseOrderLineItemId": 0,
243      "netAmount": 0,
244      "allowsSystemGenerateNewId": true,
245      "numberRangeIdentifierValue": "string",
246      "numberRangeIdentifierType": {
247        "name": "string"
248      },
249      "numberRangeType": {
250        "name": "string"
251      }
252    }
253  ],
254  "workspaceId": 0,
255  "workspaceDisplayId": "string",
256  "workspaceName": "string",
257  "workspaceState": "INV_DRAFT",
258  "remainingNetAmount": 0,
259  "remainingTaxAmount": 0,
260  "remainingTotalAmount": 0,
261  "pendingPaymentCount": 0,
262  "allPaymentsPosted": true,
263  "approvalInfo": {
264    "approverUsername": "string",
265    "approvedAt": "2019-08-24T14:15:22Z"
266  },
267  "rejectionReason": "string",
268  "allowsSystemGenerateNewId": true,
269  "numberRangeIdentifierValue": "string",
270  "numberRangeIdentifierType": {
271    "name": "string"
272  },
273  "numberRangeType": {
274    "name": "string"
275  }
276}

📄 Description: Data transfer object representing an invoice, encapsulating essential details such as billing information, line items, and payment status to facilitate efficient financial transactions and reporting.

Properties

Name

Type

Required

Restrictions

Description

id

integer(int64)

false

none

Unique identifier for the resource

displayId

string

false

none

Unique identifier for the display

name

string

false

none

Name of the resource

invoiceType

string

false

none

Type of the invoice

state

string

false

none

Represents the current status of the invoice, indicating its progression through the billing process.

externalDocumentNumber

string

false

none

Unique identifier for the external document associated with the invoice, facilitating seamless tracking and reconciliation of financial records.

purchaseOrderReference

string

false

none

Reference number associated with the purchase order, used for tracking and managing invoice transactions.

invoiceDate

string(date)

false

none

Date of the invoice

dueDate

string(date)

false

none

Due date of the resource

notes

string

false

none

Additional comments or observations related to the invoice, providing context for billing and payment processes.

billingPeriodFromDate

string(date)

false

none

Date of the billing period from

billingPeriodToDate

string(date)

false

none

Date of the billing period to

currency

CurrencyLite

false

none

Specifies the currency in which the invoice is denominated, ensuring accurate financial transactions and reporting.

vendor

PartnerLite

false

none

Identifies the vendor associated with the invoice, facilitating accurate tracking and management of supplier transactions.

company

CompanyLite

false

none

Represents the name of the company associated with the invoice, providing essential context for billing and financial tracking.

netAmount

number

false

none

Amount of net

taxAmount

number

false

none

Amount of tax

totalAmount

number

false

none

Amount of total

netAmountBalance

number

false

none

Represents the total outstanding balance of the invoice after adjustments, providing a clear view of the amount due for payment.

taxAmountBalance

number

false

none

Represents the outstanding tax amount balance associated with the invoice, providing essential financial information for accurate accounting and compliance.

paymentTerm

PaymentTermLite

false

none

Specifies the duration and conditions for payment associated with the invoice, facilitating clear financial terms between the parties involved.

paymentMethod

PaymentMethodLite

false

none

Specifies the method of payment used for the invoice, facilitating accurate processing and reconciliation of financial transactions.

paymentBlock

PaymentBlockLite

false

none

Indicates whether the invoice is subject to payment restrictions, ensuring compliance with financial policies.

defaultCostCenter

CostCenterLite

false

none

Specifies the default cost center associated with the invoice, ensuring accurate allocation of expenses for financial reporting.

defaultProfitCenter

ProfitCenterLite

false

none

Identifies the default profit center associated with the invoice, facilitating accurate financial reporting and analysis.

invoiceLineItems

[InvoiceLineItemDto]

false

none

An array of detailed line items associated with the invoice, providing a breakdown of products or services billed to the customer.

workspaceId

integer(int64)

false

none

Unique identifier for the workspace

workspaceDisplayId

string

false

none

Unique identifier for the workspace display

workspaceName

string

false

none

Name of the workspace

workspaceState

string

false

none

Indicates the current operational status of the workspace associated with the invoice, reflecting its readiness for processing.

remainingNetAmount

number

false

none

Amount of remaining net

remainingTaxAmount

number

false

none

Amount of remaining tax

remainingTotalAmount

number

false

none

Amount of remaining total

pendingPaymentCount

integer(int64)

false

none

Count of pending payment

allPaymentsPosted

boolean

false

none

Indicates whether all payments associated with the invoice have been successfully posted to the accounting system.

approvalInfo

ApprovalInfo

false

none

Contains details regarding the approval status and history of the invoice, facilitating effective tracking and management of financial transactions.

rejectionReason

string

false

none

Specifies the reason for the rejection of an invoice, providing clarity for audit and resolution processes.

allowsSystemGenerateNewId

boolean

false

none

Unique identifier for the allows system generate new

numberRangeIdentifierValue

string

false

none

Represents the unique value associated with the number range identifier for invoices within the system.

numberRangeIdentifierType

INumberRangeIdentifierType

false

none

Type of the number range identifier

numberRangeType

INumberRangeType

false

none

Type of the number range

Enumerated Values

Attribute

Value

invoiceType

CREDIT_MEMO, MANUAL_INV, VENDOR_INV

state

GOODS_RECEIPT_DRAFT, GOODS_RECEIPT_MATCHED, GOODS_RECEIPT_RECEIVED, GOODS_RECEIPT_REJECTED, INVOICE_PAYMENT_DRAFT, INVOICE_PAYMENT_JOURNALS_GENERATING, INVOICE_PAYMENT_POSTED, INVOICE_PAYMENT_POSTING, INVOICE_PAYMENT_REVIEW, INV_APPROVED, INV_DRAFT, INV_GENERATING_JOURNALS, INV_PAID, INV_POSTED, INV_POSTING, INV_REJECTED, INV_REVIEW, INV_WAITING_FOR_APPROVAL, PURCHASE_ORDER_APPROVED, PURCHASE_ORDER_DRAFT, PURCHASE_ORDER_REJECTED, PURCHASE_ORDER_WAITING_FOR_APPROVAL, PURCHASE_REQUISITION_APPROVED, PURCHASE_REQUISITION_DRAFT, PURCHASE_REQUISITION_REJECTED, PURCHASE_REQUISITION_WAITING_FOR_APPROVAL, VENDOR_REQUEST_APPROVED, VENDOR_REQUEST_DRAFT, VENDOR_REQUEST_PENDING_APPROVAL, VENDOR_REQUEST_REJECTED, WORKSPACE_CLOSED, WORKSPACE_JOURNALS_GENERATING, WORKSPACE_OPEN, WORKSPACE_POSTING, WORKSPACE_REVIEW

workspaceState

GOODS_RECEIPT_DRAFT, GOODS_RECEIPT_MATCHED, GOODS_RECEIPT_RECEIVED, GOODS_RECEIPT_REJECTED, INVOICE_PAYMENT_DRAFT, INVOICE_PAYMENT_JOURNALS_GENERATING, INVOICE_PAYMENT_POSTED, INVOICE_PAYMENT_POSTING, INVOICE_PAYMENT_REVIEW, INV_APPROVED, INV_DRAFT, INV_GENERATING_JOURNALS, INV_PAID, INV_POSTED, INV_POSTING, INV_REJECTED, INV_REVIEW, INV_WAITING_FOR_APPROVAL, PURCHASE_ORDER_APPROVED, PURCHASE_ORDER_DRAFT, PURCHASE_ORDER_REJECTED, PURCHASE_ORDER_WAITING_FOR_APPROVAL, PURCHASE_REQUISITION_APPROVED, PURCHASE_REQUISITION_DRAFT, PURCHASE_REQUISITION_REJECTED, PURCHASE_REQUISITION_WAITING_FOR_APPROVAL, VENDOR_REQUEST_APPROVED, VENDOR_REQUEST_DRAFT, VENDOR_REQUEST_PENDING_APPROVAL, VENDOR_REQUEST_REJECTED, WORKSPACE_CLOSED, WORKSPACE_JOURNALS_GENERATING, WORKSPACE_OPEN, WORKSPACE_POSTING, WORKSPACE_REVIEW