Ledger Entry Tax¶
Get A Resource By ID¶
HTTP Request
GET /api/v1/ledger-entry-tax/{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 |
||
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
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 "taxBaseAmount": 0,
33 "totalTaxDocumentAmount": 0,
34 "taxExempt": 0,
35 "taxAffected": 0,
36 "vendor": {
37 "id": 0,
38 "displayId": "string",
39 "status": "CREATED",
40 "name": "string",
41 "erpSystemDisplayId": "string"
42 },
43 "ledgerEntryId": 0,
44 "additionalCurrencies": [
45 {
46 "id": 0,
47 "displayId": "string",
48 "entryType": "D",
49 "amount": 0,
50 "unroundedAmount": 0,
51 "deltaAdjustment": 0,
52 "currency": {
53 "id": 0,
54 "displayId": "string"
55 },
56 "currencyDefinitionType": "CONTRACT_CURRENCY",
57 "currencyType": "string",
58 "rate": 0,
59 "conversionDate": "2019-08-24",
60 "translationDateType": "DOCUMENT_DATE",
61 "sourceCurrencyType": "CONTRACT_CURRENCY",
62 "sourceCurrency": {
63 "id": 0,
64 "displayId": "string"
65 },
66 "depreciationArea": {
67 "id": 0,
68 "displayId": "string"
69 },
70 "ledgerEntryId": 0,
71 "ledgerEntryTaxId": 0,
72 "allowsSystemGenerateNewId": true,
73 "numberRangeIdentifierValue": "string",
74 "numberRangeIdentifierType": {
75 "name": "string"
76 },
77 "numberRangeType": {
78 "name": "string"
79 }
80 }
81 ],
82 "allowsSystemGenerateNewId": true,
83 "numberRangeIdentifierValue": "string",
84 "numberRangeIdentifierType": {
85 "name": "string"
86 },
87 "numberRangeType": {
88 "name": "string"
89 }
90 }
91}
Update A Resource¶
HTTP Request
PUT /api/v1/ledger-entry-tax/{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 |
true |
Request body containing the updated tax details for the specified ledger entry, including applicable rates and adjustments. |
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 "taxBaseAmount": 0,
20 "totalTaxDocumentAmount": 0,
21 "taxExempt": 0,
22 "taxAffected": 0,
23 "vendor": {
24 "id": 0,
25 "displayId": "string",
26 "status": "CREATED",
27 "name": "string",
28 "erpSystemDisplayId": "string"
29 },
30 "ledgerEntryId": 0,
31 "additionalCurrencies": [
32 {
33 "id": 0,
34 "displayId": "string",
35 "entryType": "D",
36 "amount": 0,
37 "unroundedAmount": 0,
38 "deltaAdjustment": 0,
39 "currency": {
40 "id": 0,
41 "displayId": "string"
42 },
43 "currencyDefinitionType": "CONTRACT_CURRENCY",
44 "currencyType": "string",
45 "rate": 0,
46 "conversionDate": "2019-08-24",
47 "translationDateType": "DOCUMENT_DATE",
48 "sourceCurrencyType": "CONTRACT_CURRENCY",
49 "sourceCurrency": {
50 "id": 0,
51 "displayId": "string"
52 },
53 "depreciationArea": {
54 "id": 0,
55 "displayId": "string"
56 },
57 "ledgerEntryId": 0,
58 "ledgerEntryTaxId": 0,
59 "allowsSystemGenerateNewId": true,
60 "numberRangeIdentifierValue": "string",
61 "numberRangeIdentifierType": {
62 "name": "string"
63 },
64 "numberRangeType": {
65 "name": "string"
66 }
67 }
68 ],
69 "allowsSystemGenerateNewId": true,
70 "numberRangeIdentifierValue": "string",
71 "numberRangeIdentifierType": {
72 "name": "string"
73 },
74 "numberRangeType": {
75 "name": "string"
76 }
77}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
||
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
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 "taxBaseAmount": 0,
33 "totalTaxDocumentAmount": 0,
34 "taxExempt": 0,
35 "taxAffected": 0,
36 "vendor": {
37 "id": 0,
38 "displayId": "string",
39 "status": "CREATED",
40 "name": "string",
41 "erpSystemDisplayId": "string"
42 },
43 "ledgerEntryId": 0,
44 "additionalCurrencies": [
45 {
46 "id": 0,
47 "displayId": "string",
48 "entryType": "D",
49 "amount": 0,
50 "unroundedAmount": 0,
51 "deltaAdjustment": 0,
52 "currency": {
53 "id": 0,
54 "displayId": "string"
55 },
56 "currencyDefinitionType": "CONTRACT_CURRENCY",
57 "currencyType": "string",
58 "rate": 0,
59 "conversionDate": "2019-08-24",
60 "translationDateType": "DOCUMENT_DATE",
61 "sourceCurrencyType": "CONTRACT_CURRENCY",
62 "sourceCurrency": {
63 "id": 0,
64 "displayId": "string"
65 },
66 "depreciationArea": {
67 "id": 0,
68 "displayId": "string"
69 },
70 "ledgerEntryId": 0,
71 "ledgerEntryTaxId": 0,
72 "allowsSystemGenerateNewId": true,
73 "numberRangeIdentifierValue": "string",
74 "numberRangeIdentifierType": {
75 "name": "string"
76 },
77 "numberRangeType": {
78 "name": "string"
79 }
80 }
81 ],
82 "allowsSystemGenerateNewId": true,
83 "numberRangeIdentifierValue": "string",
84 "numberRangeIdentifierType": {
85 "name": "string"
86 },
87 "numberRangeType": {
88 "name": "string"
89 }
90 }
91}
Delete A Single Resource¶
HTTP Request
DELETE /api/v1/ledger-entry-tax/{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 |
||
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
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-tax/{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 |
true |
Request body containing the updated tax details for a specific ledger entry, including applicable tax rates and adjustments. |
Body Parameters
1{}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
||
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
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 "taxBaseAmount": 0,
33 "totalTaxDocumentAmount": 0,
34 "taxExempt": 0,
35 "taxAffected": 0,
36 "vendor": {
37 "id": 0,
38 "displayId": "string",
39 "status": "CREATED",
40 "name": "string",
41 "erpSystemDisplayId": "string"
42 },
43 "ledgerEntryId": 0,
44 "additionalCurrencies": [
45 {
46 "id": 0,
47 "displayId": "string",
48 "entryType": "D",
49 "amount": 0,
50 "unroundedAmount": 0,
51 "deltaAdjustment": 0,
52 "currency": {
53 "id": 0,
54 "displayId": "string"
55 },
56 "currencyDefinitionType": "CONTRACT_CURRENCY",
57 "currencyType": "string",
58 "rate": 0,
59 "conversionDate": "2019-08-24",
60 "translationDateType": "DOCUMENT_DATE",
61 "sourceCurrencyType": "CONTRACT_CURRENCY",
62 "sourceCurrency": {
63 "id": 0,
64 "displayId": "string"
65 },
66 "depreciationArea": {
67 "id": 0,
68 "displayId": "string"
69 },
70 "ledgerEntryId": 0,
71 "ledgerEntryTaxId": 0,
72 "allowsSystemGenerateNewId": true,
73 "numberRangeIdentifierValue": "string",
74 "numberRangeIdentifierType": {
75 "name": "string"
76 },
77 "numberRangeType": {
78 "name": "string"
79 }
80 }
81 ],
82 "allowsSystemGenerateNewId": true,
83 "numberRangeIdentifierValue": "string",
84 "numberRangeIdentifierType": {
85 "name": "string"
86 },
87 "numberRangeType": {
88 "name": "string"
89 }
90 }
91}
Bulk Create-Or-Update Resources¶
HTTP Request
PUT /api/v1/ledger-entry-tax/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
errorslist. The response body always contains the successfully processed items alongside any per-item errors.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing a collection of ledger entry tax records for bulk creation or updates, including relevant 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 "taxBaseAmount": 0,
21 "totalTaxDocumentAmount": 0,
22 "taxExempt": 0,
23 "taxAffected": 0,
24 "vendor": {
25 "id": 0,
26 "displayId": "string",
27 "status": "CREATED",
28 "name": "string",
29 "erpSystemDisplayId": "string"
30 },
31 "ledgerEntryId": 0,
32 "additionalCurrencies": [
33 {
34 "id": 0,
35 "displayId": "string",
36 "entryType": "D",
37 "amount": 0,
38 "unroundedAmount": 0,
39 "deltaAdjustment": 0,
40 "currency": {
41 "id": 0,
42 "displayId": "string"
43 },
44 "currencyDefinitionType": "CONTRACT_CURRENCY",
45 "currencyType": "string",
46 "rate": 0,
47 "conversionDate": "2019-08-24",
48 "translationDateType": "DOCUMENT_DATE",
49 "sourceCurrencyType": "CONTRACT_CURRENCY",
50 "sourceCurrency": {
51 "id": 0,
52 "displayId": "string"
53 },
54 "depreciationArea": {
55 "id": 0,
56 "displayId": "string"
57 },
58 "ledgerEntryId": 0,
59 "ledgerEntryTaxId": 0,
60 "allowsSystemGenerateNewId": true,
61 "numberRangeIdentifierValue": "string",
62 "numberRangeIdentifierType": {
63 "name": "string"
64 },
65 "numberRangeType": {
66 "name": "string"
67 }
68 }
69 ],
70 "allowsSystemGenerateNewId": true,
71 "numberRangeIdentifierValue": "string",
72 "numberRangeIdentifierType": {
73 "name": "string"
74 },
75 "numberRangeType": {
76 "name": "string"
77 }
78 }
79]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
||
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
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 "taxBaseAmount": 0,
34 "totalTaxDocumentAmount": 0,
35 "taxExempt": 0,
36 "taxAffected": 0,
37 "vendor": {
38 "id": 0,
39 "displayId": "string",
40 "status": "CREATED",
41 "name": "string",
42 "erpSystemDisplayId": "string"
43 },
44 "ledgerEntryId": 0,
45 "additionalCurrencies": [
46 {
47 "id": 0,
48 "displayId": "string",
49 "entryType": "D",
50 "amount": 0,
51 "unroundedAmount": 0,
52 "deltaAdjustment": 0,
53 "currency": {
54 "id": 0,
55 "displayId": "string"
56 },
57 "currencyDefinitionType": "CONTRACT_CURRENCY",
58 "currencyType": "string",
59 "rate": 0,
60 "conversionDate": "2019-08-24",
61 "translationDateType": "DOCUMENT_DATE",
62 "sourceCurrencyType": "CONTRACT_CURRENCY",
63 "sourceCurrency": {
64 "id": 0,
65 "displayId": "string"
66 },
67 "depreciationArea": {
68 "id": 0,
69 "displayId": "string"
70 },
71 "ledgerEntryId": 0,
72 "ledgerEntryTaxId": 0,
73 "allowsSystemGenerateNewId": true,
74 "numberRangeIdentifierValue": "string",
75 "numberRangeIdentifierType": {
76 "name": "string"
77 },
78 "numberRangeType": {
79 "name": "string"
80 }
81 }
82 ],
83 "allowsSystemGenerateNewId": true,
84 "numberRangeIdentifierValue": "string",
85 "numberRangeIdentifierType": {
86 "name": "string"
87 },
88 "numberRangeType": {
89 "name": "string"
90 }
91 }
92 ]
93}
Create Or Update A Resource¶
HTTP Request
PUT /api/v1/ledger-entry-tax/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 |
true |
Request body containing the ledger entry tax data, including relevant identifiers and financial details for either creating or updating tax 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 "taxBaseAmount": 0,
20 "totalTaxDocumentAmount": 0,
21 "taxExempt": 0,
22 "taxAffected": 0,
23 "vendor": {
24 "id": 0,
25 "displayId": "string",
26 "status": "CREATED",
27 "name": "string",
28 "erpSystemDisplayId": "string"
29 },
30 "ledgerEntryId": 0,
31 "additionalCurrencies": [
32 {
33 "id": 0,
34 "displayId": "string",
35 "entryType": "D",
36 "amount": 0,
37 "unroundedAmount": 0,
38 "deltaAdjustment": 0,
39 "currency": {
40 "id": 0,
41 "displayId": "string"
42 },
43 "currencyDefinitionType": "CONTRACT_CURRENCY",
44 "currencyType": "string",
45 "rate": 0,
46 "conversionDate": "2019-08-24",
47 "translationDateType": "DOCUMENT_DATE",
48 "sourceCurrencyType": "CONTRACT_CURRENCY",
49 "sourceCurrency": {
50 "id": 0,
51 "displayId": "string"
52 },
53 "depreciationArea": {
54 "id": 0,
55 "displayId": "string"
56 },
57 "ledgerEntryId": 0,
58 "ledgerEntryTaxId": 0,
59 "allowsSystemGenerateNewId": true,
60 "numberRangeIdentifierValue": "string",
61 "numberRangeIdentifierType": {
62 "name": "string"
63 },
64 "numberRangeType": {
65 "name": "string"
66 }
67 }
68 ],
69 "allowsSystemGenerateNewId": true,
70 "numberRangeIdentifierValue": "string",
71 "numberRangeIdentifierType": {
72 "name": "string"
73 },
74 "numberRangeType": {
75 "name": "string"
76 }
77}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
||
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
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 "taxBaseAmount": 0,
33 "totalTaxDocumentAmount": 0,
34 "taxExempt": 0,
35 "taxAffected": 0,
36 "vendor": {
37 "id": 0,
38 "displayId": "string",
39 "status": "CREATED",
40 "name": "string",
41 "erpSystemDisplayId": "string"
42 },
43 "ledgerEntryId": 0,
44 "additionalCurrencies": [
45 {
46 "id": 0,
47 "displayId": "string",
48 "entryType": "D",
49 "amount": 0,
50 "unroundedAmount": 0,
51 "deltaAdjustment": 0,
52 "currency": {
53 "id": 0,
54 "displayId": "string"
55 },
56 "currencyDefinitionType": "CONTRACT_CURRENCY",
57 "currencyType": "string",
58 "rate": 0,
59 "conversionDate": "2019-08-24",
60 "translationDateType": "DOCUMENT_DATE",
61 "sourceCurrencyType": "CONTRACT_CURRENCY",
62 "sourceCurrency": {
63 "id": 0,
64 "displayId": "string"
65 },
66 "depreciationArea": {
67 "id": 0,
68 "displayId": "string"
69 },
70 "ledgerEntryId": 0,
71 "ledgerEntryTaxId": 0,
72 "allowsSystemGenerateNewId": true,
73 "numberRangeIdentifierValue": "string",
74 "numberRangeIdentifierType": {
75 "name": "string"
76 },
77 "numberRangeType": {
78 "name": "string"
79 }
80 }
81 ],
82 "allowsSystemGenerateNewId": true,
83 "numberRangeIdentifierValue": "string",
84 "numberRangeIdentifierType": {
85 "name": "string"
86 },
87 "numberRangeType": {
88 "name": "string"
89 }
90 }
91}
Bulk-Update Resources¶
HTTP Request
PUT /api/v1/ledger-entry-tax/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
errorslist. The response body always contains the successfully updated items alongside any per-item errors.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing a collection of ledger entry tax records for bulk processing, including relevant tax 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 "taxBaseAmount": 0,
21 "totalTaxDocumentAmount": 0,
22 "taxExempt": 0,
23 "taxAffected": 0,
24 "vendor": {
25 "id": 0,
26 "displayId": "string",
27 "status": "CREATED",
28 "name": "string",
29 "erpSystemDisplayId": "string"
30 },
31 "ledgerEntryId": 0,
32 "additionalCurrencies": [
33 {
34 "id": 0,
35 "displayId": "string",
36 "entryType": "D",
37 "amount": 0,
38 "unroundedAmount": 0,
39 "deltaAdjustment": 0,
40 "currency": {
41 "id": 0,
42 "displayId": "string"
43 },
44 "currencyDefinitionType": "CONTRACT_CURRENCY",
45 "currencyType": "string",
46 "rate": 0,
47 "conversionDate": "2019-08-24",
48 "translationDateType": "DOCUMENT_DATE",
49 "sourceCurrencyType": "CONTRACT_CURRENCY",
50 "sourceCurrency": {
51 "id": 0,
52 "displayId": "string"
53 },
54 "depreciationArea": {
55 "id": 0,
56 "displayId": "string"
57 },
58 "ledgerEntryId": 0,
59 "ledgerEntryTaxId": 0,
60 "allowsSystemGenerateNewId": true,
61 "numberRangeIdentifierValue": "string",
62 "numberRangeIdentifierType": {
63 "name": "string"
64 },
65 "numberRangeType": {
66 "name": "string"
67 }
68 }
69 ],
70 "allowsSystemGenerateNewId": true,
71 "numberRangeIdentifierValue": "string",
72 "numberRangeIdentifierType": {
73 "name": "string"
74 },
75 "numberRangeType": {
76 "name": "string"
77 }
78 }
79]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
||
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
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 "taxBaseAmount": 0,
34 "totalTaxDocumentAmount": 0,
35 "taxExempt": 0,
36 "taxAffected": 0,
37 "vendor": {
38 "id": 0,
39 "displayId": "string",
40 "status": "CREATED",
41 "name": "string",
42 "erpSystemDisplayId": "string"
43 },
44 "ledgerEntryId": 0,
45 "additionalCurrencies": [
46 {
47 "id": 0,
48 "displayId": "string",
49 "entryType": "D",
50 "amount": 0,
51 "unroundedAmount": 0,
52 "deltaAdjustment": 0,
53 "currency": {
54 "id": 0,
55 "displayId": "string"
56 },
57 "currencyDefinitionType": "CONTRACT_CURRENCY",
58 "currencyType": "string",
59 "rate": 0,
60 "conversionDate": "2019-08-24",
61 "translationDateType": "DOCUMENT_DATE",
62 "sourceCurrencyType": "CONTRACT_CURRENCY",
63 "sourceCurrency": {
64 "id": 0,
65 "displayId": "string"
66 },
67 "depreciationArea": {
68 "id": 0,
69 "displayId": "string"
70 },
71 "ledgerEntryId": 0,
72 "ledgerEntryTaxId": 0,
73 "allowsSystemGenerateNewId": true,
74 "numberRangeIdentifierValue": "string",
75 "numberRangeIdentifierType": {
76 "name": "string"
77 },
78 "numberRangeType": {
79 "name": "string"
80 }
81 }
82 ],
83 "allowsSystemGenerateNewId": true,
84 "numberRangeIdentifierValue": "string",
85 "numberRangeIdentifierType": {
86 "name": "string"
87 },
88 "numberRangeType": {
89 "name": "string"
90 }
91 }
92 ]
93}
Bulk-Create Resources¶
HTTP Request
POST /api/v1/ledger-entry-tax/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
errorslist. The response body always contains the successfully created items alongside any per-item errors.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing an array of ledger entry tax records for bulk processing, including relevant 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 "taxBaseAmount": 0,
21 "totalTaxDocumentAmount": 0,
22 "taxExempt": 0,
23 "taxAffected": 0,
24 "vendor": {
25 "id": 0,
26 "displayId": "string",
27 "status": "CREATED",
28 "name": "string",
29 "erpSystemDisplayId": "string"
30 },
31 "ledgerEntryId": 0,
32 "additionalCurrencies": [
33 {
34 "id": 0,
35 "displayId": "string",
36 "entryType": "D",
37 "amount": 0,
38 "unroundedAmount": 0,
39 "deltaAdjustment": 0,
40 "currency": {
41 "id": 0,
42 "displayId": "string"
43 },
44 "currencyDefinitionType": "CONTRACT_CURRENCY",
45 "currencyType": "string",
46 "rate": 0,
47 "conversionDate": "2019-08-24",
48 "translationDateType": "DOCUMENT_DATE",
49 "sourceCurrencyType": "CONTRACT_CURRENCY",
50 "sourceCurrency": {
51 "id": 0,
52 "displayId": "string"
53 },
54 "depreciationArea": {
55 "id": 0,
56 "displayId": "string"
57 },
58 "ledgerEntryId": 0,
59 "ledgerEntryTaxId": 0,
60 "allowsSystemGenerateNewId": true,
61 "numberRangeIdentifierValue": "string",
62 "numberRangeIdentifierType": {
63 "name": "string"
64 },
65 "numberRangeType": {
66 "name": "string"
67 }
68 }
69 ],
70 "allowsSystemGenerateNewId": true,
71 "numberRangeIdentifierValue": "string",
72 "numberRangeIdentifierType": {
73 "name": "string"
74 },
75 "numberRangeType": {
76 "name": "string"
77 }
78 }
79]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
||
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
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 "taxBaseAmount": 0,
34 "totalTaxDocumentAmount": 0,
35 "taxExempt": 0,
36 "taxAffected": 0,
37 "vendor": {
38 "id": 0,
39 "displayId": "string",
40 "status": "CREATED",
41 "name": "string",
42 "erpSystemDisplayId": "string"
43 },
44 "ledgerEntryId": 0,
45 "additionalCurrencies": [
46 {
47 "id": 0,
48 "displayId": "string",
49 "entryType": "D",
50 "amount": 0,
51 "unroundedAmount": 0,
52 "deltaAdjustment": 0,
53 "currency": {
54 "id": 0,
55 "displayId": "string"
56 },
57 "currencyDefinitionType": "CONTRACT_CURRENCY",
58 "currencyType": "string",
59 "rate": 0,
60 "conversionDate": "2019-08-24",
61 "translationDateType": "DOCUMENT_DATE",
62 "sourceCurrencyType": "CONTRACT_CURRENCY",
63 "sourceCurrency": {
64 "id": 0,
65 "displayId": "string"
66 },
67 "depreciationArea": {
68 "id": 0,
69 "displayId": "string"
70 },
71 "ledgerEntryId": 0,
72 "ledgerEntryTaxId": 0,
73 "allowsSystemGenerateNewId": true,
74 "numberRangeIdentifierValue": "string",
75 "numberRangeIdentifierType": {
76 "name": "string"
77 },
78 "numberRangeType": {
79 "name": "string"
80 }
81 }
82 ],
83 "allowsSystemGenerateNewId": true,
84 "numberRangeIdentifierValue": "string",
85 "numberRangeIdentifierType": {
86 "name": "string"
87 },
88 "numberRangeType": {
89 "name": "string"
90 }
91 }
92 ]
93}
Bulk-Delete Resources¶
HTTP Request
DELETE /api/v1/ledger-entry-tax/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
ValidationExceptioncontaining 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 tax identifiers for bulk deletion operations. |
Body Parameters
1[
2 0
3]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
||
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
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-tax/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 |
false |
Request body containing search criteria and filters for retrieving specific ledger entry tax records based on user-defined parameters. |
Default Values¶
Parameter |
Default |
Type |
|---|---|---|
page |
|
query |
size |
|
query |
sort |
|
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 "ledgerEntryIdEqual": 0,
20 "ledgerEntryIdIn": [
21 0
22 ],
23 "itemTextLike": "string",
24 "entryTypeEqual": "D"
25}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
||
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
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 "taxBaseAmount": 0,
38 "totalTaxDocumentAmount": 0,
39 "taxExempt": 0,
40 "taxAffected": 0,
41 "vendor": {
42 "id": 0,
43 "displayId": "string",
44 "status": "CREATED",
45 "name": "string",
46 "erpSystemDisplayId": "string"
47 },
48 "ledgerEntryId": 0,
49 "additionalCurrencies": [
50 {
51 "id": 0,
52 "displayId": "string",
53 "entryType": "D",
54 "amount": 0,
55 "unroundedAmount": 0,
56 "deltaAdjustment": 0,
57 "currency": {
58 "id": 0,
59 "displayId": "string"
60 },
61 "currencyDefinitionType": "CONTRACT_CURRENCY",
62 "currencyType": "string",
63 "rate": 0,
64 "conversionDate": "2019-08-24",
65 "translationDateType": "DOCUMENT_DATE",
66 "sourceCurrencyType": "CONTRACT_CURRENCY",
67 "sourceCurrency": {
68 "id": 0,
69 "displayId": "string"
70 },
71 "depreciationArea": {
72 "id": 0,
73 "displayId": "string"
74 },
75 "ledgerEntryId": 0,
76 "ledgerEntryTaxId": 0,
77 "allowsSystemGenerateNewId": true,
78 "numberRangeIdentifierValue": "string",
79 "numberRangeIdentifierType": {
80 "name": "string"
81 },
82 "numberRangeType": {
83 "name": "string"
84 }
85 }
86 ],
87 "allowsSystemGenerateNewId": true,
88 "numberRangeIdentifierValue": "string",
89 "numberRangeIdentifierType": {
90 "name": "string"
91 },
92 "numberRangeType": {
93 "name": "string"
94 }
95 }
96 ],
97 "number": 0,
98 "sort": {
99 "unsorted": true,
100 "sorted": true,
101 "empty": true
102 },
103 "first": true,
104 "last": true,
105 "empty": true
106}
List All Resources¶
HTTP Request
GET /api/v1/ledger-entry-tax
📋 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 |
true |
Indicates whether the results of the ledger entry tax retrieval should be paginated, allowing for efficient data management and retrieval. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
||
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
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 "taxBaseAmount": 0,
38 "totalTaxDocumentAmount": 0,
39 "taxExempt": 0,
40 "taxAffected": 0,
41 "vendor": {
42 "id": 0,
43 "displayId": "string",
44 "status": "CREATED",
45 "name": "string",
46 "erpSystemDisplayId": "string"
47 },
48 "ledgerEntryId": 0,
49 "additionalCurrencies": [
50 {
51 "id": 0,
52 "displayId": "string",
53 "entryType": "D",
54 "amount": 0,
55 "unroundedAmount": 0,
56 "deltaAdjustment": 0,
57 "currency": {
58 "id": 0,
59 "displayId": "string"
60 },
61 "currencyDefinitionType": "CONTRACT_CURRENCY",
62 "currencyType": "string",
63 "rate": 0,
64 "conversionDate": "2019-08-24",
65 "translationDateType": "DOCUMENT_DATE",
66 "sourceCurrencyType": "CONTRACT_CURRENCY",
67 "sourceCurrency": {
68 "id": 0,
69 "displayId": "string"
70 },
71 "depreciationArea": {
72 "id": 0,
73 "displayId": "string"
74 },
75 "ledgerEntryId": 0,
76 "ledgerEntryTaxId": 0,
77 "allowsSystemGenerateNewId": true,
78 "numberRangeIdentifierValue": "string",
79 "numberRangeIdentifierType": {
80 "name": "string"
81 },
82 "numberRangeType": {
83 "name": "string"
84 }
85 }
86 ],
87 "allowsSystemGenerateNewId": true,
88 "numberRangeIdentifierValue": "string",
89 "numberRangeIdentifierType": {
90 "name": "string"
91 },
92 "numberRangeType": {
93 "name": "string"
94 }
95 }
96 ],
97 "number": 0,
98 "sort": {
99 "unsorted": true,
100 "sorted": true,
101 "empty": true
102 },
103 "first": true,
104 "last": true,
105 "empty": true
106}
Create A Resource¶
HTTP Request
POST /api/v1/ledger-entry-tax
📋 Description: Creates a single resource. Returns the created resource with its generated ID.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the detailed tax entry data, including relevant amounts, categories, and associated ledger identifiers for accurate financial reporting. |
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 "taxBaseAmount": 0,
20 "totalTaxDocumentAmount": 0,
21 "taxExempt": 0,
22 "taxAffected": 0,
23 "vendor": {
24 "id": 0,
25 "displayId": "string",
26 "status": "CREATED",
27 "name": "string",
28 "erpSystemDisplayId": "string"
29 },
30 "ledgerEntryId": 0,
31 "additionalCurrencies": [
32 {
33 "id": 0,
34 "displayId": "string",
35 "entryType": "D",
36 "amount": 0,
37 "unroundedAmount": 0,
38 "deltaAdjustment": 0,
39 "currency": {
40 "id": 0,
41 "displayId": "string"
42 },
43 "currencyDefinitionType": "CONTRACT_CURRENCY",
44 "currencyType": "string",
45 "rate": 0,
46 "conversionDate": "2019-08-24",
47 "translationDateType": "DOCUMENT_DATE",
48 "sourceCurrencyType": "CONTRACT_CURRENCY",
49 "sourceCurrency": {
50 "id": 0,
51 "displayId": "string"
52 },
53 "depreciationArea": {
54 "id": 0,
55 "displayId": "string"
56 },
57 "ledgerEntryId": 0,
58 "ledgerEntryTaxId": 0,
59 "allowsSystemGenerateNewId": true,
60 "numberRangeIdentifierValue": "string",
61 "numberRangeIdentifierType": {
62 "name": "string"
63 },
64 "numberRangeType": {
65 "name": "string"
66 }
67 }
68 ],
69 "allowsSystemGenerateNewId": true,
70 "numberRangeIdentifierValue": "string",
71 "numberRangeIdentifierType": {
72 "name": "string"
73 },
74 "numberRangeType": {
75 "name": "string"
76 }
77}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
||
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
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 "taxBaseAmount": 0,
33 "totalTaxDocumentAmount": 0,
34 "taxExempt": 0,
35 "taxAffected": 0,
36 "vendor": {
37 "id": 0,
38 "displayId": "string",
39 "status": "CREATED",
40 "name": "string",
41 "erpSystemDisplayId": "string"
42 },
43 "ledgerEntryId": 0,
44 "additionalCurrencies": [
45 {
46 "id": 0,
47 "displayId": "string",
48 "entryType": "D",
49 "amount": 0,
50 "unroundedAmount": 0,
51 "deltaAdjustment": 0,
52 "currency": {
53 "id": 0,
54 "displayId": "string"
55 },
56 "currencyDefinitionType": "CONTRACT_CURRENCY",
57 "currencyType": "string",
58 "rate": 0,
59 "conversionDate": "2019-08-24",
60 "translationDateType": "DOCUMENT_DATE",
61 "sourceCurrencyType": "CONTRACT_CURRENCY",
62 "sourceCurrency": {
63 "id": 0,
64 "displayId": "string"
65 },
66 "depreciationArea": {
67 "id": 0,
68 "displayId": "string"
69 },
70 "ledgerEntryId": 0,
71 "ledgerEntryTaxId": 0,
72 "allowsSystemGenerateNewId": true,
73 "numberRangeIdentifierValue": "string",
74 "numberRangeIdentifierType": {
75 "name": "string"
76 },
77 "numberRangeType": {
78 "name": "string"
79 }
80 }
81 ],
82 "allowsSystemGenerateNewId": true,
83 "numberRangeIdentifierValue": "string",
84 "numberRangeIdentifierType": {
85 "name": "string"
86 },
87 "numberRangeType": {
88 "name": "string"
89 }
90 }
91}