ResponseInvoicePaymentDto

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

📄 Description: Data transfer object representing the details of an invoice payment, including payment status and associated metadata, facilitating efficient financial transactions and reporting within the enterprise.

Properties

Name

Type

Required

Restrictions

Description

code

string

false

none

Code identifier for the resource

message

string

false

write-only

Textual representation of the payment confirmation message associated with the invoice transaction.

defaultMessage

string

false

write-only

Default message to be displayed for invoice payment notifications, ensuring consistent communication with clients.

debugMessage

string

false

write-only

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

errors

Errors

false

none

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

object

InvoicePaymentDto

false

none

Represents the details of the invoice payment response, encapsulating essential payment information for processing and reconciliation.

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