ResponseListInvoiceDto

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

📄 Description: Data transfer object representing a collection of invoice responses, including relevant details and statuses, facilitating streamlined invoice management and reconciliation processes.

Properties

Name

Type

Required

Restrictions

Description

code

string

false

none

Code identifier for the resource

message

string

false

write-only

Contains the detailed message or notification related to the invoice, providing essential context for the transaction.

defaultMessage

string

false

write-only

Default message to be displayed in the invoice response, providing a standardized communication reference for users.

debugMessage

string

false

write-only

Provides detailed information about any errors or issues encountered during the processing of the invoice response.

errors

Errors

false

none

Collection of error messages encountered during the processing of invoice requests, providing insights for troubleshooting and resolution.

object

[InvoiceDto]

false

none

An array containing a list of invoice response objects, facilitating the retrieval of multiple invoice details in a single API call.

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