ScheduledPaymentDto

Example Json Object

  1{
  2  "id": 0,
  3  "displayId": "string",
  4  "clearingLedgerTransactionId": 0,
  5  "clearingLedgerEntryId": 0,
  6  "roundedAmount": 0,
  7  "unroundedAmount": 0,
  8  "deltaAdjustment": 0,
  9  "availableNetAmount": 0,
 10  "availableTaxAmount": 0,
 11  "fiscalYear": 0,
 12  "fiscalPeriod": 0,
 13  "currency": {
 14    "id": 0,
 15    "displayId": "string",
 16    "status": "CREATED",
 17    "name": "string",
 18    "decimalPoints": 0
 19  },
 20  "company": {
 21    "id": 0,
 22    "displayId": "string",
 23    "status": "CREATED",
 24    "erpSystemId": 0,
 25    "erpSystemDisplayId": "string",
 26    "countryId": 0,
 27    "countryDisplayId": "string",
 28    "name": "string",
 29    "postingPeriodVariantId": 0,
 30    "fiscalVariantId": 0
 31  },
 32  "vendor": {
 33    "id": 0,
 34    "displayId": "string",
 35    "status": "CREATED",
 36    "name": "string",
 37    "erpSystemDisplayId": "string"
 38  },
 39  "expenseCategory": {
 40    "id": 0,
 41    "displayId": "string",
 42    "status": "CREATED",
 43    "name": "string",
 44    "expenseCategoryType": "PAYMENT"
 45  },
 46  "paymentMethod": {
 47    "id": 0,
 48    "displayId": "string",
 49    "status": "CREATED",
 50    "name": "string",
 51    "type": "string"
 52  },
 53  "tag": "string",
 54  "contract": {
 55    "id": 0,
 56    "displayId": "string"
 57  },
 58  "postingDate": "2019-08-24",
 59  "taxes": [
 60    {
 61      "id": 0,
 62      "displayId": "string",
 63      "baseAmount": 0,
 64      "roundedAmount": 0,
 65      "unroundedAmount": 0,
 66      "deltaAdjustment": 0,
 67      "totalTaxDocumentAmount": 0,
 68      "taxExempt": 0,
 69      "taxAffected": 0,
 70      "taxRate": 0.1,
 71      "taxCode": {
 72        "id": 0,
 73        "displayId": "string"
 74      },
 75      "taxJurisdiction": {
 76        "id": 0,
 77        "displayId": "string"
 78      },
 79      "accountingKey": "string",
 80      "conditionKey": "string",
 81      "taxAccount": "string",
 82      "scheduledPaymentId": 0,
 83      "allowsSystemGenerateNewId": true,
 84      "numberRangeIdentifierValue": "string",
 85      "numberRangeIdentifierType": {
 86        "name": "string"
 87      },
 88      "numberRangeType": {
 89        "name": "string"
 90      }
 91    }
 92  ],
 93  "allowsSystemGenerateNewId": true,
 94  "numberRangeIdentifierValue": "string",
 95  "numberRangeIdentifierType": {
 96    "name": "string"
 97  },
 98  "numberRangeType": {
 99    "name": "string"
100  }
101}

📄 Description: Data transfer object representing a scheduled payment, including details such as payment amount, due date, and associated account information, facilitating efficient financial management and transaction processing.

Properties

Name

Type

Required

Restrictions

Description

id

integer(int64)

false

none

Unique identifier for the resource

displayId

string

false

none

Unique identifier for the display

clearingLedgerTransactionId

integer(int64)

true

none

Unique identifier for the clearing ledger transaction

clearingLedgerEntryId

integer(int64)

true

none

Unique identifier for the clearing ledger entry

roundedAmount

number

true

none

Amount of rounded

unroundedAmount

number

true

none

Amount of unrounded

deltaAdjustment

number

true

none

Represents the numerical adjustment applied to the scheduled payment, allowing for precise financial management and forecasting.

availableNetAmount

number

true

none

Amount of available net

availableTaxAmount

number

true

none

Amount of available tax

fiscalYear

integer(int32)

true

none

Represents the fiscal year associated with the scheduled payment, enabling accurate financial planning and reporting.

fiscalPeriod

integer(int32)

true

none

Represents the fiscal period associated with the scheduled payment, facilitating accurate financial reporting and planning.

currency

CurrencyLite

false

none

Specifies the currency in which the scheduled payment is denominated, ensuring accurate financial transactions.

company

CompanyLite

false

none

Represents the name of the company associated with the scheduled payment, providing essential context for financial transactions.

vendor

PartnerLite

false

none

Identifier for the vendor associated with the scheduled payment, facilitating accurate tracking and management of financial transactions.

expenseCategory

ExpenseCategoryLite

false

none

Category of the expense

paymentMethod

PaymentMethodLite

false

none

Specifies the method of payment to be used for processing the scheduled payment transaction.

tag

string

false

none

Label used to categorize or identify the scheduled payment for organizational tracking and reporting purposes.

contract

BaseId

false

none

Represents the contractual agreement associated with the scheduled payment, ensuring compliance with financial obligations.

postingDate

string(date)

false

none

Date of the posting

taxes

[ScheduledPaymentTaxDto]

false

none

An array of tax details associated with the scheduled payment, providing necessary financial information for compliance and reporting purposes.

allowsSystemGenerateNewId

boolean

false

none

Unique identifier for the allows system generate new

numberRangeIdentifierValue

string

false

none

Represents the specific value of the number range identifier associated with the scheduled payment, ensuring accurate tracking and management of payment records.

numberRangeIdentifierType

INumberRangeIdentifierType

false

none

Type of the number range identifier

numberRangeType

INumberRangeType

false

none

Type of the number range