ResponseInvoiceDto

Example Json Object

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

📄 Description: Data transfer object representing an invoice response, encapsulating essential details such as invoice number, amount, and payment status, facilitating seamless communication between invoicing systems and financial management processes.

Properties

Name

Type

Required

Restrictions

Description

code

string

false

none

Code identifier for the resource

message

string

false

write-only

Textual representation of the invoice message, providing additional context or notes relevant to the invoice for business clarity.

defaultMessage

string

false

write-only

Default message to be displayed on the invoice, providing essential information or instructions to the recipient.

debugMessage

string

false

write-only

Provides detailed information about any errors or issues encountered during the processing of the invoice, aiding in troubleshooting and resolution.

errors

Errors

false

none

Contains a list of error messages related to the invoice processing, providing insights for troubleshooting and resolution.

object

InvoiceDto

false

none

Represents the detailed invoice information returned in response to an invoice request, facilitating accurate financial tracking and reporting.

Enumerated Values

Attribute

Value

code

API_CALL_FAILED, ATTACHED, BAD_REQUEST, DATA_VALIDATION_ERROR, DELETED, DETACHED, INTERNAL_SYSTEM_ERROR, NULL_RESPONSE, OK, OK_BUT_RESPONSE_INVALID, REQUEST_VALIDATION_ERROR, SERVICE_VALIDATION_ERROR, UPDATED