ResponseListInvoicePaymentDto

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      "invoiceId": 0,
22      "invoiceDisplayId": "string",
23      "invoiceName": "string",
24      "ledgerTransactionId": 0,
25      "ledgerWorkspaceId": 0,
26      "state": "INV_DRAFT",
27      "documentDate": "2019-08-24",
28      "postingDate": "2019-08-24",
29      "paymentLines": [
30        {
31          "id": 0,
32          "displayId": "string",
33          "invoicePaymentId": 0,
34          "invoicePaymentDisplayId": "string",
35          "invoiceLineItemId": 0,
36          "invoiceLineItemDisplayId": "string",
37          "invoiceLineItemDescription": "string",
38          "expenseCategoryDisplayId": "string",
39          "expenseCategoryName": "string",
40          "netAmount": 0,
41          "taxAmount": 0,
42          "allocatedNetAmountUsed": 0,
43          "allocatedTaxAmountUsed": 0,
44          "unfundedNetAmount": 0,
45          "unfundedTaxAmount": 0,
46          "totalAmount": 0,
47          "allowsSystemGenerateNewId": true,
48          "numberRangeIdentifierValue": "string",
49          "numberRangeIdentifierType": {
50            "name": "string"
51          },
52          "numberRangeType": {
53            "name": "string"
54          }
55        }
56      ],
57      "generatedInWorkspace": true,
58      "totalAllocatedNetAmount": 0,
59      "totalAmount": 0,
60      "totalNetAmount": 0,
61      "totalTaxAmount": 0,
62      "totalUnfundedNetAmount": 0,
63      "allowsSystemGenerateNewId": true,
64      "numberRangeIdentifierValue": "string",
65      "numberRangeIdentifierType": {
66        "name": "string"
67      },
68      "numberRangeType": {
69        "name": "string"
70      }
71    }
72  ]
73}

📄 Description: Data transfer object representing a list of invoice payments, including relevant details and statuses, to facilitate financial reconciliation and reporting within the invoicing process.

Properties

Name

Type

Required

Restrictions

Description

code

string

false

none

Code identifier for the resource

message

string

false

write-only

Contains the detailed message related to the invoice payment response, providing essential information for transaction clarity.

defaultMessage

string

false

write-only

Default message displayed for invoice payment notifications, providing users with essential information regarding payment status.

debugMessage

string

false

write-only

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

errors

Errors

false

none

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

object

[InvoicePaymentDto]

false

none

An array of invoice payment details, encapsulated in the ResponseListInvoicePaymentDto schema, providing essential information for financial reconciliation 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