ResponseListScheduledPaymentDto

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      "clearingLedgerTransactionId": 0,
 22      "clearingLedgerEntryId": 0,
 23      "roundedAmount": 0,
 24      "unroundedAmount": 0,
 25      "deltaAdjustment": 0,
 26      "availableNetAmount": 0,
 27      "availableTaxAmount": 0,
 28      "fiscalYear": 0,
 29      "fiscalPeriod": 0,
 30      "currency": {
 31        "id": 0,
 32        "displayId": "string",
 33        "status": "CREATED",
 34        "name": "string",
 35        "decimalPoints": 0
 36      },
 37      "company": {
 38        "id": 0,
 39        "displayId": "string",
 40        "status": "CREATED",
 41        "erpSystemId": 0,
 42        "erpSystemDisplayId": "string",
 43        "countryId": 0,
 44        "countryDisplayId": "string",
 45        "name": "string",
 46        "postingPeriodVariantId": 0,
 47        "fiscalVariantId": 0
 48      },
 49      "vendor": {
 50        "id": 0,
 51        "displayId": "string",
 52        "status": "CREATED",
 53        "name": "string",
 54        "erpSystemDisplayId": "string"
 55      },
 56      "expenseCategory": {
 57        "id": 0,
 58        "displayId": "string",
 59        "status": "CREATED",
 60        "name": "string",
 61        "expenseCategoryType": "PAYMENT"
 62      },
 63      "paymentMethod": {
 64        "id": 0,
 65        "displayId": "string",
 66        "status": "CREATED",
 67        "name": "string",
 68        "type": "string"
 69      },
 70      "tag": "string",
 71      "contract": {
 72        "id": 0,
 73        "displayId": "string"
 74      },
 75      "postingDate": "2019-08-24",
 76      "taxes": [
 77        {
 78          "id": 0,
 79          "displayId": "string",
 80          "baseAmount": 0,
 81          "roundedAmount": 0,
 82          "unroundedAmount": 0,
 83          "deltaAdjustment": 0,
 84          "totalTaxDocumentAmount": 0,
 85          "taxExempt": 0,
 86          "taxAffected": 0,
 87          "taxRate": 0.1,
 88          "taxCode": {
 89            "id": 0,
 90            "displayId": "string"
 91          },
 92          "taxJurisdiction": {
 93            "id": 0,
 94            "displayId": "string"
 95          },
 96          "accountingKey": "string",
 97          "conditionKey": "string",
 98          "taxAccount": "string",
 99          "scheduledPaymentId": 0,
100          "allowsSystemGenerateNewId": true,
101          "numberRangeIdentifierValue": "string",
102          "numberRangeIdentifierType": {
103            "name": "string"
104          },
105          "numberRangeType": {
106            "name": "string"
107          }
108        }
109      ],
110      "allowsSystemGenerateNewId": true,
111      "numberRangeIdentifierValue": "string",
112      "numberRangeIdentifierType": {
113        "name": "string"
114      },
115      "numberRangeType": {
116        "name": "string"
117      }
118    }
119  ]
120}

📄 Description: Data transfer object representing a list of scheduled payments, including relevant details and statuses, to facilitate efficient financial management and reporting.

Properties

Name

Type

Required

Restrictions

Description

code

string

false

none

Code identifier for the resource

message

string

false

write-only

Contains the detailed message associated with the scheduled payment, providing essential information for transaction clarity.

defaultMessage

string

false

write-only

Default message to be displayed for scheduled payments, providing users with essential information regarding payment processing.

debugMessage

string

false

write-only

Provides detailed information about any errors or issues encountered during the processing of scheduled payments.

errors

Errors

false

none

List of errors encountered during the processing of scheduled payments, providing insights for troubleshooting and resolution.

object

[ScheduledPaymentDto]

false

none

An array of scheduled payment objects, providing detailed information about each scheduled payment within the response.

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