ResponseLedgerEntryDto

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    "itemText": "string",
 21    "entryType": "D",
 22    "amount": 0,
 23    "unroundedAmount": 0,
 24    "deltaAdjustment": 0,
 25    "generalLedger": {
 26      "id": 0,
 27      "displayId": "string",
 28      "generalLedgerAccountName": "string",
 29      "generalLedgerAccountCode": "string",
 30      "openItemManagement": true,
 31      "accountCategory": "BALANCESHEET",
 32      "shortName": "string",
 33      "longName": "string"
 34    },
 35    "costCenter": {
 36      "id": 0,
 37      "displayId": "string",
 38      "mainCostCenter": true,
 39      "allocationPercentage": 0.1
 40    },
 41    "profitCenter": {
 42      "id": 0,
 43      "displayId": "string"
 44    },
 45    "vendor": {
 46      "id": 0,
 47      "displayId": "string",
 48      "name": "string"
 49    },
 50    "taxEntries": [
 51      {
 52        "id": 0,
 53        "displayId": "string",
 54        "itemText": "string",
 55        "entryType": "D",
 56        "amount": 0,
 57        "unroundedAmount": 0,
 58        "deltaAdjustment": 0,
 59        "generalLedger": {
 60          "id": 0,
 61          "displayId": "string",
 62          "generalLedgerAccountName": "string",
 63          "generalLedgerAccountCode": "string",
 64          "openItemManagement": true,
 65          "accountCategory": "BALANCESHEET",
 66          "shortName": "string",
 67          "longName": "string"
 68        },
 69        "taxBaseAmount": 0,
 70        "totalTaxDocumentAmount": 0,
 71        "taxExempt": 0,
 72        "taxAffected": 0,
 73        "vendor": {
 74          "id": 0,
 75          "displayId": "string",
 76          "status": "CREATED",
 77          "name": "string",
 78          "erpSystemDisplayId": "string"
 79        },
 80        "ledgerEntryId": 0,
 81        "additionalCurrencies": [
 82          {
 83            "id": 0,
 84            "displayId": "string",
 85            "entryType": "D",
 86            "amount": 0,
 87            "unroundedAmount": 0,
 88            "deltaAdjustment": 0,
 89            "currency": {
 90              "id": 0,
 91              "displayId": "string"
 92            },
 93            "currencyDefinitionType": "CONTRACT_CURRENCY",
 94            "currencyType": "string",
 95            "rate": 0,
 96            "conversionDate": "2019-08-24",
 97            "translationDateType": "DOCUMENT_DATE",
 98            "sourceCurrencyType": "CONTRACT_CURRENCY",
 99            "sourceCurrency": {
100              "id": 0,
101              "displayId": "string"
102            },
103            "depreciationArea": {
104              "id": 0,
105              "displayId": "string"
106            },
107            "ledgerEntryId": 0,
108            "ledgerEntryTaxId": 0,
109            "allowsSystemGenerateNewId": true,
110            "numberRangeIdentifierValue": "string",
111            "numberRangeIdentifierType": {
112              "name": "string"
113            },
114            "numberRangeType": {
115              "name": "string"
116            }
117          }
118        ],
119        "allowsSystemGenerateNewId": true,
120        "numberRangeIdentifierValue": "string",
121        "numberRangeIdentifierType": {
122          "name": "string"
123        },
124        "numberRangeType": {
125          "name": "string"
126        }
127      }
128    ],
129    "additionalCurrencies": [
130      {
131        "id": 0,
132        "displayId": "string",
133        "entryType": "D",
134        "amount": 0,
135        "unroundedAmount": 0,
136        "deltaAdjustment": 0,
137        "currency": {
138          "id": 0,
139          "displayId": "string"
140        },
141        "currencyDefinitionType": "CONTRACT_CURRENCY",
142        "currencyType": "string",
143        "rate": 0,
144        "conversionDate": "2019-08-24",
145        "translationDateType": "DOCUMENT_DATE",
146        "sourceCurrencyType": "CONTRACT_CURRENCY",
147        "sourceCurrency": {
148          "id": 0,
149          "displayId": "string"
150        },
151        "depreciationArea": {
152          "id": 0,
153          "displayId": "string"
154        },
155        "ledgerEntryId": 0,
156        "ledgerEntryTaxId": 0,
157        "allowsSystemGenerateNewId": true,
158        "numberRangeIdentifierValue": "string",
159        "numberRangeIdentifierType": {
160          "name": "string"
161        },
162        "numberRangeType": {
163          "name": "string"
164        }
165      }
166    ],
167    "ledgerTransactionId": 0,
168    "expenseCategory": {
169      "id": 0,
170      "displayId": "string",
171      "status": "CREATED",
172      "name": "string",
173      "expenseCategoryType": "PAYMENT"
174    },
175    "allowsSystemGenerateNewId": true,
176    "numberRangeIdentifierValue": "string",
177    "numberRangeIdentifierType": {
178      "name": "string"
179    },
180    "numberRangeType": {
181      "name": "string"
182    }
183  }
184}

📄 Description: Data transfer object representing a record of transactions within the response ledger, capturing essential details for auditing and financial reconciliation purposes.

Properties

Name

Type

Required

Restrictions

Description

code

string

false

none

Code identifier for the resource

message

string

false

write-only

Contains the text of the message associated with the ledger entry, providing context or details relevant to the transaction.

defaultMessage

string

false

write-only

Default message to be displayed in the ledger entry, providing context or additional information relevant to the transaction.

debugMessage

string

false

write-only

Provides detailed information about any errors or issues encountered during the processing of the ledger entry, facilitating troubleshooting and resolution.

errors

Errors

false

none

Collection of error messages related to the processing of the ledger entry, providing insights for troubleshooting and ensuring data integrity.

object

LedgerEntryDto

false

none

Represents a detailed entry in the response ledger, encapsulating essential transaction data for auditing and reporting purposes.

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