Ledger Entry

Get A Resource By ID

HTTP Request

GET /api/v1/ledger-entry/{id}

📋 Description: Returns the single resource with the given ID.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Resource ID

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseLedgerEntryDto

409

Conflict

Payment amount exceeds remaining invoice balance

InvoicePaymentBalanceConflictDto

502

Bad Gateway

Downstream service call failed

PayableErrorDto

Example Responses

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

Update A Resource

HTTP Request

PUT /api/v1/ledger-entry/{id}

📋 Description: Fully replaces the resource with the given ID. All fields in the request body are applied.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Resource ID

body

body

LedgerEntryDto

true

Request body containing the updated ledger entry data, including financial details and associated metadata for the specified entry ID.

Body Parameters

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

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseLedgerEntryDto

409

Conflict

Payment amount exceeds remaining invoice balance

InvoicePaymentBalanceConflictDto

502

Bad Gateway

Downstream service call failed

PayableErrorDto

Example Responses

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

Delete A Single Resource

HTTP Request

DELETE /api/v1/ledger-entry/{id}

📋 Description: Permanently deletes the resource with the given ID.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseVoid

409

Conflict

Payment amount exceeds remaining invoice balance

InvoicePaymentBalanceConflictDto

502

Bad Gateway

Downstream service call failed

PayableErrorDto

Example Responses

 1{
 2  "code": "UPDATED",
 3  "errors": {
 4    "all": [
 5      {
 6        "type": "GENERIC",
 7        "source": {},
 8        "errorMessage": "string",
 9        "field": "string",
10        "errorKey": "string"
11      }
12    ]
13  },
14  "object": {}
15}

Partially Update A Resource (Json Patch)

HTTP Request

PATCH /api/v1/ledger-entry/{id}

📋 Description: Applies a JSON Patch (RFC 6902) document to the resource with the given ID. Only the fields specified in the patch are modified; all other fields remain unchanged.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

JsonPatch

true

Request body containing the updated ledger entry details, including financial data and relevant metadata for the specified entry.

Body Parameters

1{}

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseLedgerEntryDto

409

Conflict

Payment amount exceeds remaining invoice balance

InvoicePaymentBalanceConflictDto

502

Bad Gateway

Downstream service call failed

PayableErrorDto

Example Responses

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

Bulk Create-Or-Update Resources

HTTP Request

PUT /api/v1/ledger-entry/createOrUpdate/bulk

📋 Description: Creates or updates multiple resources in a single request. Partial success: each item is processed independently. Items that pass validation are persisted; failed items are recorded in the response errors list. The response body always contains the successfully processed items alongside any per-item errors.

Parameters

Name

In

Type

Required

Description

body

body

LedgerEntryDto

true

Request body containing an array of ledger entry records for bulk creation or update, including essential financial details and associated metadata.

Body Parameters

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

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListLedgerEntryDto

409

Conflict

Payment amount exceeds remaining invoice balance

InvoicePaymentBalanceConflictDto

502

Bad Gateway

Downstream service call failed

PayableErrorDto

Example Responses

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

Create Or Update A Resource

HTTP Request

PUT /api/v1/ledger-entry/createOrUpdate

📋 Description: Creates the resource if no matching record exists, or fully updates it if one is found. Idempotent: safe to call multiple times with the same payload.

Parameters

Name

In

Type

Required

Description

body

body

LedgerEntryDto

true

Request body containing the ledger entry details, including transaction data, account identifiers, and timestamps for creating or updating financial records.

Body Parameters

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

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseLedgerEntryDto

409

Conflict

Payment amount exceeds remaining invoice balance

InvoicePaymentBalanceConflictDto

502

Bad Gateway

Downstream service call failed

PayableErrorDto

Example Responses

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

Bulk-Update Resources

HTTP Request

PUT /api/v1/ledger-entry/bulk

📋 Description: Updates multiple resources in a single request. Partial success: each item is processed independently. Items that pass validation are updated; failed items are recorded in the response errors list. The response body always contains the successfully updated items alongside any per-item errors.

Parameters

Name

In

Type

Required

Description

body

body

LedgerEntryDto

true

Request body containing an array of ledger entry records, each including transaction details and associated metadata for bulk processing.

Body Parameters

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

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListLedgerEntryDto

409

Conflict

Payment amount exceeds remaining invoice balance

InvoicePaymentBalanceConflictDto

502

Bad Gateway

Downstream service call failed

PayableErrorDto

Example Responses

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

Bulk-Create Resources

HTTP Request

POST /api/v1/ledger-entry/bulk

📋 Description: Creates multiple resources in a single request. Partial success: each item is processed independently. Items that pass validation are persisted; failed items are recorded in the response errors list. The response body always contains the successfully created items alongside any per-item errors.

Parameters

Name

In

Type

Required

Description

body

body

LedgerEntryDto

true

Request body containing an array of ledger entry records, each including transaction details and associated metadata for bulk processing.

Body Parameters

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

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListLedgerEntryDto

409

Conflict

Payment amount exceeds remaining invoice balance

InvoicePaymentBalanceConflictDto

502

Bad Gateway

Downstream service call failed

PayableErrorDto

Example Responses

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

Bulk-Delete Resources

HTTP Request

DELETE /api/v1/ledger-entry/bulk

📋 Description: Deletes multiple resources by ID in a single request. Partial success: each deletion is attempted independently. If one or more deletions fail (e.g. due to state constraints), the successfully deleted items are NOT rolled back. A ValidationException containing per-item errors is thrown after all items have been attempted, so the caller must inspect the error list to determine which IDs were not deleted.

Parameters

Name

In

Type

Required

Description

body

body

array[integer]

true

Request body containing an array of ledger entry identifiers to be deleted in bulk, ensuring efficient management of financial records.

Body Parameters

1[
2  0
3]

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseVoid

409

Conflict

Payment amount exceeds remaining invoice balance

InvoicePaymentBalanceConflictDto

502

Bad Gateway

Downstream service call failed

PayableErrorDto

Example Responses

 1{
 2  "code": "UPDATED",
 3  "errors": {
 4    "all": [
 5      {
 6        "type": "GENERIC",
 7        "source": {},
 8        "errorMessage": "string",
 9        "field": "string",
10        "errorKey": "string"
11      }
12    ]
13  },
14  "object": {}
15}

Search Resources

HTTP Request

POST /api/v1/ledger-entry/search

📋 Description: Returns a paginated list of resources matching the given filter criteria. Pass null or an empty body to return all accessible records.

Parameters

Name

In

Type

Required

Description

page

query

integer

false

Zero-based page index (0..N)

size

query

integer

false

The size of the page to be returned

sort

query

array[string]

false

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

body

body

LedgerEntryDtoFilter

false

Request body containing search criteria and filters for retrieving specific ledger entries based on user-defined parameters.

Default Values

Parameter

Default

Type

page

0

query

size

100

query

sort

["createdAt,ASC"]

query

Parameter Constraints

Parameter

Constraints

page

Min: 0

size

Min: 1

Body Parameters

 1{
 2  "idIn": [
 3    0
 4  ],
 5  "idEqual": 0,
 6  "idLike": "string",
 7  "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
 8  "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
 9  "createdByLike": "string",
10  "createdByEqual": "string",
11  "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
12  "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
13  "modifiedByLike": "string",
14  "modifiedByEqual": "string",
15  "displayIdIn": [
16    "string"
17  ],
18  "displayIdLike": "string",
19  "ledgerTransactionIdEqual": 0,
20  "ledgerTransactionIdIn": [
21    0
22  ],
23  "expenseCategoryIdIn": [
24    0
25  ],
26  "expenseCategoryDisplayIdIn": [
27    "string"
28  ],
29  "itemTextLike": "string",
30  "entryTypeEqual": "D"
31}

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageLedgerEntryDto

409

Conflict

Payment amount exceeds remaining invoice balance

InvoicePaymentBalanceConflictDto

502

Bad Gateway

Downstream service call failed

PayableErrorDto

Example Responses

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

List All Resources

HTTP Request

GET /api/v1/ledger-entry

📋 Description: Returns a paginated list of all accessible resources ordered by ID. Prefer POST /search for filtered queries.

Parameters

Name

In

Type

Required

Description

pageable

query

Pageable

true

Indicates whether the results of the ledger entry retrieval should be paginated, allowing for efficient data management and improved user experience.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageLedgerEntryDto

409

Conflict

Payment amount exceeds remaining invoice balance

InvoicePaymentBalanceConflictDto

502

Bad Gateway

Downstream service call failed

PayableErrorDto

Example Responses

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

Create A Resource

HTTP Request

POST /api/v1/ledger-entry

📋 Description: Creates a single resource. Returns the created resource with its generated ID.

Parameters

Name

In

Type

Required

Description

body

body

LedgerEntryDto

true

Request body containing the ledger entry details, including transaction amount, date, description, and associated account identifiers for accurate financial record-keeping.

Body Parameters

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

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseLedgerEntryDto

409

Conflict

Payment amount exceeds remaining invoice balance

InvoicePaymentBalanceConflictDto

502

Bad Gateway

Downstream service call failed

PayableErrorDto

Example Responses

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