ResponseScheduledPaymentDto

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

📄 Description: Data transfer object representing the details of a scheduled payment, including relevant transaction information and status, facilitating efficient payment processing and financial management.

Properties

Name

Type

Required

Restrictions

Description

code

string

false

none

Code identifier for the resource

message

string

false

write-only

Contains the informational message related to the scheduled payment response, providing context or details pertinent to the transaction.

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 regarding any errors or issues encountered during the processing of scheduled payment requests.

errors

Errors

false

none

Collection of error messages related to the scheduled payment process, providing insights for troubleshooting and resolution.

object

ScheduledPaymentDto

false

none

Represents the scheduled payment details within the response, facilitating effective financial management and transaction tracking.

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