Invoice Line Item¶
Unmatch Scheduled Payments From An Invoice Line Item¶
HTTP Request
PUT /api/v1/invoice-line-item/{lineItemId}/unmatch-scheduled-payments
📋 Description: Removes match associations between the specified invoice line item and the given scheduled payment IDs.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
lineItemId |
path |
integer(int64) |
true |
Invoice line item ID |
body |
body |
array[integer] |
true |
Request body containing the details necessary to unmatch scheduled payments from the specified invoice line item, including relevant identifiers and adjustment information. |
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}
Match Scheduled Payments To An Invoice Line Item¶
HTTP Request
PUT /api/v1/invoice-line-item/{lineItemId}/match-scheduled-payments
📋 Description: Creates match associations between the specified invoice line item and one or more scheduled payments. The match amounts must not exceed the line item’s remaining balance.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
lineItemId |
path |
integer(int64) |
true |
Invoice line item ID |
body |
body |
true |
Request body containing the scheduled payment details to match with the specified invoice line item, facilitating accurate financial reconciliation. |
Body Parameters
1[
2 {
3 "clearingLedgerEntryId": 0,
4 "amount": 0
5 }
6]
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 "fromId": 0,
18 "toId": 0,
19 "amount": 0
20 }
21 ]
22}
Get A Resource By ID¶
HTTP Request
GET /api/v1/invoice-line-item/{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 "expenseCategory": {
18 "id": 0,
19 "displayId": "string",
20 "status": "CREATED",
21 "name": "string",
22 "expenseCategoryType": "PAYMENT"
23 },
24 "description": "string",
25 "unitOfMeasure": {
26 "id": 0,
27 "displayId": "string",
28 "status": "CREATED",
29 "name": "string",
30 "erpSystemId": 0
31 },
32 "quantity": 0,
33 "unitPrice": 0,
34 "taxJurisdiction": {
35 "id": 0,
36 "displayId": "string",
37 "status": "CREATED",
38 "name": "string",
39 "erpSystemId": 0,
40 "schema": "string",
41 "countryDisplayId": "string"
42 },
43 "taxCode": {
44 "id": 0,
45 "displayId": "string",
46 "status": "CREATED",
47 "name": "string",
48 "erpSystemId": 0
49 },
50 "taxExpenseAccount": {
51 "id": 0,
52 "displayId": "string",
53 "generalLedgerAccountName": "string",
54 "generalLedgerAccountCode": "string",
55 "openItemManagement": true,
56 "accountCategory": "BALANCESHEET",
57 "shortName": "string",
58 "longName": "string"
59 },
60 "taxLineItems": [
61 {
62 "id": 0,
63 "taxRate": 0.1,
64 "taxAmount": 0,
65 "taxType": "string",
66 "invoiceLineItemId": 0
67 }
68 ],
69 "workBreakdownStructure": {
70 "id": 0,
71 "displayId": "string",
72 "status": "CREATED",
73 "name": "string",
74 "erpSystemId": 0
75 },
76 "costCenter": {
77 "id": 0,
78 "displayId": "string",
79 "status": "CREATED",
80 "name": "string",
81 "erpSystemId": 0
82 },
83 "profitCenter": {
84 "id": 0,
85 "displayId": "string",
86 "status": "CREATED",
87 "name": "string",
88 "validTo": "2019-08-24",
89 "erpSystemId": 0,
90 "erpSystemDisplayId": "string"
91 },
92 "functionalArea": {
93 "id": 0,
94 "displayId": "string",
95 "status": "CREATED",
96 "name": "string",
97 "erpSystemId": 0
98 },
99 "businessArea": {
100 "id": 0,
101 "displayId": "string",
102 "status": "CREATED",
103 "name": "string",
104 "erpSystemId": 0
105 },
106 "segment": {
107 "id": 0,
108 "displayId": "string",
109 "status": "CREATED",
110 "name": "string",
111 "erpSystemId": 0
112 },
113 "network": {
114 "id": 0,
115 "displayId": "string",
116 "status": "CREATED",
117 "name": "string",
118 "erpSystemId": 0
119 },
120 "internalOrderType": {
121 "id": 0,
122 "displayId": "string",
123 "status": "CREATED",
124 "name": "string",
125 "erpSystemId": 0
126 },
127 "internalOrder": {
128 "id": 0,
129 "displayId": "string",
130 "status": "CREATED",
131 "name": "string",
132 "erpSystemId": 0,
133 "internalOrderTypeId": 0
134 },
135 "additionalCurrencies": [
136 {
137 "id": 0,
138 "amount": 0,
139 "currency": {
140 "id": 0,
141 "displayId": "string",
142 "status": "CREATED",
143 "name": "string",
144 "decimalPoints": 0
145 },
146 "conversionRate": 0,
147 "conversionDate": "2019-08-24",
148 "translationDateType": "DOCUMENT_DATE",
149 "amountType": "NET_AMOUNT",
150 "currencyDefinitionType": "CONTRACT_CURRENCY",
151 "invoiceEntryId": 0,
152 "invoiceEntryDisplayId": "string"
153 }
154 ],
155 "scheduledPaymentMatches": [
156 {
157 "id": 0,
158 "fromId": 0,
159 "toId": 0,
160 "amount": 0
161 }
162 ],
163 "goodsReceiptLineItemLinks": [
164 {
165 "id": 0,
166 "fromId": 0,
167 "toId": 0,
168 "linkedQuantity": 0
169 }
170 ],
171 "invoiceId": 0,
172 "invoiceDisplayId": "string",
173 "invoiceState": "INV_DRAFT",
174 "vendorPaymentId": 0,
175 "purchaseOrderLineItemId": 0,
176 "netAmount": 0,
177 "allowsSystemGenerateNewId": true,
178 "numberRangeIdentifierValue": "string",
179 "numberRangeIdentifierType": {
180 "name": "string"
181 },
182 "numberRangeType": {
183 "name": "string"
184 }
185 }
186}
Update A Resource¶
HTTP Request
PUT /api/v1/invoice-line-item/{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 invoice line item details, including quantity, price, and any applicable discounts, to ensure accurate billing and financial reporting. |
Body Parameters
1{
2 "id": 0,
3 "displayId": "string",
4 "expenseCategory": {
5 "id": 0,
6 "displayId": "string",
7 "status": "CREATED",
8 "name": "string",
9 "expenseCategoryType": "PAYMENT"
10 },
11 "description": "string",
12 "unitOfMeasure": {
13 "id": 0,
14 "displayId": "string",
15 "status": "CREATED",
16 "name": "string",
17 "erpSystemId": 0
18 },
19 "quantity": 0,
20 "unitPrice": 0,
21 "taxJurisdiction": {
22 "id": 0,
23 "displayId": "string",
24 "status": "CREATED",
25 "name": "string",
26 "erpSystemId": 0,
27 "schema": "string",
28 "countryDisplayId": "string"
29 },
30 "taxCode": {
31 "id": 0,
32 "displayId": "string",
33 "status": "CREATED",
34 "name": "string",
35 "erpSystemId": 0
36 },
37 "taxExpenseAccount": {
38 "id": 0,
39 "displayId": "string",
40 "generalLedgerAccountName": "string",
41 "generalLedgerAccountCode": "string",
42 "openItemManagement": true,
43 "accountCategory": "BALANCESHEET",
44 "shortName": "string",
45 "longName": "string"
46 },
47 "taxLineItems": [
48 {
49 "id": 0,
50 "taxRate": 0.1,
51 "taxAmount": 0,
52 "taxType": "string",
53 "invoiceLineItemId": 0
54 }
55 ],
56 "workBreakdownStructure": {
57 "id": 0,
58 "displayId": "string",
59 "status": "CREATED",
60 "name": "string",
61 "erpSystemId": 0
62 },
63 "costCenter": {
64 "id": 0,
65 "displayId": "string",
66 "status": "CREATED",
67 "name": "string",
68 "erpSystemId": 0
69 },
70 "profitCenter": {
71 "id": 0,
72 "displayId": "string",
73 "status": "CREATED",
74 "name": "string",
75 "validTo": "2019-08-24",
76 "erpSystemId": 0,
77 "erpSystemDisplayId": "string"
78 },
79 "functionalArea": {
80 "id": 0,
81 "displayId": "string",
82 "status": "CREATED",
83 "name": "string",
84 "erpSystemId": 0
85 },
86 "businessArea": {
87 "id": 0,
88 "displayId": "string",
89 "status": "CREATED",
90 "name": "string",
91 "erpSystemId": 0
92 },
93 "segment": {
94 "id": 0,
95 "displayId": "string",
96 "status": "CREATED",
97 "name": "string",
98 "erpSystemId": 0
99 },
100 "network": {
101 "id": 0,
102 "displayId": "string",
103 "status": "CREATED",
104 "name": "string",
105 "erpSystemId": 0
106 },
107 "internalOrderType": {
108 "id": 0,
109 "displayId": "string",
110 "status": "CREATED",
111 "name": "string",
112 "erpSystemId": 0
113 },
114 "internalOrder": {
115 "id": 0,
116 "displayId": "string",
117 "status": "CREATED",
118 "name": "string",
119 "erpSystemId": 0,
120 "internalOrderTypeId": 0
121 },
122 "additionalCurrencies": [
123 {
124 "id": 0,
125 "amount": 0,
126 "currency": {
127 "id": 0,
128 "displayId": "string",
129 "status": "CREATED",
130 "name": "string",
131 "decimalPoints": 0
132 },
133 "conversionRate": 0,
134 "conversionDate": "2019-08-24",
135 "translationDateType": "DOCUMENT_DATE",
136 "amountType": "NET_AMOUNT",
137 "currencyDefinitionType": "CONTRACT_CURRENCY",
138 "invoiceEntryId": 0,
139 "invoiceEntryDisplayId": "string"
140 }
141 ],
142 "scheduledPaymentMatches": [
143 {
144 "id": 0,
145 "fromId": 0,
146 "toId": 0,
147 "amount": 0
148 }
149 ],
150 "goodsReceiptLineItemLinks": [
151 {
152 "id": 0,
153 "fromId": 0,
154 "toId": 0,
155 "linkedQuantity": 0
156 }
157 ],
158 "invoiceId": 0,
159 "invoiceDisplayId": "string",
160 "invoiceState": "INV_DRAFT",
161 "vendorPaymentId": 0,
162 "purchaseOrderLineItemId": 0,
163 "netAmount": 0,
164 "allowsSystemGenerateNewId": true,
165 "numberRangeIdentifierValue": "string",
166 "numberRangeIdentifierType": {
167 "name": "string"
168 },
169 "numberRangeType": {
170 "name": "string"
171 }
172}
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 "expenseCategory": {
18 "id": 0,
19 "displayId": "string",
20 "status": "CREATED",
21 "name": "string",
22 "expenseCategoryType": "PAYMENT"
23 },
24 "description": "string",
25 "unitOfMeasure": {
26 "id": 0,
27 "displayId": "string",
28 "status": "CREATED",
29 "name": "string",
30 "erpSystemId": 0
31 },
32 "quantity": 0,
33 "unitPrice": 0,
34 "taxJurisdiction": {
35 "id": 0,
36 "displayId": "string",
37 "status": "CREATED",
38 "name": "string",
39 "erpSystemId": 0,
40 "schema": "string",
41 "countryDisplayId": "string"
42 },
43 "taxCode": {
44 "id": 0,
45 "displayId": "string",
46 "status": "CREATED",
47 "name": "string",
48 "erpSystemId": 0
49 },
50 "taxExpenseAccount": {
51 "id": 0,
52 "displayId": "string",
53 "generalLedgerAccountName": "string",
54 "generalLedgerAccountCode": "string",
55 "openItemManagement": true,
56 "accountCategory": "BALANCESHEET",
57 "shortName": "string",
58 "longName": "string"
59 },
60 "taxLineItems": [
61 {
62 "id": 0,
63 "taxRate": 0.1,
64 "taxAmount": 0,
65 "taxType": "string",
66 "invoiceLineItemId": 0
67 }
68 ],
69 "workBreakdownStructure": {
70 "id": 0,
71 "displayId": "string",
72 "status": "CREATED",
73 "name": "string",
74 "erpSystemId": 0
75 },
76 "costCenter": {
77 "id": 0,
78 "displayId": "string",
79 "status": "CREATED",
80 "name": "string",
81 "erpSystemId": 0
82 },
83 "profitCenter": {
84 "id": 0,
85 "displayId": "string",
86 "status": "CREATED",
87 "name": "string",
88 "validTo": "2019-08-24",
89 "erpSystemId": 0,
90 "erpSystemDisplayId": "string"
91 },
92 "functionalArea": {
93 "id": 0,
94 "displayId": "string",
95 "status": "CREATED",
96 "name": "string",
97 "erpSystemId": 0
98 },
99 "businessArea": {
100 "id": 0,
101 "displayId": "string",
102 "status": "CREATED",
103 "name": "string",
104 "erpSystemId": 0
105 },
106 "segment": {
107 "id": 0,
108 "displayId": "string",
109 "status": "CREATED",
110 "name": "string",
111 "erpSystemId": 0
112 },
113 "network": {
114 "id": 0,
115 "displayId": "string",
116 "status": "CREATED",
117 "name": "string",
118 "erpSystemId": 0
119 },
120 "internalOrderType": {
121 "id": 0,
122 "displayId": "string",
123 "status": "CREATED",
124 "name": "string",
125 "erpSystemId": 0
126 },
127 "internalOrder": {
128 "id": 0,
129 "displayId": "string",
130 "status": "CREATED",
131 "name": "string",
132 "erpSystemId": 0,
133 "internalOrderTypeId": 0
134 },
135 "additionalCurrencies": [
136 {
137 "id": 0,
138 "amount": 0,
139 "currency": {
140 "id": 0,
141 "displayId": "string",
142 "status": "CREATED",
143 "name": "string",
144 "decimalPoints": 0
145 },
146 "conversionRate": 0,
147 "conversionDate": "2019-08-24",
148 "translationDateType": "DOCUMENT_DATE",
149 "amountType": "NET_AMOUNT",
150 "currencyDefinitionType": "CONTRACT_CURRENCY",
151 "invoiceEntryId": 0,
152 "invoiceEntryDisplayId": "string"
153 }
154 ],
155 "scheduledPaymentMatches": [
156 {
157 "id": 0,
158 "fromId": 0,
159 "toId": 0,
160 "amount": 0
161 }
162 ],
163 "goodsReceiptLineItemLinks": [
164 {
165 "id": 0,
166 "fromId": 0,
167 "toId": 0,
168 "linkedQuantity": 0
169 }
170 ],
171 "invoiceId": 0,
172 "invoiceDisplayId": "string",
173 "invoiceState": "INV_DRAFT",
174 "vendorPaymentId": 0,
175 "purchaseOrderLineItemId": 0,
176 "netAmount": 0,
177 "allowsSystemGenerateNewId": true,
178 "numberRangeIdentifierValue": "string",
179 "numberRangeIdentifierType": {
180 "name": "string"
181 },
182 "numberRangeType": {
183 "name": "string"
184 }
185 }
186}
Delete A Single Resource¶
HTTP Request
DELETE /api/v1/invoice-line-item/{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/invoice-line-item/{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 details for the specified invoice line item, including quantity, price, and any relevant 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 "expenseCategory": {
18 "id": 0,
19 "displayId": "string",
20 "status": "CREATED",
21 "name": "string",
22 "expenseCategoryType": "PAYMENT"
23 },
24 "description": "string",
25 "unitOfMeasure": {
26 "id": 0,
27 "displayId": "string",
28 "status": "CREATED",
29 "name": "string",
30 "erpSystemId": 0
31 },
32 "quantity": 0,
33 "unitPrice": 0,
34 "taxJurisdiction": {
35 "id": 0,
36 "displayId": "string",
37 "status": "CREATED",
38 "name": "string",
39 "erpSystemId": 0,
40 "schema": "string",
41 "countryDisplayId": "string"
42 },
43 "taxCode": {
44 "id": 0,
45 "displayId": "string",
46 "status": "CREATED",
47 "name": "string",
48 "erpSystemId": 0
49 },
50 "taxExpenseAccount": {
51 "id": 0,
52 "displayId": "string",
53 "generalLedgerAccountName": "string",
54 "generalLedgerAccountCode": "string",
55 "openItemManagement": true,
56 "accountCategory": "BALANCESHEET",
57 "shortName": "string",
58 "longName": "string"
59 },
60 "taxLineItems": [
61 {
62 "id": 0,
63 "taxRate": 0.1,
64 "taxAmount": 0,
65 "taxType": "string",
66 "invoiceLineItemId": 0
67 }
68 ],
69 "workBreakdownStructure": {
70 "id": 0,
71 "displayId": "string",
72 "status": "CREATED",
73 "name": "string",
74 "erpSystemId": 0
75 },
76 "costCenter": {
77 "id": 0,
78 "displayId": "string",
79 "status": "CREATED",
80 "name": "string",
81 "erpSystemId": 0
82 },
83 "profitCenter": {
84 "id": 0,
85 "displayId": "string",
86 "status": "CREATED",
87 "name": "string",
88 "validTo": "2019-08-24",
89 "erpSystemId": 0,
90 "erpSystemDisplayId": "string"
91 },
92 "functionalArea": {
93 "id": 0,
94 "displayId": "string",
95 "status": "CREATED",
96 "name": "string",
97 "erpSystemId": 0
98 },
99 "businessArea": {
100 "id": 0,
101 "displayId": "string",
102 "status": "CREATED",
103 "name": "string",
104 "erpSystemId": 0
105 },
106 "segment": {
107 "id": 0,
108 "displayId": "string",
109 "status": "CREATED",
110 "name": "string",
111 "erpSystemId": 0
112 },
113 "network": {
114 "id": 0,
115 "displayId": "string",
116 "status": "CREATED",
117 "name": "string",
118 "erpSystemId": 0
119 },
120 "internalOrderType": {
121 "id": 0,
122 "displayId": "string",
123 "status": "CREATED",
124 "name": "string",
125 "erpSystemId": 0
126 },
127 "internalOrder": {
128 "id": 0,
129 "displayId": "string",
130 "status": "CREATED",
131 "name": "string",
132 "erpSystemId": 0,
133 "internalOrderTypeId": 0
134 },
135 "additionalCurrencies": [
136 {
137 "id": 0,
138 "amount": 0,
139 "currency": {
140 "id": 0,
141 "displayId": "string",
142 "status": "CREATED",
143 "name": "string",
144 "decimalPoints": 0
145 },
146 "conversionRate": 0,
147 "conversionDate": "2019-08-24",
148 "translationDateType": "DOCUMENT_DATE",
149 "amountType": "NET_AMOUNT",
150 "currencyDefinitionType": "CONTRACT_CURRENCY",
151 "invoiceEntryId": 0,
152 "invoiceEntryDisplayId": "string"
153 }
154 ],
155 "scheduledPaymentMatches": [
156 {
157 "id": 0,
158 "fromId": 0,
159 "toId": 0,
160 "amount": 0
161 }
162 ],
163 "goodsReceiptLineItemLinks": [
164 {
165 "id": 0,
166 "fromId": 0,
167 "toId": 0,
168 "linkedQuantity": 0
169 }
170 ],
171 "invoiceId": 0,
172 "invoiceDisplayId": "string",
173 "invoiceState": "INV_DRAFT",
174 "vendorPaymentId": 0,
175 "purchaseOrderLineItemId": 0,
176 "netAmount": 0,
177 "allowsSystemGenerateNewId": true,
178 "numberRangeIdentifierValue": "string",
179 "numberRangeIdentifierType": {
180 "name": "string"
181 },
182 "numberRangeType": {
183 "name": "string"
184 }
185 }
186}
Create Or Update A Resource¶
HTTP Request
PUT /api/v1/invoice-line-item/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 invoice line item details, including item description, quantity, price, and any applicable discounts for creation or update purposes. |
Body Parameters
1{
2 "id": 0,
3 "displayId": "string",
4 "expenseCategory": {
5 "id": 0,
6 "displayId": "string",
7 "status": "CREATED",
8 "name": "string",
9 "expenseCategoryType": "PAYMENT"
10 },
11 "description": "string",
12 "unitOfMeasure": {
13 "id": 0,
14 "displayId": "string",
15 "status": "CREATED",
16 "name": "string",
17 "erpSystemId": 0
18 },
19 "quantity": 0,
20 "unitPrice": 0,
21 "taxJurisdiction": {
22 "id": 0,
23 "displayId": "string",
24 "status": "CREATED",
25 "name": "string",
26 "erpSystemId": 0,
27 "schema": "string",
28 "countryDisplayId": "string"
29 },
30 "taxCode": {
31 "id": 0,
32 "displayId": "string",
33 "status": "CREATED",
34 "name": "string",
35 "erpSystemId": 0
36 },
37 "taxExpenseAccount": {
38 "id": 0,
39 "displayId": "string",
40 "generalLedgerAccountName": "string",
41 "generalLedgerAccountCode": "string",
42 "openItemManagement": true,
43 "accountCategory": "BALANCESHEET",
44 "shortName": "string",
45 "longName": "string"
46 },
47 "taxLineItems": [
48 {
49 "id": 0,
50 "taxRate": 0.1,
51 "taxAmount": 0,
52 "taxType": "string",
53 "invoiceLineItemId": 0
54 }
55 ],
56 "workBreakdownStructure": {
57 "id": 0,
58 "displayId": "string",
59 "status": "CREATED",
60 "name": "string",
61 "erpSystemId": 0
62 },
63 "costCenter": {
64 "id": 0,
65 "displayId": "string",
66 "status": "CREATED",
67 "name": "string",
68 "erpSystemId": 0
69 },
70 "profitCenter": {
71 "id": 0,
72 "displayId": "string",
73 "status": "CREATED",
74 "name": "string",
75 "validTo": "2019-08-24",
76 "erpSystemId": 0,
77 "erpSystemDisplayId": "string"
78 },
79 "functionalArea": {
80 "id": 0,
81 "displayId": "string",
82 "status": "CREATED",
83 "name": "string",
84 "erpSystemId": 0
85 },
86 "businessArea": {
87 "id": 0,
88 "displayId": "string",
89 "status": "CREATED",
90 "name": "string",
91 "erpSystemId": 0
92 },
93 "segment": {
94 "id": 0,
95 "displayId": "string",
96 "status": "CREATED",
97 "name": "string",
98 "erpSystemId": 0
99 },
100 "network": {
101 "id": 0,
102 "displayId": "string",
103 "status": "CREATED",
104 "name": "string",
105 "erpSystemId": 0
106 },
107 "internalOrderType": {
108 "id": 0,
109 "displayId": "string",
110 "status": "CREATED",
111 "name": "string",
112 "erpSystemId": 0
113 },
114 "internalOrder": {
115 "id": 0,
116 "displayId": "string",
117 "status": "CREATED",
118 "name": "string",
119 "erpSystemId": 0,
120 "internalOrderTypeId": 0
121 },
122 "additionalCurrencies": [
123 {
124 "id": 0,
125 "amount": 0,
126 "currency": {
127 "id": 0,
128 "displayId": "string",
129 "status": "CREATED",
130 "name": "string",
131 "decimalPoints": 0
132 },
133 "conversionRate": 0,
134 "conversionDate": "2019-08-24",
135 "translationDateType": "DOCUMENT_DATE",
136 "amountType": "NET_AMOUNT",
137 "currencyDefinitionType": "CONTRACT_CURRENCY",
138 "invoiceEntryId": 0,
139 "invoiceEntryDisplayId": "string"
140 }
141 ],
142 "scheduledPaymentMatches": [
143 {
144 "id": 0,
145 "fromId": 0,
146 "toId": 0,
147 "amount": 0
148 }
149 ],
150 "goodsReceiptLineItemLinks": [
151 {
152 "id": 0,
153 "fromId": 0,
154 "toId": 0,
155 "linkedQuantity": 0
156 }
157 ],
158 "invoiceId": 0,
159 "invoiceDisplayId": "string",
160 "invoiceState": "INV_DRAFT",
161 "vendorPaymentId": 0,
162 "purchaseOrderLineItemId": 0,
163 "netAmount": 0,
164 "allowsSystemGenerateNewId": true,
165 "numberRangeIdentifierValue": "string",
166 "numberRangeIdentifierType": {
167 "name": "string"
168 },
169 "numberRangeType": {
170 "name": "string"
171 }
172}
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 "expenseCategory": {
18 "id": 0,
19 "displayId": "string",
20 "status": "CREATED",
21 "name": "string",
22 "expenseCategoryType": "PAYMENT"
23 },
24 "description": "string",
25 "unitOfMeasure": {
26 "id": 0,
27 "displayId": "string",
28 "status": "CREATED",
29 "name": "string",
30 "erpSystemId": 0
31 },
32 "quantity": 0,
33 "unitPrice": 0,
34 "taxJurisdiction": {
35 "id": 0,
36 "displayId": "string",
37 "status": "CREATED",
38 "name": "string",
39 "erpSystemId": 0,
40 "schema": "string",
41 "countryDisplayId": "string"
42 },
43 "taxCode": {
44 "id": 0,
45 "displayId": "string",
46 "status": "CREATED",
47 "name": "string",
48 "erpSystemId": 0
49 },
50 "taxExpenseAccount": {
51 "id": 0,
52 "displayId": "string",
53 "generalLedgerAccountName": "string",
54 "generalLedgerAccountCode": "string",
55 "openItemManagement": true,
56 "accountCategory": "BALANCESHEET",
57 "shortName": "string",
58 "longName": "string"
59 },
60 "taxLineItems": [
61 {
62 "id": 0,
63 "taxRate": 0.1,
64 "taxAmount": 0,
65 "taxType": "string",
66 "invoiceLineItemId": 0
67 }
68 ],
69 "workBreakdownStructure": {
70 "id": 0,
71 "displayId": "string",
72 "status": "CREATED",
73 "name": "string",
74 "erpSystemId": 0
75 },
76 "costCenter": {
77 "id": 0,
78 "displayId": "string",
79 "status": "CREATED",
80 "name": "string",
81 "erpSystemId": 0
82 },
83 "profitCenter": {
84 "id": 0,
85 "displayId": "string",
86 "status": "CREATED",
87 "name": "string",
88 "validTo": "2019-08-24",
89 "erpSystemId": 0,
90 "erpSystemDisplayId": "string"
91 },
92 "functionalArea": {
93 "id": 0,
94 "displayId": "string",
95 "status": "CREATED",
96 "name": "string",
97 "erpSystemId": 0
98 },
99 "businessArea": {
100 "id": 0,
101 "displayId": "string",
102 "status": "CREATED",
103 "name": "string",
104 "erpSystemId": 0
105 },
106 "segment": {
107 "id": 0,
108 "displayId": "string",
109 "status": "CREATED",
110 "name": "string",
111 "erpSystemId": 0
112 },
113 "network": {
114 "id": 0,
115 "displayId": "string",
116 "status": "CREATED",
117 "name": "string",
118 "erpSystemId": 0
119 },
120 "internalOrderType": {
121 "id": 0,
122 "displayId": "string",
123 "status": "CREATED",
124 "name": "string",
125 "erpSystemId": 0
126 },
127 "internalOrder": {
128 "id": 0,
129 "displayId": "string",
130 "status": "CREATED",
131 "name": "string",
132 "erpSystemId": 0,
133 "internalOrderTypeId": 0
134 },
135 "additionalCurrencies": [
136 {
137 "id": 0,
138 "amount": 0,
139 "currency": {
140 "id": 0,
141 "displayId": "string",
142 "status": "CREATED",
143 "name": "string",
144 "decimalPoints": 0
145 },
146 "conversionRate": 0,
147 "conversionDate": "2019-08-24",
148 "translationDateType": "DOCUMENT_DATE",
149 "amountType": "NET_AMOUNT",
150 "currencyDefinitionType": "CONTRACT_CURRENCY",
151 "invoiceEntryId": 0,
152 "invoiceEntryDisplayId": "string"
153 }
154 ],
155 "scheduledPaymentMatches": [
156 {
157 "id": 0,
158 "fromId": 0,
159 "toId": 0,
160 "amount": 0
161 }
162 ],
163 "goodsReceiptLineItemLinks": [
164 {
165 "id": 0,
166 "fromId": 0,
167 "toId": 0,
168 "linkedQuantity": 0
169 }
170 ],
171 "invoiceId": 0,
172 "invoiceDisplayId": "string",
173 "invoiceState": "INV_DRAFT",
174 "vendorPaymentId": 0,
175 "purchaseOrderLineItemId": 0,
176 "netAmount": 0,
177 "allowsSystemGenerateNewId": true,
178 "numberRangeIdentifierValue": "string",
179 "numberRangeIdentifierType": {
180 "name": "string"
181 },
182 "numberRangeType": {
183 "name": "string"
184 }
185 }
186}
Bulk Create-Or-Update Resources¶
HTTP Request
PUT /api/v1/invoice-line-item/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 an array of invoice line items for bulk creation or update, including details such as item descriptions, quantities, and pricing information. |
Body Parameters
1[
2 {
3 "id": 0,
4 "displayId": "string",
5 "expenseCategory": {
6 "id": 0,
7 "displayId": "string",
8 "status": "CREATED",
9 "name": "string",
10 "expenseCategoryType": "PAYMENT"
11 },
12 "description": "string",
13 "unitOfMeasure": {
14 "id": 0,
15 "displayId": "string",
16 "status": "CREATED",
17 "name": "string",
18 "erpSystemId": 0
19 },
20 "quantity": 0,
21 "unitPrice": 0,
22 "taxJurisdiction": {
23 "id": 0,
24 "displayId": "string",
25 "status": "CREATED",
26 "name": "string",
27 "erpSystemId": 0,
28 "schema": "string",
29 "countryDisplayId": "string"
30 },
31 "taxCode": {
32 "id": 0,
33 "displayId": "string",
34 "status": "CREATED",
35 "name": "string",
36 "erpSystemId": 0
37 },
38 "taxExpenseAccount": {
39 "id": 0,
40 "displayId": "string",
41 "generalLedgerAccountName": "string",
42 "generalLedgerAccountCode": "string",
43 "openItemManagement": true,
44 "accountCategory": "BALANCESHEET",
45 "shortName": "string",
46 "longName": "string"
47 },
48 "taxLineItems": [
49 {
50 "id": 0,
51 "taxRate": 0.1,
52 "taxAmount": 0,
53 "taxType": "string",
54 "invoiceLineItemId": 0
55 }
56 ],
57 "workBreakdownStructure": {
58 "id": 0,
59 "displayId": "string",
60 "status": "CREATED",
61 "name": "string",
62 "erpSystemId": 0
63 },
64 "costCenter": {
65 "id": 0,
66 "displayId": "string",
67 "status": "CREATED",
68 "name": "string",
69 "erpSystemId": 0
70 },
71 "profitCenter": {
72 "id": 0,
73 "displayId": "string",
74 "status": "CREATED",
75 "name": "string",
76 "validTo": "2019-08-24",
77 "erpSystemId": 0,
78 "erpSystemDisplayId": "string"
79 },
80 "functionalArea": {
81 "id": 0,
82 "displayId": "string",
83 "status": "CREATED",
84 "name": "string",
85 "erpSystemId": 0
86 },
87 "businessArea": {
88 "id": 0,
89 "displayId": "string",
90 "status": "CREATED",
91 "name": "string",
92 "erpSystemId": 0
93 },
94 "segment": {
95 "id": 0,
96 "displayId": "string",
97 "status": "CREATED",
98 "name": "string",
99 "erpSystemId": 0
100 },
101 "network": {
102 "id": 0,
103 "displayId": "string",
104 "status": "CREATED",
105 "name": "string",
106 "erpSystemId": 0
107 },
108 "internalOrderType": {
109 "id": 0,
110 "displayId": "string",
111 "status": "CREATED",
112 "name": "string",
113 "erpSystemId": 0
114 },
115 "internalOrder": {
116 "id": 0,
117 "displayId": "string",
118 "status": "CREATED",
119 "name": "string",
120 "erpSystemId": 0,
121 "internalOrderTypeId": 0
122 },
123 "additionalCurrencies": [
124 {
125 "id": 0,
126 "amount": 0,
127 "currency": {
128 "id": 0,
129 "displayId": "string",
130 "status": "CREATED",
131 "name": "string",
132 "decimalPoints": 0
133 },
134 "conversionRate": 0,
135 "conversionDate": "2019-08-24",
136 "translationDateType": "DOCUMENT_DATE",
137 "amountType": "NET_AMOUNT",
138 "currencyDefinitionType": "CONTRACT_CURRENCY",
139 "invoiceEntryId": 0,
140 "invoiceEntryDisplayId": "string"
141 }
142 ],
143 "scheduledPaymentMatches": [
144 {
145 "id": 0,
146 "fromId": 0,
147 "toId": 0,
148 "amount": 0
149 }
150 ],
151 "goodsReceiptLineItemLinks": [
152 {
153 "id": 0,
154 "fromId": 0,
155 "toId": 0,
156 "linkedQuantity": 0
157 }
158 ],
159 "invoiceId": 0,
160 "invoiceDisplayId": "string",
161 "invoiceState": "INV_DRAFT",
162 "vendorPaymentId": 0,
163 "purchaseOrderLineItemId": 0,
164 "netAmount": 0,
165 "allowsSystemGenerateNewId": true,
166 "numberRangeIdentifierValue": "string",
167 "numberRangeIdentifierType": {
168 "name": "string"
169 },
170 "numberRangeType": {
171 "name": "string"
172 }
173 }
174]
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 "expenseCategory": {
19 "id": 0,
20 "displayId": "string",
21 "status": "CREATED",
22 "name": "string",
23 "expenseCategoryType": "PAYMENT"
24 },
25 "description": "string",
26 "unitOfMeasure": {
27 "id": 0,
28 "displayId": "string",
29 "status": "CREATED",
30 "name": "string",
31 "erpSystemId": 0
32 },
33 "quantity": 0,
34 "unitPrice": 0,
35 "taxJurisdiction": {
36 "id": 0,
37 "displayId": "string",
38 "status": "CREATED",
39 "name": "string",
40 "erpSystemId": 0,
41 "schema": "string",
42 "countryDisplayId": "string"
43 },
44 "taxCode": {
45 "id": 0,
46 "displayId": "string",
47 "status": "CREATED",
48 "name": "string",
49 "erpSystemId": 0
50 },
51 "taxExpenseAccount": {
52 "id": 0,
53 "displayId": "string",
54 "generalLedgerAccountName": "string",
55 "generalLedgerAccountCode": "string",
56 "openItemManagement": true,
57 "accountCategory": "BALANCESHEET",
58 "shortName": "string",
59 "longName": "string"
60 },
61 "taxLineItems": [
62 {
63 "id": 0,
64 "taxRate": 0.1,
65 "taxAmount": 0,
66 "taxType": "string",
67 "invoiceLineItemId": 0
68 }
69 ],
70 "workBreakdownStructure": {
71 "id": 0,
72 "displayId": "string",
73 "status": "CREATED",
74 "name": "string",
75 "erpSystemId": 0
76 },
77 "costCenter": {
78 "id": 0,
79 "displayId": "string",
80 "status": "CREATED",
81 "name": "string",
82 "erpSystemId": 0
83 },
84 "profitCenter": {
85 "id": 0,
86 "displayId": "string",
87 "status": "CREATED",
88 "name": "string",
89 "validTo": "2019-08-24",
90 "erpSystemId": 0,
91 "erpSystemDisplayId": "string"
92 },
93 "functionalArea": {
94 "id": 0,
95 "displayId": "string",
96 "status": "CREATED",
97 "name": "string",
98 "erpSystemId": 0
99 },
100 "businessArea": {
101 "id": 0,
102 "displayId": "string",
103 "status": "CREATED",
104 "name": "string",
105 "erpSystemId": 0
106 },
107 "segment": {
108 "id": 0,
109 "displayId": "string",
110 "status": "CREATED",
111 "name": "string",
112 "erpSystemId": 0
113 },
114 "network": {
115 "id": 0,
116 "displayId": "string",
117 "status": "CREATED",
118 "name": "string",
119 "erpSystemId": 0
120 },
121 "internalOrderType": {
122 "id": 0,
123 "displayId": "string",
124 "status": "CREATED",
125 "name": "string",
126 "erpSystemId": 0
127 },
128 "internalOrder": {
129 "id": 0,
130 "displayId": "string",
131 "status": "CREATED",
132 "name": "string",
133 "erpSystemId": 0,
134 "internalOrderTypeId": 0
135 },
136 "additionalCurrencies": [
137 {
138 "id": 0,
139 "amount": 0,
140 "currency": {
141 "id": 0,
142 "displayId": "string",
143 "status": "CREATED",
144 "name": "string",
145 "decimalPoints": 0
146 },
147 "conversionRate": 0,
148 "conversionDate": "2019-08-24",
149 "translationDateType": "DOCUMENT_DATE",
150 "amountType": "NET_AMOUNT",
151 "currencyDefinitionType": "CONTRACT_CURRENCY",
152 "invoiceEntryId": 0,
153 "invoiceEntryDisplayId": "string"
154 }
155 ],
156 "scheduledPaymentMatches": [
157 {
158 "id": 0,
159 "fromId": 0,
160 "toId": 0,
161 "amount": 0
162 }
163 ],
164 "goodsReceiptLineItemLinks": [
165 {
166 "id": 0,
167 "fromId": 0,
168 "toId": 0,
169 "linkedQuantity": 0
170 }
171 ],
172 "invoiceId": 0,
173 "invoiceDisplayId": "string",
174 "invoiceState": "INV_DRAFT",
175 "vendorPaymentId": 0,
176 "purchaseOrderLineItemId": 0,
177 "netAmount": 0,
178 "allowsSystemGenerateNewId": true,
179 "numberRangeIdentifierValue": "string",
180 "numberRangeIdentifierType": {
181 "name": "string"
182 },
183 "numberRangeType": {
184 "name": "string"
185 }
186 }
187 ]
188}
Bulk-Update Resources¶
HTTP Request
PUT /api/v1/invoice-line-item/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 an array of invoice line item details for bulk updates, including item descriptions, quantities, and pricing information. |
Body Parameters
1[
2 {
3 "id": 0,
4 "displayId": "string",
5 "expenseCategory": {
6 "id": 0,
7 "displayId": "string",
8 "status": "CREATED",
9 "name": "string",
10 "expenseCategoryType": "PAYMENT"
11 },
12 "description": "string",
13 "unitOfMeasure": {
14 "id": 0,
15 "displayId": "string",
16 "status": "CREATED",
17 "name": "string",
18 "erpSystemId": 0
19 },
20 "quantity": 0,
21 "unitPrice": 0,
22 "taxJurisdiction": {
23 "id": 0,
24 "displayId": "string",
25 "status": "CREATED",
26 "name": "string",
27 "erpSystemId": 0,
28 "schema": "string",
29 "countryDisplayId": "string"
30 },
31 "taxCode": {
32 "id": 0,
33 "displayId": "string",
34 "status": "CREATED",
35 "name": "string",
36 "erpSystemId": 0
37 },
38 "taxExpenseAccount": {
39 "id": 0,
40 "displayId": "string",
41 "generalLedgerAccountName": "string",
42 "generalLedgerAccountCode": "string",
43 "openItemManagement": true,
44 "accountCategory": "BALANCESHEET",
45 "shortName": "string",
46 "longName": "string"
47 },
48 "taxLineItems": [
49 {
50 "id": 0,
51 "taxRate": 0.1,
52 "taxAmount": 0,
53 "taxType": "string",
54 "invoiceLineItemId": 0
55 }
56 ],
57 "workBreakdownStructure": {
58 "id": 0,
59 "displayId": "string",
60 "status": "CREATED",
61 "name": "string",
62 "erpSystemId": 0
63 },
64 "costCenter": {
65 "id": 0,
66 "displayId": "string",
67 "status": "CREATED",
68 "name": "string",
69 "erpSystemId": 0
70 },
71 "profitCenter": {
72 "id": 0,
73 "displayId": "string",
74 "status": "CREATED",
75 "name": "string",
76 "validTo": "2019-08-24",
77 "erpSystemId": 0,
78 "erpSystemDisplayId": "string"
79 },
80 "functionalArea": {
81 "id": 0,
82 "displayId": "string",
83 "status": "CREATED",
84 "name": "string",
85 "erpSystemId": 0
86 },
87 "businessArea": {
88 "id": 0,
89 "displayId": "string",
90 "status": "CREATED",
91 "name": "string",
92 "erpSystemId": 0
93 },
94 "segment": {
95 "id": 0,
96 "displayId": "string",
97 "status": "CREATED",
98 "name": "string",
99 "erpSystemId": 0
100 },
101 "network": {
102 "id": 0,
103 "displayId": "string",
104 "status": "CREATED",
105 "name": "string",
106 "erpSystemId": 0
107 },
108 "internalOrderType": {
109 "id": 0,
110 "displayId": "string",
111 "status": "CREATED",
112 "name": "string",
113 "erpSystemId": 0
114 },
115 "internalOrder": {
116 "id": 0,
117 "displayId": "string",
118 "status": "CREATED",
119 "name": "string",
120 "erpSystemId": 0,
121 "internalOrderTypeId": 0
122 },
123 "additionalCurrencies": [
124 {
125 "id": 0,
126 "amount": 0,
127 "currency": {
128 "id": 0,
129 "displayId": "string",
130 "status": "CREATED",
131 "name": "string",
132 "decimalPoints": 0
133 },
134 "conversionRate": 0,
135 "conversionDate": "2019-08-24",
136 "translationDateType": "DOCUMENT_DATE",
137 "amountType": "NET_AMOUNT",
138 "currencyDefinitionType": "CONTRACT_CURRENCY",
139 "invoiceEntryId": 0,
140 "invoiceEntryDisplayId": "string"
141 }
142 ],
143 "scheduledPaymentMatches": [
144 {
145 "id": 0,
146 "fromId": 0,
147 "toId": 0,
148 "amount": 0
149 }
150 ],
151 "goodsReceiptLineItemLinks": [
152 {
153 "id": 0,
154 "fromId": 0,
155 "toId": 0,
156 "linkedQuantity": 0
157 }
158 ],
159 "invoiceId": 0,
160 "invoiceDisplayId": "string",
161 "invoiceState": "INV_DRAFT",
162 "vendorPaymentId": 0,
163 "purchaseOrderLineItemId": 0,
164 "netAmount": 0,
165 "allowsSystemGenerateNewId": true,
166 "numberRangeIdentifierValue": "string",
167 "numberRangeIdentifierType": {
168 "name": "string"
169 },
170 "numberRangeType": {
171 "name": "string"
172 }
173 }
174]
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 "expenseCategory": {
19 "id": 0,
20 "displayId": "string",
21 "status": "CREATED",
22 "name": "string",
23 "expenseCategoryType": "PAYMENT"
24 },
25 "description": "string",
26 "unitOfMeasure": {
27 "id": 0,
28 "displayId": "string",
29 "status": "CREATED",
30 "name": "string",
31 "erpSystemId": 0
32 },
33 "quantity": 0,
34 "unitPrice": 0,
35 "taxJurisdiction": {
36 "id": 0,
37 "displayId": "string",
38 "status": "CREATED",
39 "name": "string",
40 "erpSystemId": 0,
41 "schema": "string",
42 "countryDisplayId": "string"
43 },
44 "taxCode": {
45 "id": 0,
46 "displayId": "string",
47 "status": "CREATED",
48 "name": "string",
49 "erpSystemId": 0
50 },
51 "taxExpenseAccount": {
52 "id": 0,
53 "displayId": "string",
54 "generalLedgerAccountName": "string",
55 "generalLedgerAccountCode": "string",
56 "openItemManagement": true,
57 "accountCategory": "BALANCESHEET",
58 "shortName": "string",
59 "longName": "string"
60 },
61 "taxLineItems": [
62 {
63 "id": 0,
64 "taxRate": 0.1,
65 "taxAmount": 0,
66 "taxType": "string",
67 "invoiceLineItemId": 0
68 }
69 ],
70 "workBreakdownStructure": {
71 "id": 0,
72 "displayId": "string",
73 "status": "CREATED",
74 "name": "string",
75 "erpSystemId": 0
76 },
77 "costCenter": {
78 "id": 0,
79 "displayId": "string",
80 "status": "CREATED",
81 "name": "string",
82 "erpSystemId": 0
83 },
84 "profitCenter": {
85 "id": 0,
86 "displayId": "string",
87 "status": "CREATED",
88 "name": "string",
89 "validTo": "2019-08-24",
90 "erpSystemId": 0,
91 "erpSystemDisplayId": "string"
92 },
93 "functionalArea": {
94 "id": 0,
95 "displayId": "string",
96 "status": "CREATED",
97 "name": "string",
98 "erpSystemId": 0
99 },
100 "businessArea": {
101 "id": 0,
102 "displayId": "string",
103 "status": "CREATED",
104 "name": "string",
105 "erpSystemId": 0
106 },
107 "segment": {
108 "id": 0,
109 "displayId": "string",
110 "status": "CREATED",
111 "name": "string",
112 "erpSystemId": 0
113 },
114 "network": {
115 "id": 0,
116 "displayId": "string",
117 "status": "CREATED",
118 "name": "string",
119 "erpSystemId": 0
120 },
121 "internalOrderType": {
122 "id": 0,
123 "displayId": "string",
124 "status": "CREATED",
125 "name": "string",
126 "erpSystemId": 0
127 },
128 "internalOrder": {
129 "id": 0,
130 "displayId": "string",
131 "status": "CREATED",
132 "name": "string",
133 "erpSystemId": 0,
134 "internalOrderTypeId": 0
135 },
136 "additionalCurrencies": [
137 {
138 "id": 0,
139 "amount": 0,
140 "currency": {
141 "id": 0,
142 "displayId": "string",
143 "status": "CREATED",
144 "name": "string",
145 "decimalPoints": 0
146 },
147 "conversionRate": 0,
148 "conversionDate": "2019-08-24",
149 "translationDateType": "DOCUMENT_DATE",
150 "amountType": "NET_AMOUNT",
151 "currencyDefinitionType": "CONTRACT_CURRENCY",
152 "invoiceEntryId": 0,
153 "invoiceEntryDisplayId": "string"
154 }
155 ],
156 "scheduledPaymentMatches": [
157 {
158 "id": 0,
159 "fromId": 0,
160 "toId": 0,
161 "amount": 0
162 }
163 ],
164 "goodsReceiptLineItemLinks": [
165 {
166 "id": 0,
167 "fromId": 0,
168 "toId": 0,
169 "linkedQuantity": 0
170 }
171 ],
172 "invoiceId": 0,
173 "invoiceDisplayId": "string",
174 "invoiceState": "INV_DRAFT",
175 "vendorPaymentId": 0,
176 "purchaseOrderLineItemId": 0,
177 "netAmount": 0,
178 "allowsSystemGenerateNewId": true,
179 "numberRangeIdentifierValue": "string",
180 "numberRangeIdentifierType": {
181 "name": "string"
182 },
183 "numberRangeType": {
184 "name": "string"
185 }
186 }
187 ]
188}
Bulk-Create Resources¶
HTTP Request
POST /api/v1/invoice-line-item/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 invoice line items, each including details such as product ID, quantity, and pricing information for bulk processing. |
Body Parameters
1[
2 {
3 "id": 0,
4 "displayId": "string",
5 "expenseCategory": {
6 "id": 0,
7 "displayId": "string",
8 "status": "CREATED",
9 "name": "string",
10 "expenseCategoryType": "PAYMENT"
11 },
12 "description": "string",
13 "unitOfMeasure": {
14 "id": 0,
15 "displayId": "string",
16 "status": "CREATED",
17 "name": "string",
18 "erpSystemId": 0
19 },
20 "quantity": 0,
21 "unitPrice": 0,
22 "taxJurisdiction": {
23 "id": 0,
24 "displayId": "string",
25 "status": "CREATED",
26 "name": "string",
27 "erpSystemId": 0,
28 "schema": "string",
29 "countryDisplayId": "string"
30 },
31 "taxCode": {
32 "id": 0,
33 "displayId": "string",
34 "status": "CREATED",
35 "name": "string",
36 "erpSystemId": 0
37 },
38 "taxExpenseAccount": {
39 "id": 0,
40 "displayId": "string",
41 "generalLedgerAccountName": "string",
42 "generalLedgerAccountCode": "string",
43 "openItemManagement": true,
44 "accountCategory": "BALANCESHEET",
45 "shortName": "string",
46 "longName": "string"
47 },
48 "taxLineItems": [
49 {
50 "id": 0,
51 "taxRate": 0.1,
52 "taxAmount": 0,
53 "taxType": "string",
54 "invoiceLineItemId": 0
55 }
56 ],
57 "workBreakdownStructure": {
58 "id": 0,
59 "displayId": "string",
60 "status": "CREATED",
61 "name": "string",
62 "erpSystemId": 0
63 },
64 "costCenter": {
65 "id": 0,
66 "displayId": "string",
67 "status": "CREATED",
68 "name": "string",
69 "erpSystemId": 0
70 },
71 "profitCenter": {
72 "id": 0,
73 "displayId": "string",
74 "status": "CREATED",
75 "name": "string",
76 "validTo": "2019-08-24",
77 "erpSystemId": 0,
78 "erpSystemDisplayId": "string"
79 },
80 "functionalArea": {
81 "id": 0,
82 "displayId": "string",
83 "status": "CREATED",
84 "name": "string",
85 "erpSystemId": 0
86 },
87 "businessArea": {
88 "id": 0,
89 "displayId": "string",
90 "status": "CREATED",
91 "name": "string",
92 "erpSystemId": 0
93 },
94 "segment": {
95 "id": 0,
96 "displayId": "string",
97 "status": "CREATED",
98 "name": "string",
99 "erpSystemId": 0
100 },
101 "network": {
102 "id": 0,
103 "displayId": "string",
104 "status": "CREATED",
105 "name": "string",
106 "erpSystemId": 0
107 },
108 "internalOrderType": {
109 "id": 0,
110 "displayId": "string",
111 "status": "CREATED",
112 "name": "string",
113 "erpSystemId": 0
114 },
115 "internalOrder": {
116 "id": 0,
117 "displayId": "string",
118 "status": "CREATED",
119 "name": "string",
120 "erpSystemId": 0,
121 "internalOrderTypeId": 0
122 },
123 "additionalCurrencies": [
124 {
125 "id": 0,
126 "amount": 0,
127 "currency": {
128 "id": 0,
129 "displayId": "string",
130 "status": "CREATED",
131 "name": "string",
132 "decimalPoints": 0
133 },
134 "conversionRate": 0,
135 "conversionDate": "2019-08-24",
136 "translationDateType": "DOCUMENT_DATE",
137 "amountType": "NET_AMOUNT",
138 "currencyDefinitionType": "CONTRACT_CURRENCY",
139 "invoiceEntryId": 0,
140 "invoiceEntryDisplayId": "string"
141 }
142 ],
143 "scheduledPaymentMatches": [
144 {
145 "id": 0,
146 "fromId": 0,
147 "toId": 0,
148 "amount": 0
149 }
150 ],
151 "goodsReceiptLineItemLinks": [
152 {
153 "id": 0,
154 "fromId": 0,
155 "toId": 0,
156 "linkedQuantity": 0
157 }
158 ],
159 "invoiceId": 0,
160 "invoiceDisplayId": "string",
161 "invoiceState": "INV_DRAFT",
162 "vendorPaymentId": 0,
163 "purchaseOrderLineItemId": 0,
164 "netAmount": 0,
165 "allowsSystemGenerateNewId": true,
166 "numberRangeIdentifierValue": "string",
167 "numberRangeIdentifierType": {
168 "name": "string"
169 },
170 "numberRangeType": {
171 "name": "string"
172 }
173 }
174]
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 "expenseCategory": {
19 "id": 0,
20 "displayId": "string",
21 "status": "CREATED",
22 "name": "string",
23 "expenseCategoryType": "PAYMENT"
24 },
25 "description": "string",
26 "unitOfMeasure": {
27 "id": 0,
28 "displayId": "string",
29 "status": "CREATED",
30 "name": "string",
31 "erpSystemId": 0
32 },
33 "quantity": 0,
34 "unitPrice": 0,
35 "taxJurisdiction": {
36 "id": 0,
37 "displayId": "string",
38 "status": "CREATED",
39 "name": "string",
40 "erpSystemId": 0,
41 "schema": "string",
42 "countryDisplayId": "string"
43 },
44 "taxCode": {
45 "id": 0,
46 "displayId": "string",
47 "status": "CREATED",
48 "name": "string",
49 "erpSystemId": 0
50 },
51 "taxExpenseAccount": {
52 "id": 0,
53 "displayId": "string",
54 "generalLedgerAccountName": "string",
55 "generalLedgerAccountCode": "string",
56 "openItemManagement": true,
57 "accountCategory": "BALANCESHEET",
58 "shortName": "string",
59 "longName": "string"
60 },
61 "taxLineItems": [
62 {
63 "id": 0,
64 "taxRate": 0.1,
65 "taxAmount": 0,
66 "taxType": "string",
67 "invoiceLineItemId": 0
68 }
69 ],
70 "workBreakdownStructure": {
71 "id": 0,
72 "displayId": "string",
73 "status": "CREATED",
74 "name": "string",
75 "erpSystemId": 0
76 },
77 "costCenter": {
78 "id": 0,
79 "displayId": "string",
80 "status": "CREATED",
81 "name": "string",
82 "erpSystemId": 0
83 },
84 "profitCenter": {
85 "id": 0,
86 "displayId": "string",
87 "status": "CREATED",
88 "name": "string",
89 "validTo": "2019-08-24",
90 "erpSystemId": 0,
91 "erpSystemDisplayId": "string"
92 },
93 "functionalArea": {
94 "id": 0,
95 "displayId": "string",
96 "status": "CREATED",
97 "name": "string",
98 "erpSystemId": 0
99 },
100 "businessArea": {
101 "id": 0,
102 "displayId": "string",
103 "status": "CREATED",
104 "name": "string",
105 "erpSystemId": 0
106 },
107 "segment": {
108 "id": 0,
109 "displayId": "string",
110 "status": "CREATED",
111 "name": "string",
112 "erpSystemId": 0
113 },
114 "network": {
115 "id": 0,
116 "displayId": "string",
117 "status": "CREATED",
118 "name": "string",
119 "erpSystemId": 0
120 },
121 "internalOrderType": {
122 "id": 0,
123 "displayId": "string",
124 "status": "CREATED",
125 "name": "string",
126 "erpSystemId": 0
127 },
128 "internalOrder": {
129 "id": 0,
130 "displayId": "string",
131 "status": "CREATED",
132 "name": "string",
133 "erpSystemId": 0,
134 "internalOrderTypeId": 0
135 },
136 "additionalCurrencies": [
137 {
138 "id": 0,
139 "amount": 0,
140 "currency": {
141 "id": 0,
142 "displayId": "string",
143 "status": "CREATED",
144 "name": "string",
145 "decimalPoints": 0
146 },
147 "conversionRate": 0,
148 "conversionDate": "2019-08-24",
149 "translationDateType": "DOCUMENT_DATE",
150 "amountType": "NET_AMOUNT",
151 "currencyDefinitionType": "CONTRACT_CURRENCY",
152 "invoiceEntryId": 0,
153 "invoiceEntryDisplayId": "string"
154 }
155 ],
156 "scheduledPaymentMatches": [
157 {
158 "id": 0,
159 "fromId": 0,
160 "toId": 0,
161 "amount": 0
162 }
163 ],
164 "goodsReceiptLineItemLinks": [
165 {
166 "id": 0,
167 "fromId": 0,
168 "toId": 0,
169 "linkedQuantity": 0
170 }
171 ],
172 "invoiceId": 0,
173 "invoiceDisplayId": "string",
174 "invoiceState": "INV_DRAFT",
175 "vendorPaymentId": 0,
176 "purchaseOrderLineItemId": 0,
177 "netAmount": 0,
178 "allowsSystemGenerateNewId": true,
179 "numberRangeIdentifierValue": "string",
180 "numberRangeIdentifierType": {
181 "name": "string"
182 },
183 "numberRangeType": {
184 "name": "string"
185 }
186 }
187 ]
188}
Bulk-Delete Resources¶
HTTP Request
DELETE /api/v1/invoice-line-item/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 invoice line item identifiers to facilitate bulk deletion of specified items from the invoice records. |
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}
List All Resources¶
HTTP Request
GET /api/v1/invoice-line-item
📋 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 should be returned in a paginated format, allowing for efficient retrieval of invoice line items. |
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 "expenseCategory": {
23 "id": 0,
24 "displayId": "string",
25 "status": "CREATED",
26 "name": "string",
27 "expenseCategoryType": "PAYMENT"
28 },
29 "description": "string",
30 "unitOfMeasure": {
31 "id": 0,
32 "displayId": "string",
33 "status": "CREATED",
34 "name": "string",
35 "erpSystemId": 0
36 },
37 "quantity": 0,
38 "unitPrice": 0,
39 "taxJurisdiction": {
40 "id": 0,
41 "displayId": "string",
42 "status": "CREATED",
43 "name": "string",
44 "erpSystemId": 0,
45 "schema": "string",
46 "countryDisplayId": "string"
47 },
48 "taxCode": {
49 "id": 0,
50 "displayId": "string",
51 "status": "CREATED",
52 "name": "string",
53 "erpSystemId": 0
54 },
55 "taxExpenseAccount": {
56 "id": 0,
57 "displayId": "string",
58 "generalLedgerAccountName": "string",
59 "generalLedgerAccountCode": "string",
60 "openItemManagement": true,
61 "accountCategory": "BALANCESHEET",
62 "shortName": "string",
63 "longName": "string"
64 },
65 "taxLineItems": [
66 {
67 "id": 0,
68 "taxRate": 0.1,
69 "taxAmount": 0,
70 "taxType": "string",
71 "invoiceLineItemId": 0
72 }
73 ],
74 "workBreakdownStructure": {
75 "id": 0,
76 "displayId": "string",
77 "status": "CREATED",
78 "name": "string",
79 "erpSystemId": 0
80 },
81 "costCenter": {
82 "id": 0,
83 "displayId": "string",
84 "status": "CREATED",
85 "name": "string",
86 "erpSystemId": 0
87 },
88 "profitCenter": {
89 "id": 0,
90 "displayId": "string",
91 "status": "CREATED",
92 "name": "string",
93 "validTo": "2019-08-24",
94 "erpSystemId": 0,
95 "erpSystemDisplayId": "string"
96 },
97 "functionalArea": {
98 "id": 0,
99 "displayId": "string",
100 "status": "CREATED",
101 "name": "string",
102 "erpSystemId": 0
103 },
104 "businessArea": {
105 "id": 0,
106 "displayId": "string",
107 "status": "CREATED",
108 "name": "string",
109 "erpSystemId": 0
110 },
111 "segment": {
112 "id": 0,
113 "displayId": "string",
114 "status": "CREATED",
115 "name": "string",
116 "erpSystemId": 0
117 },
118 "network": {
119 "id": 0,
120 "displayId": "string",
121 "status": "CREATED",
122 "name": "string",
123 "erpSystemId": 0
124 },
125 "internalOrderType": {
126 "id": 0,
127 "displayId": "string",
128 "status": "CREATED",
129 "name": "string",
130 "erpSystemId": 0
131 },
132 "internalOrder": {
133 "id": 0,
134 "displayId": "string",
135 "status": "CREATED",
136 "name": "string",
137 "erpSystemId": 0,
138 "internalOrderTypeId": 0
139 },
140 "additionalCurrencies": [
141 {
142 "id": 0,
143 "amount": 0,
144 "currency": {
145 "id": 0,
146 "displayId": "string",
147 "status": "CREATED",
148 "name": "string",
149 "decimalPoints": 0
150 },
151 "conversionRate": 0,
152 "conversionDate": "2019-08-24",
153 "translationDateType": "DOCUMENT_DATE",
154 "amountType": "NET_AMOUNT",
155 "currencyDefinitionType": "CONTRACT_CURRENCY",
156 "invoiceEntryId": 0,
157 "invoiceEntryDisplayId": "string"
158 }
159 ],
160 "scheduledPaymentMatches": [
161 {
162 "id": 0,
163 "fromId": 0,
164 "toId": 0,
165 "amount": 0
166 }
167 ],
168 "goodsReceiptLineItemLinks": [
169 {
170 "id": 0,
171 "fromId": 0,
172 "toId": 0,
173 "linkedQuantity": 0
174 }
175 ],
176 "invoiceId": 0,
177 "invoiceDisplayId": "string",
178 "invoiceState": "INV_DRAFT",
179 "vendorPaymentId": 0,
180 "purchaseOrderLineItemId": 0,
181 "netAmount": 0,
182 "allowsSystemGenerateNewId": true,
183 "numberRangeIdentifierValue": "string",
184 "numberRangeIdentifierType": {
185 "name": "string"
186 },
187 "numberRangeType": {
188 "name": "string"
189 }
190 }
191 ],
192 "number": 0,
193 "sort": {
194 "unsorted": true,
195 "sorted": true,
196 "empty": true
197 },
198 "first": true,
199 "last": true,
200 "empty": true
201}
Create A Resource¶
HTTP Request
POST /api/v1/invoice-line-item
📋 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 details of the invoice line item, including item description, quantity, unit price, and applicable tax information for accurate billing. |
Body Parameters
1{
2 "id": 0,
3 "displayId": "string",
4 "expenseCategory": {
5 "id": 0,
6 "displayId": "string",
7 "status": "CREATED",
8 "name": "string",
9 "expenseCategoryType": "PAYMENT"
10 },
11 "description": "string",
12 "unitOfMeasure": {
13 "id": 0,
14 "displayId": "string",
15 "status": "CREATED",
16 "name": "string",
17 "erpSystemId": 0
18 },
19 "quantity": 0,
20 "unitPrice": 0,
21 "taxJurisdiction": {
22 "id": 0,
23 "displayId": "string",
24 "status": "CREATED",
25 "name": "string",
26 "erpSystemId": 0,
27 "schema": "string",
28 "countryDisplayId": "string"
29 },
30 "taxCode": {
31 "id": 0,
32 "displayId": "string",
33 "status": "CREATED",
34 "name": "string",
35 "erpSystemId": 0
36 },
37 "taxExpenseAccount": {
38 "id": 0,
39 "displayId": "string",
40 "generalLedgerAccountName": "string",
41 "generalLedgerAccountCode": "string",
42 "openItemManagement": true,
43 "accountCategory": "BALANCESHEET",
44 "shortName": "string",
45 "longName": "string"
46 },
47 "taxLineItems": [
48 {
49 "id": 0,
50 "taxRate": 0.1,
51 "taxAmount": 0,
52 "taxType": "string",
53 "invoiceLineItemId": 0
54 }
55 ],
56 "workBreakdownStructure": {
57 "id": 0,
58 "displayId": "string",
59 "status": "CREATED",
60 "name": "string",
61 "erpSystemId": 0
62 },
63 "costCenter": {
64 "id": 0,
65 "displayId": "string",
66 "status": "CREATED",
67 "name": "string",
68 "erpSystemId": 0
69 },
70 "profitCenter": {
71 "id": 0,
72 "displayId": "string",
73 "status": "CREATED",
74 "name": "string",
75 "validTo": "2019-08-24",
76 "erpSystemId": 0,
77 "erpSystemDisplayId": "string"
78 },
79 "functionalArea": {
80 "id": 0,
81 "displayId": "string",
82 "status": "CREATED",
83 "name": "string",
84 "erpSystemId": 0
85 },
86 "businessArea": {
87 "id": 0,
88 "displayId": "string",
89 "status": "CREATED",
90 "name": "string",
91 "erpSystemId": 0
92 },
93 "segment": {
94 "id": 0,
95 "displayId": "string",
96 "status": "CREATED",
97 "name": "string",
98 "erpSystemId": 0
99 },
100 "network": {
101 "id": 0,
102 "displayId": "string",
103 "status": "CREATED",
104 "name": "string",
105 "erpSystemId": 0
106 },
107 "internalOrderType": {
108 "id": 0,
109 "displayId": "string",
110 "status": "CREATED",
111 "name": "string",
112 "erpSystemId": 0
113 },
114 "internalOrder": {
115 "id": 0,
116 "displayId": "string",
117 "status": "CREATED",
118 "name": "string",
119 "erpSystemId": 0,
120 "internalOrderTypeId": 0
121 },
122 "additionalCurrencies": [
123 {
124 "id": 0,
125 "amount": 0,
126 "currency": {
127 "id": 0,
128 "displayId": "string",
129 "status": "CREATED",
130 "name": "string",
131 "decimalPoints": 0
132 },
133 "conversionRate": 0,
134 "conversionDate": "2019-08-24",
135 "translationDateType": "DOCUMENT_DATE",
136 "amountType": "NET_AMOUNT",
137 "currencyDefinitionType": "CONTRACT_CURRENCY",
138 "invoiceEntryId": 0,
139 "invoiceEntryDisplayId": "string"
140 }
141 ],
142 "scheduledPaymentMatches": [
143 {
144 "id": 0,
145 "fromId": 0,
146 "toId": 0,
147 "amount": 0
148 }
149 ],
150 "goodsReceiptLineItemLinks": [
151 {
152 "id": 0,
153 "fromId": 0,
154 "toId": 0,
155 "linkedQuantity": 0
156 }
157 ],
158 "invoiceId": 0,
159 "invoiceDisplayId": "string",
160 "invoiceState": "INV_DRAFT",
161 "vendorPaymentId": 0,
162 "purchaseOrderLineItemId": 0,
163 "netAmount": 0,
164 "allowsSystemGenerateNewId": true,
165 "numberRangeIdentifierValue": "string",
166 "numberRangeIdentifierType": {
167 "name": "string"
168 },
169 "numberRangeType": {
170 "name": "string"
171 }
172}
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 "expenseCategory": {
18 "id": 0,
19 "displayId": "string",
20 "status": "CREATED",
21 "name": "string",
22 "expenseCategoryType": "PAYMENT"
23 },
24 "description": "string",
25 "unitOfMeasure": {
26 "id": 0,
27 "displayId": "string",
28 "status": "CREATED",
29 "name": "string",
30 "erpSystemId": 0
31 },
32 "quantity": 0,
33 "unitPrice": 0,
34 "taxJurisdiction": {
35 "id": 0,
36 "displayId": "string",
37 "status": "CREATED",
38 "name": "string",
39 "erpSystemId": 0,
40 "schema": "string",
41 "countryDisplayId": "string"
42 },
43 "taxCode": {
44 "id": 0,
45 "displayId": "string",
46 "status": "CREATED",
47 "name": "string",
48 "erpSystemId": 0
49 },
50 "taxExpenseAccount": {
51 "id": 0,
52 "displayId": "string",
53 "generalLedgerAccountName": "string",
54 "generalLedgerAccountCode": "string",
55 "openItemManagement": true,
56 "accountCategory": "BALANCESHEET",
57 "shortName": "string",
58 "longName": "string"
59 },
60 "taxLineItems": [
61 {
62 "id": 0,
63 "taxRate": 0.1,
64 "taxAmount": 0,
65 "taxType": "string",
66 "invoiceLineItemId": 0
67 }
68 ],
69 "workBreakdownStructure": {
70 "id": 0,
71 "displayId": "string",
72 "status": "CREATED",
73 "name": "string",
74 "erpSystemId": 0
75 },
76 "costCenter": {
77 "id": 0,
78 "displayId": "string",
79 "status": "CREATED",
80 "name": "string",
81 "erpSystemId": 0
82 },
83 "profitCenter": {
84 "id": 0,
85 "displayId": "string",
86 "status": "CREATED",
87 "name": "string",
88 "validTo": "2019-08-24",
89 "erpSystemId": 0,
90 "erpSystemDisplayId": "string"
91 },
92 "functionalArea": {
93 "id": 0,
94 "displayId": "string",
95 "status": "CREATED",
96 "name": "string",
97 "erpSystemId": 0
98 },
99 "businessArea": {
100 "id": 0,
101 "displayId": "string",
102 "status": "CREATED",
103 "name": "string",
104 "erpSystemId": 0
105 },
106 "segment": {
107 "id": 0,
108 "displayId": "string",
109 "status": "CREATED",
110 "name": "string",
111 "erpSystemId": 0
112 },
113 "network": {
114 "id": 0,
115 "displayId": "string",
116 "status": "CREATED",
117 "name": "string",
118 "erpSystemId": 0
119 },
120 "internalOrderType": {
121 "id": 0,
122 "displayId": "string",
123 "status": "CREATED",
124 "name": "string",
125 "erpSystemId": 0
126 },
127 "internalOrder": {
128 "id": 0,
129 "displayId": "string",
130 "status": "CREATED",
131 "name": "string",
132 "erpSystemId": 0,
133 "internalOrderTypeId": 0
134 },
135 "additionalCurrencies": [
136 {
137 "id": 0,
138 "amount": 0,
139 "currency": {
140 "id": 0,
141 "displayId": "string",
142 "status": "CREATED",
143 "name": "string",
144 "decimalPoints": 0
145 },
146 "conversionRate": 0,
147 "conversionDate": "2019-08-24",
148 "translationDateType": "DOCUMENT_DATE",
149 "amountType": "NET_AMOUNT",
150 "currencyDefinitionType": "CONTRACT_CURRENCY",
151 "invoiceEntryId": 0,
152 "invoiceEntryDisplayId": "string"
153 }
154 ],
155 "scheduledPaymentMatches": [
156 {
157 "id": 0,
158 "fromId": 0,
159 "toId": 0,
160 "amount": 0
161 }
162 ],
163 "goodsReceiptLineItemLinks": [
164 {
165 "id": 0,
166 "fromId": 0,
167 "toId": 0,
168 "linkedQuantity": 0
169 }
170 ],
171 "invoiceId": 0,
172 "invoiceDisplayId": "string",
173 "invoiceState": "INV_DRAFT",
174 "vendorPaymentId": 0,
175 "purchaseOrderLineItemId": 0,
176 "netAmount": 0,
177 "allowsSystemGenerateNewId": true,
178 "numberRangeIdentifierValue": "string",
179 "numberRangeIdentifierType": {
180 "name": "string"
181 },
182 "numberRangeType": {
183 "name": "string"
184 }
185 }
186}
Search Scheduled Payments Eligible For Matching To A Line Item¶
HTTP Request
POST /api/v1/invoice-line-item/{lineItemId}/search-scheduled-payments-for-matching
📋 Description: Returns a paginated list of cleared scheduled payments (from the general ledger) that are eligible to be matched to the specified invoice line item. Eligibility is determined by vendor, currency, and remaining balance constraints.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
lineItemId |
path |
integer(int64) |
true |
Invoice line item ID |
body |
body |
object |
true |
Request body containing the criteria for searching scheduled payments associated with the specified invoice line item, including relevant identifiers and filters. |
» filter |
body |
false |
Data transfer object representing a request for searching GL payment clearing records, enabling users to efficiently retrieve and analyze financial transactions within the general ledger. |
|
»» requestUniqueId |
body |
string |
true |
Unique identifier for the request unique |
»» companyIds |
body |
[integer] |
false |
An array of unique identifiers representing the companies associated with the payment clearing search request. |
»» vendorId |
body |
integer(int64) |
false |
Unique identifier for the vendor |
»» vendorIds |
body |
[integer] |
false |
List of unique identifiers for vendors associated with the payment clearing request, enabling targeted searches within the GLPaymentClearing framework. |
»» allVendorsSelected |
body |
boolean |
false |
Indicates whether all vendors have been selected for the payment clearing search request. |
»» fiscalYear |
body |
integer(int32) |
false |
Represents the fiscal year for which payment clearing data is being requested, facilitating accurate financial reporting and analysis. |
»» fiscalPeriod |
body |
integer(int32) |
false |
Represents the fiscal period for which payment clearing data is being requested, enabling precise financial reporting and analysis. |
»» fromAmount |
body |
number |
false |
Amount of from |
»» toAmount |
body |
number |
false |
Amount of to |
»» availableAmountFrom |
body |
number |
false |
Specifies the minimum available amount for processing GL payment clearing requests. |
»» availableAmountTo |
body |
number |
false |
Represents the total amount available for allocation in the payment clearing process. |
»» taxAmountFrom |
body |
number |
false |
Specifies the total tax amount applicable to the payment clearing request, facilitating accurate financial reporting and compliance. |
»» taxAmountTo |
body |
number |
false |
Specifies the total tax amount to be applied in the payment clearing process. |
»» totalAmountFrom |
body |
number |
false |
Represents the total amount from which payments are being cleared in the GLPaymentClearingSearchRequest. |
»» totalAmountTo |
body |
number |
false |
Represents the total amount to be cleared in the payment transaction, facilitating accurate financial reconciliation. |
»» fromPaymentDate |
body |
string(date) |
false |
Date of the from payment |
»» toPaymentDate |
body |
string(date) |
false |
Date of the to payment |
»» currencyId |
body |
integer(int64) |
false |
Unique identifier for the currency |
»» postingDateFrom |
body |
string(date) |
false |
Specifies the starting date for filtering payment clearing records in the search request. |
»» postingDateTo |
body |
string(date) |
false |
Specifies the end date for the posting period in the GL payment clearing search request, allowing users to filter results within a defined timeframe. |
»» contractDisplayId |
body |
string |
false |
Unique identifier for the contract display |
»» leaseDisplayId |
body |
string |
false |
Unique identifier for the lease display |
»» tag |
body |
string |
false |
Identifier for categorizing and filtering payment clearing requests within the GLPaymentClearingSearchRequest schema. |
»» ledgerEntryIds |
body |
[integer] |
false |
Array of unique identifiers for ledger entries associated with the GL payment clearing request. |
»» ledgerEntryIdsNotIn |
body |
[integer] |
false |
Filter by excluding multiple values of ledger entry ids |
» pageable |
body |
false |
Data transfer object representing a paginated collection of results, enabling efficient navigation and retrieval of large datasets within the API. This schema supports enhanced user experience by facilitating organized data presentation and management. |
|
»» page |
body |
integer(int32) |
false |
Page number for pagination |
»» size |
body |
integer(int32) |
false |
Number of items per page |
»» sort |
body |
[string] |
false |
Sort order specification |
Parameter Constraints¶
Parameter |
Constraints |
|---|---|
»» page |
Min: 0 |
»» size |
Min: 1 |
Body Parameters
1{
2 "filter": {
3 "requestUniqueId": "string",
4 "companyIds": [
5 0
6 ],
7 "vendorId": 0,
8 "vendorIds": [
9 0
10 ],
11 "allVendorsSelected": true,
12 "fiscalYear": 0,
13 "fiscalPeriod": 0,
14 "fromAmount": 0,
15 "toAmount": 0,
16 "availableAmountFrom": 0,
17 "availableAmountTo": 0,
18 "taxAmountFrom": 0,
19 "taxAmountTo": 0,
20 "totalAmountFrom": 0,
21 "totalAmountTo": 0,
22 "fromPaymentDate": "2019-08-24",
23 "toPaymentDate": "2019-08-24",
24 "currencyId": 0,
25 "postingDateFrom": "2019-08-24",
26 "postingDateTo": "2019-08-24",
27 "contractDisplayId": "string",
28 "leaseDisplayId": "string",
29 "tag": "string",
30 "ledgerEntryIds": [
31 0
32 ],
33 "ledgerEntryIdsNotIn": [
34 0
35 ]
36 },
37 "pageable": {
38 "page": 0,
39 "size": 1,
40 "sort": [
41 "string"
42 ]
43 }
44}
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 "ledgerTransactionId": 0,
21 "postingDate": "2019-08-24",
22 "ledgerEntryId": 0,
23 "entryType": "D",
24 "roundedAmount": 0,
25 "unroundedAmount": 0,
26 "deltaAdjustment": 0,
27 "tag": "string",
28 "company": {
29 "id": 0,
30 "displayId": "string"
31 },
32 "currency": {
33 "id": 0,
34 "displayId": "string",
35 "status": "CREATED",
36 "name": "string",
37 "decimalPoints": 0
38 },
39 "fiscalYear": 0,
40 "fiscalPeriod": 0,
41 "vendor": {
42 "id": 0,
43 "displayId": "string",
44 "status": "CREATED",
45 "name": "string",
46 "erpSystemDisplayId": "string"
47 },
48 "paymentMethod": {
49 "id": 0,
50 "displayId": "string",
51 "status": "CREATED",
52 "name": "string",
53 "type": "string"
54 },
55 "paymentBlock": {
56 "id": 0,
57 "displayId": "string",
58 "status": "CREATED",
59 "name": "string"
60 },
61 "paymentTerm": {
62 "id": 0,
63 "displayId": "string",
64 "status": "CREATED",
65 "name": "string"
66 },
67 "taxRoundedAmount": 0,
68 "taxUnroundedAmount": 0,
69 "taxDeltaAdjustment": 0,
70 "ledgerEntryTaxes": [
71 {
72 "ledgerEntryId": 0,
73 "ledgerEntryTaxId": 0,
74 "conditionKey": "string",
75 "accountingKey": "string",
76 "taxAccount": "string",
77 "taxRoundedAmount": 0,
78 "taxUnroundedAmount": 0,
79 "taxBaseAmount": 0,
80 "deltaAdjustment": 0,
81 "totalTaxDocumentAmount": 0,
82 "taxExempt": 0,
83 "taxAffected": 0,
84 "taxExemptionPercentage": 0,
85 "taxRate": 0.1,
86 "taxJurisdiction": {
87 "id": 0,
88 "displayId": "string"
89 },
90 "taxCode": {
91 "id": 0,
92 "displayId": "string"
93 },
94 "taxDetermination": {
95 "id": 0,
96 "displayId": "string"
97 },
98 "entryType": "D",
99 "ledgerEntryForAdditionalCurrencies": [
100 {
101 "id": 0,
102 "displayId": "string",
103 "entryType": "D",
104 "amount": 0,
105 "unroundedAmount": 0,
106 "deltaAdjustment": 0,
107 "currency": {
108 "id": 0,
109 "displayId": "string"
110 },
111 "currencyDefinitionType": "CONTRACT_CURRENCY",
112 "currencyType": "string",
113 "rate": 0,
114 "conversionDate": "2019-08-24",
115 "translationDateType": "DOCUMENT_DATE",
116 "sourceCurrencyType": "CONTRACT_CURRENCY",
117 "sourceCurrency": {
118 "id": 0,
119 "displayId": "string"
120 },
121 "depreciationArea": {
122 "id": 0,
123 "displayId": "string"
124 },
125 "ledgerEntryId": 0,
126 "ledgerEntryTaxId": 0,
127 "allowsSystemGenerateNewId": true,
128 "numberRangeIdentifierValue": "string",
129 "numberRangeIdentifierType": {
130 "name": "string"
131 },
132 "numberRangeType": {
133 "name": "string"
134 }
135 }
136 ]
137 }
138 ],
139 "contract": {
140 "id": 0,
141 "displayId": "string"
142 },
143 "activeContractRevisionId": 0,
144 "lease": {
145 "id": 0,
146 "displayId": "string"
147 }
148 }
149 ],
150 "number": 0,
151 "sort": {
152 "unsorted": true,
153 "sorted": true,
154 "empty": true
155 },
156 "first": true,
157 "last": true,
158 "empty": true
159}
Unlink Purchase Order Line Items From Invoice Line Items¶
HTTP Request
POST /api/v1/invoice-line-item/unlink-purchase-order-line-items
📋 Description: Removes the association between the specified invoice line items and their purchase order line items. The operation is all-or-nothing: the entire batch is validated upfront and rolled back if any item fails.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the identifiers of invoice line items to be unlinked from their associated purchase order line items, facilitating accurate financial reconciliation. |
Body Parameters
1[
2 {
3 "purchaseOrderLineItemId": 0,
4 "invoiceLineItemId": 0,
5 "quantity": 0,
6 "unitPrice": 0
7 }
8]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
|
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
Example Responses
1[
2 {
3 "id": 0,
4 "displayId": "string",
5 "expenseCategory": {
6 "id": 0,
7 "displayId": "string",
8 "status": "CREATED",
9 "name": "string",
10 "expenseCategoryType": "PAYMENT"
11 },
12 "description": "string",
13 "unitOfMeasure": {
14 "id": 0,
15 "displayId": "string",
16 "status": "CREATED",
17 "name": "string",
18 "erpSystemId": 0
19 },
20 "quantity": 0,
21 "unitPrice": 0,
22 "taxJurisdiction": {
23 "id": 0,
24 "displayId": "string",
25 "status": "CREATED",
26 "name": "string",
27 "erpSystemId": 0,
28 "schema": "string",
29 "countryDisplayId": "string"
30 },
31 "taxCode": {
32 "id": 0,
33 "displayId": "string",
34 "status": "CREATED",
35 "name": "string",
36 "erpSystemId": 0
37 },
38 "taxExpenseAccount": {
39 "id": 0,
40 "displayId": "string",
41 "generalLedgerAccountName": "string",
42 "generalLedgerAccountCode": "string",
43 "openItemManagement": true,
44 "accountCategory": "BALANCESHEET",
45 "shortName": "string",
46 "longName": "string"
47 },
48 "taxLineItems": [
49 {
50 "id": 0,
51 "taxRate": 0.1,
52 "taxAmount": 0,
53 "taxType": "string",
54 "invoiceLineItemId": 0
55 }
56 ],
57 "workBreakdownStructure": {
58 "id": 0,
59 "displayId": "string",
60 "status": "CREATED",
61 "name": "string",
62 "erpSystemId": 0
63 },
64 "costCenter": {
65 "id": 0,
66 "displayId": "string",
67 "status": "CREATED",
68 "name": "string",
69 "erpSystemId": 0
70 },
71 "profitCenter": {
72 "id": 0,
73 "displayId": "string",
74 "status": "CREATED",
75 "name": "string",
76 "validTo": "2019-08-24",
77 "erpSystemId": 0,
78 "erpSystemDisplayId": "string"
79 },
80 "functionalArea": {
81 "id": 0,
82 "displayId": "string",
83 "status": "CREATED",
84 "name": "string",
85 "erpSystemId": 0
86 },
87 "businessArea": {
88 "id": 0,
89 "displayId": "string",
90 "status": "CREATED",
91 "name": "string",
92 "erpSystemId": 0
93 },
94 "segment": {
95 "id": 0,
96 "displayId": "string",
97 "status": "CREATED",
98 "name": "string",
99 "erpSystemId": 0
100 },
101 "network": {
102 "id": 0,
103 "displayId": "string",
104 "status": "CREATED",
105 "name": "string",
106 "erpSystemId": 0
107 },
108 "internalOrderType": {
109 "id": 0,
110 "displayId": "string",
111 "status": "CREATED",
112 "name": "string",
113 "erpSystemId": 0
114 },
115 "internalOrder": {
116 "id": 0,
117 "displayId": "string",
118 "status": "CREATED",
119 "name": "string",
120 "erpSystemId": 0,
121 "internalOrderTypeId": 0
122 },
123 "additionalCurrencies": [
124 {
125 "id": 0,
126 "amount": 0,
127 "currency": {
128 "id": 0,
129 "displayId": "string",
130 "status": "CREATED",
131 "name": "string",
132 "decimalPoints": 0
133 },
134 "conversionRate": 0,
135 "conversionDate": "2019-08-24",
136 "translationDateType": "DOCUMENT_DATE",
137 "amountType": "NET_AMOUNT",
138 "currencyDefinitionType": "CONTRACT_CURRENCY",
139 "invoiceEntryId": 0,
140 "invoiceEntryDisplayId": "string"
141 }
142 ],
143 "scheduledPaymentMatches": [
144 {
145 "id": 0,
146 "fromId": 0,
147 "toId": 0,
148 "amount": 0
149 }
150 ],
151 "goodsReceiptLineItemLinks": [
152 {
153 "id": 0,
154 "fromId": 0,
155 "toId": 0,
156 "linkedQuantity": 0
157 }
158 ],
159 "invoiceId": 0,
160 "invoiceDisplayId": "string",
161 "invoiceState": "INV_DRAFT",
162 "vendorPaymentId": 0,
163 "purchaseOrderLineItemId": 0,
164 "netAmount": 0,
165 "allowsSystemGenerateNewId": true,
166 "numberRangeIdentifierValue": "string",
167 "numberRangeIdentifierType": {
168 "name": "string"
169 },
170 "numberRangeType": {
171 "name": "string"
172 }
173 }
174]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a line item within an invoice, detailing the specific goods or services provided, their quantities, and associated costs, essential for accurate billing and financial reporting.] |
|
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» displayId |
string |
false |
none |
Unique identifier for the display |
» expenseCategory |
false |
none |
Data transfer object representing a simplified categorization of expenses, enabling efficient tracking and reporting of financial allocations within the organization. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
»» expenseCategoryType |
string |
false |
none |
Type of the expense category |
» description |
string |
false |
none |
Description of the resource |
» unitOfMeasure |
false |
none |
Data transfer object representing a simplified unit of measure, utilized for standardizing quantities in various business processes, ensuring consistency and accuracy in reporting and analysis. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
» quantity |
integer(int64) |
false |
none |
Quantity value |
» unitPrice |
number |
false |
none |
The unitPrice field represents the cost per individual item in an invoice line, facilitating accurate billing and financial reporting. |
» taxJurisdiction |
false |
none |
Data transfer object representing a simplified tax jurisdiction, encapsulating key attributes necessary for tax compliance and reporting within various business operations. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
»» schema |
string |
false |
none |
Represents the tax jurisdiction information in a simplified format, facilitating compliance and reporting requirements. |
»» countryDisplayId |
string |
false |
none |
Unique identifier for the country display |
» taxCode |
false |
none |
Data transfer object representing a simplified tax code, designed to facilitate efficient tax calculations and compliance within financial applications. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
» taxExpenseAccount |
false |
none |
Data transfer object representing the general ledger information, including account details, transaction summaries, and financial metrics essential for comprehensive financial reporting and analysis. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» generalLedgerAccountName |
string |
true |
none |
Name of the general ledger account |
»» generalLedgerAccountCode |
string |
true |
none |
Code for the general ledger account |
»» openItemManagement |
boolean |
true |
none |
Indicates whether open item management is enabled for the general ledger, facilitating the tracking and reconciliation of outstanding transactions. |
»» accountCategory |
string |
true |
none |
Category of the account |
»» shortName |
string |
false |
none |
Abbreviated name of the resource |
»» longName |
string |
false |
none |
Name of the long |
» taxLineItems |
false |
none |
An array of tax line items associated with the invoice, detailing the specific tax amounts applied to each line item for accurate financial reporting. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» taxRate |
number(double) |
false |
none |
Rate of tax |
»» taxAmount |
number |
false |
none |
Amount of tax |
»» taxType |
string |
false |
none |
Type of the tax |
»» invoiceLineItemId |
integer(int64) |
false |
none |
Unique identifier for the invoice line item |
» workBreakdownStructure |
false |
none |
Data transfer object representing a simplified version of a work breakdown structure, facilitating project management by outlining tasks, deliverables, and their hierarchical relationships for effective resource allocation and tracking. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
» costCenter |
false |
none |
CostCenterLite is a data transfer object that encapsulates essential information about a cost center, including its identifier and financial attributes, facilitating streamlined budget management and resource allocation within an organization. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
» profitCenter |
false |
none |
Data transfer object representing a profit center, encapsulating key financial metrics and performance indicators essential for effective budget management and strategic decision-making. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
»» validTo |
string(date) |
false |
none |
Date until which the resource is valid |
»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
»» erpSystemDisplayId |
string |
false |
none |
Unique identifier for the erp system display |
» functionalArea |
false |
none |
Data transfer object representing a streamlined overview of a functional area within the organization, including key attributes and identifiers essential for effective resource allocation and operational management. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
» businessArea |
false |
none |
Data transfer object representing a streamlined overview of a business area, including essential attributes for effective resource allocation and strategic planning. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
» segment |
false |
none |
SegmentLite is a streamlined data representation object that encapsulates essential information about market segments, enabling businesses to efficiently analyze and target specific customer groups for enhanced marketing strategies. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
» network |
false |
none |
Data structure representing a streamlined network configuration, designed to facilitate efficient resource allocation and management within enterprise environments. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
» internalOrderType |
false |
none |
Data transfer object representing a simplified internal order type, capturing essential details for order management and processing within the enterprise. This object facilitates streamlined operations by providing key attributes necessary for efficient order handling. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
» internalOrder |
false |
none |
Data transfer object representing a simplified internal order, encapsulating essential order details and status for streamlined processing within the organization’s supply chain management. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
»» internalOrderTypeId |
integer(int64) |
false |
none |
Unique identifier for the internal order type |
» additionalCurrencies |
false |
none |
List of additional currencies applicable to the invoice line item, enabling multi-currency transactions for enhanced financial flexibility. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» amount |
number |
false |
none |
Amount value |
»» currency |
false |
none |
Data transfer object representing a simplified currency model, designed to facilitate seamless currency conversions and transactions within financial applications, enhancing operational efficiency and accuracy in monetary exchanges. |
|
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» displayId |
string |
false |
none |
Unique identifier for the display |
»»» status |
string |
false |
none |
Status of the resource |
»»» name |
string |
false |
none |
Name of the resource |
»»» decimalPoints |
integer(int32) |
false |
none |
Specifies the number of decimal places to be used for currency values, ensuring accurate financial representation in transactions. |
»» conversionRate |
number |
false |
none |
Rate of conversion |
»» conversionDate |
string(date) |
false |
none |
Date of the conversion |
»» translationDateType |
string |
false |
none |
Type of the translation date |
»» amountType |
string |
false |
none |
Type of the amount |
»» currencyDefinitionType |
string |
false |
none |
Type of the currency definition |
»» invoiceEntryId |
integer(int64) |
false |
none |
Unique identifier for the invoice entry |
»» invoiceEntryDisplayId |
string |
false |
none |
Unique identifier for the invoice entry display |
» scheduledPaymentMatches |
false |
none |
An array of scheduled payment matches associated with invoice line items, facilitating the tracking and management of payment allocations. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» fromId |
integer(int64) |
false |
none |
Unique identifier for the from |
»» toId |
integer(int64) |
false |
none |
Unique identifier for the to |
»» amount |
number |
false |
none |
Amount value |
» goodsReceiptLineItemLinks |
false |
none |
An array of links to the associated goods receipt line items for the invoice line item, facilitating streamlined tracking and management of inventory transactions. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» fromId |
integer(int64) |
false |
none |
Unique identifier for the from |
»» toId |
integer(int64) |
false |
none |
Unique identifier for the to |
»» linkedQuantity |
integer(int64) |
false |
none |
Quantity of linked quantity |
» invoiceId |
integer(int64) |
false |
none |
Unique identifier for the invoice |
» invoiceDisplayId |
string |
false |
none |
Unique identifier for the invoice display |
» invoiceState |
string |
false |
none |
Represents the current status of the invoice line item, indicating its processing stage within the invoicing workflow. |
» vendorPaymentId |
integer(int64) |
false |
none |
Unique identifier for the vendor payment |
» purchaseOrderLineItemId |
integer(int64) |
false |
none |
Unique identifier for the purchase order line item |
» netAmount |
number |
false |
none |
Amount of net |
» allowsSystemGenerateNewId |
boolean |
false |
none |
Unique identifier for the allows system generate new |
» numberRangeIdentifierValue |
string |
false |
none |
Represents a unique identifier for the range of invoice line items, facilitating accurate tracking and management of billing details. |
» numberRangeIdentifierType |
false |
none |
Data transfer object representing a numerical range identifier used for categorizing and validating data entries within business processes, ensuring consistency and accuracy in data management. |
|
»» name |
string |
false |
none |
Name of the resource |
» numberRangeType |
false |
none |
Data structure representing a numerical range, utilized for defining limits or thresholds within business processes, ensuring precise data validation and operational efficiency. |
|
»» name |
string |
true |
none |
Name of the resource |
Enumerated Values
Attribute |
Value |
|---|---|
accountCategory |
BALANCESHEET, PROFITANDLOSS |
amountType |
NET_AMOUNT, TAX_AMOUNT |
currencyDefinitionType |
COMPANY_CURRENCY, CONTRACT_CURRENCY, MONTH_END_CURRENCY, REPORTING_CURRENCY, SECOND_LOCAL_CURRENCY, THIRD_LOCAL_CURRENCY |
expenseCategoryType |
CASH_INCENTIVE, CASUALTY, EXPECTED_GRV, INCENTIVE, NON_LEASE, PAYMENT, PURCHASE_OPTION, TERMINATION_OPTION |
invoiceState |
GOODS_RECEIPT_DRAFT, GOODS_RECEIPT_MATCHED, GOODS_RECEIPT_RECEIVED, GOODS_RECEIPT_REJECTED, INVOICE_PAYMENT_DRAFT, INVOICE_PAYMENT_JOURNALS_GENERATING, INVOICE_PAYMENT_POSTED, INVOICE_PAYMENT_POSTING, INVOICE_PAYMENT_REVIEW, INV_APPROVED, INV_DRAFT, INV_GENERATING_JOURNALS, INV_PAID, INV_POSTED, INV_POSTING, INV_REJECTED, INV_REVIEW, INV_WAITING_FOR_APPROVAL, PURCHASE_ORDER_APPROVED, PURCHASE_ORDER_DRAFT, PURCHASE_ORDER_REJECTED, PURCHASE_ORDER_WAITING_FOR_APPROVAL, PURCHASE_REQUISITION_APPROVED, PURCHASE_REQUISITION_DRAFT, PURCHASE_REQUISITION_REJECTED, PURCHASE_REQUISITION_WAITING_FOR_APPROVAL, VENDOR_REQUEST_APPROVED, VENDOR_REQUEST_DRAFT, VENDOR_REQUEST_PENDING_APPROVAL, VENDOR_REQUEST_REJECTED, WORKSPACE_CLOSED, WORKSPACE_JOURNALS_GENERATING, WORKSPACE_OPEN, WORKSPACE_POSTING, WORKSPACE_REVIEW |
status |
ACTIVE, CREATED, DECOMMISSIONED, DISABLED |
translationDateType |
, DOCUMENT_DATE, POSTING_DATE, TRANSLATION_DATE |
Unlink Goods Receipt Line Items From Invoice Line Items¶
HTTP Request
POST /api/v1/invoice-line-item/unlink-goods-receipt-line-items
📋 Description: Removes the association between the specified invoice line items and their goods receipt line items. The operation is all-or-nothing: the entire batch is validated upfront and rolled back if any item fails.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the identifiers of invoice line items and associated goods receipt line items to facilitate their unlinking process. |
Body Parameters
1[
2 {
3 "invoiceLineItemId": 0,
4 "goodsReceiptLineItemIds": [
5 0
6 ]
7 }
8]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
|
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
Example Responses
1[
2 {
3 "id": 0,
4 "displayId": "string",
5 "expenseCategory": {
6 "id": 0,
7 "displayId": "string",
8 "status": "CREATED",
9 "name": "string",
10 "expenseCategoryType": "PAYMENT"
11 },
12 "description": "string",
13 "unitOfMeasure": {
14 "id": 0,
15 "displayId": "string",
16 "status": "CREATED",
17 "name": "string",
18 "erpSystemId": 0
19 },
20 "quantity": 0,
21 "unitPrice": 0,
22 "taxJurisdiction": {
23 "id": 0,
24 "displayId": "string",
25 "status": "CREATED",
26 "name": "string",
27 "erpSystemId": 0,
28 "schema": "string",
29 "countryDisplayId": "string"
30 },
31 "taxCode": {
32 "id": 0,
33 "displayId": "string",
34 "status": "CREATED",
35 "name": "string",
36 "erpSystemId": 0
37 },
38 "taxExpenseAccount": {
39 "id": 0,
40 "displayId": "string",
41 "generalLedgerAccountName": "string",
42 "generalLedgerAccountCode": "string",
43 "openItemManagement": true,
44 "accountCategory": "BALANCESHEET",
45 "shortName": "string",
46 "longName": "string"
47 },
48 "taxLineItems": [
49 {
50 "id": 0,
51 "taxRate": 0.1,
52 "taxAmount": 0,
53 "taxType": "string",
54 "invoiceLineItemId": 0
55 }
56 ],
57 "workBreakdownStructure": {
58 "id": 0,
59 "displayId": "string",
60 "status": "CREATED",
61 "name": "string",
62 "erpSystemId": 0
63 },
64 "costCenter": {
65 "id": 0,
66 "displayId": "string",
67 "status": "CREATED",
68 "name": "string",
69 "erpSystemId": 0
70 },
71 "profitCenter": {
72 "id": 0,
73 "displayId": "string",
74 "status": "CREATED",
75 "name": "string",
76 "validTo": "2019-08-24",
77 "erpSystemId": 0,
78 "erpSystemDisplayId": "string"
79 },
80 "functionalArea": {
81 "id": 0,
82 "displayId": "string",
83 "status": "CREATED",
84 "name": "string",
85 "erpSystemId": 0
86 },
87 "businessArea": {
88 "id": 0,
89 "displayId": "string",
90 "status": "CREATED",
91 "name": "string",
92 "erpSystemId": 0
93 },
94 "segment": {
95 "id": 0,
96 "displayId": "string",
97 "status": "CREATED",
98 "name": "string",
99 "erpSystemId": 0
100 },
101 "network": {
102 "id": 0,
103 "displayId": "string",
104 "status": "CREATED",
105 "name": "string",
106 "erpSystemId": 0
107 },
108 "internalOrderType": {
109 "id": 0,
110 "displayId": "string",
111 "status": "CREATED",
112 "name": "string",
113 "erpSystemId": 0
114 },
115 "internalOrder": {
116 "id": 0,
117 "displayId": "string",
118 "status": "CREATED",
119 "name": "string",
120 "erpSystemId": 0,
121 "internalOrderTypeId": 0
122 },
123 "additionalCurrencies": [
124 {
125 "id": 0,
126 "amount": 0,
127 "currency": {
128 "id": 0,
129 "displayId": "string",
130 "status": "CREATED",
131 "name": "string",
132 "decimalPoints": 0
133 },
134 "conversionRate": 0,
135 "conversionDate": "2019-08-24",
136 "translationDateType": "DOCUMENT_DATE",
137 "amountType": "NET_AMOUNT",
138 "currencyDefinitionType": "CONTRACT_CURRENCY",
139 "invoiceEntryId": 0,
140 "invoiceEntryDisplayId": "string"
141 }
142 ],
143 "scheduledPaymentMatches": [
144 {
145 "id": 0,
146 "fromId": 0,
147 "toId": 0,
148 "amount": 0
149 }
150 ],
151 "goodsReceiptLineItemLinks": [
152 {
153 "id": 0,
154 "fromId": 0,
155 "toId": 0,
156 "linkedQuantity": 0
157 }
158 ],
159 "invoiceId": 0,
160 "invoiceDisplayId": "string",
161 "invoiceState": "INV_DRAFT",
162 "vendorPaymentId": 0,
163 "purchaseOrderLineItemId": 0,
164 "netAmount": 0,
165 "allowsSystemGenerateNewId": true,
166 "numberRangeIdentifierValue": "string",
167 "numberRangeIdentifierType": {
168 "name": "string"
169 },
170 "numberRangeType": {
171 "name": "string"
172 }
173 }
174]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a line item within an invoice, detailing the specific goods or services provided, their quantities, and associated costs, essential for accurate billing and financial reporting.] |
|
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» displayId |
string |
false |
none |
Unique identifier for the display |
» expenseCategory |
false |
none |
Data transfer object representing a simplified categorization of expenses, enabling efficient tracking and reporting of financial allocations within the organization. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
»» expenseCategoryType |
string |
false |
none |
Type of the expense category |
» description |
string |
false |
none |
Description of the resource |
» unitOfMeasure |
false |
none |
Data transfer object representing a simplified unit of measure, utilized for standardizing quantities in various business processes, ensuring consistency and accuracy in reporting and analysis. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
» quantity |
integer(int64) |
false |
none |
Quantity value |
» unitPrice |
number |
false |
none |
The unitPrice field represents the cost per individual item in an invoice line, facilitating accurate billing and financial reporting. |
» taxJurisdiction |
false |
none |
Data transfer object representing a simplified tax jurisdiction, encapsulating key attributes necessary for tax compliance and reporting within various business operations. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
»» schema |
string |
false |
none |
Represents the tax jurisdiction information in a simplified format, facilitating compliance and reporting requirements. |
»» countryDisplayId |
string |
false |
none |
Unique identifier for the country display |
» taxCode |
false |
none |
Data transfer object representing a simplified tax code, designed to facilitate efficient tax calculations and compliance within financial applications. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
» taxExpenseAccount |
false |
none |
Data transfer object representing the general ledger information, including account details, transaction summaries, and financial metrics essential for comprehensive financial reporting and analysis. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» generalLedgerAccountName |
string |
true |
none |
Name of the general ledger account |
»» generalLedgerAccountCode |
string |
true |
none |
Code for the general ledger account |
»» openItemManagement |
boolean |
true |
none |
Indicates whether open item management is enabled for the general ledger, facilitating the tracking and reconciliation of outstanding transactions. |
»» accountCategory |
string |
true |
none |
Category of the account |
»» shortName |
string |
false |
none |
Abbreviated name of the resource |
»» longName |
string |
false |
none |
Name of the long |
» taxLineItems |
false |
none |
An array of tax line items associated with the invoice, detailing the specific tax amounts applied to each line item for accurate financial reporting. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» taxRate |
number(double) |
false |
none |
Rate of tax |
»» taxAmount |
number |
false |
none |
Amount of tax |
»» taxType |
string |
false |
none |
Type of the tax |
»» invoiceLineItemId |
integer(int64) |
false |
none |
Unique identifier for the invoice line item |
» workBreakdownStructure |
false |
none |
Data transfer object representing a simplified version of a work breakdown structure, facilitating project management by outlining tasks, deliverables, and their hierarchical relationships for effective resource allocation and tracking. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
» costCenter |
false |
none |
CostCenterLite is a data transfer object that encapsulates essential information about a cost center, including its identifier and financial attributes, facilitating streamlined budget management and resource allocation within an organization. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
» profitCenter |
false |
none |
Data transfer object representing a profit center, encapsulating key financial metrics and performance indicators essential for effective budget management and strategic decision-making. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
»» validTo |
string(date) |
false |
none |
Date until which the resource is valid |
»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
»» erpSystemDisplayId |
string |
false |
none |
Unique identifier for the erp system display |
» functionalArea |
false |
none |
Data transfer object representing a streamlined overview of a functional area within the organization, including key attributes and identifiers essential for effective resource allocation and operational management. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
» businessArea |
false |
none |
Data transfer object representing a streamlined overview of a business area, including essential attributes for effective resource allocation and strategic planning. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
» segment |
false |
none |
SegmentLite is a streamlined data representation object that encapsulates essential information about market segments, enabling businesses to efficiently analyze and target specific customer groups for enhanced marketing strategies. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
» network |
false |
none |
Data structure representing a streamlined network configuration, designed to facilitate efficient resource allocation and management within enterprise environments. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
» internalOrderType |
false |
none |
Data transfer object representing a simplified internal order type, capturing essential details for order management and processing within the enterprise. This object facilitates streamlined operations by providing key attributes necessary for efficient order handling. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
» internalOrder |
false |
none |
Data transfer object representing a simplified internal order, encapsulating essential order details and status for streamlined processing within the organization’s supply chain management. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
»» internalOrderTypeId |
integer(int64) |
false |
none |
Unique identifier for the internal order type |
» additionalCurrencies |
false |
none |
List of additional currencies applicable to the invoice line item, enabling multi-currency transactions for enhanced financial flexibility. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» amount |
number |
false |
none |
Amount value |
»» currency |
false |
none |
Data transfer object representing a simplified currency model, designed to facilitate seamless currency conversions and transactions within financial applications, enhancing operational efficiency and accuracy in monetary exchanges. |
|
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» displayId |
string |
false |
none |
Unique identifier for the display |
»»» status |
string |
false |
none |
Status of the resource |
»»» name |
string |
false |
none |
Name of the resource |
»»» decimalPoints |
integer(int32) |
false |
none |
Specifies the number of decimal places to be used for currency values, ensuring accurate financial representation in transactions. |
»» conversionRate |
number |
false |
none |
Rate of conversion |
»» conversionDate |
string(date) |
false |
none |
Date of the conversion |
»» translationDateType |
string |
false |
none |
Type of the translation date |
»» amountType |
string |
false |
none |
Type of the amount |
»» currencyDefinitionType |
string |
false |
none |
Type of the currency definition |
»» invoiceEntryId |
integer(int64) |
false |
none |
Unique identifier for the invoice entry |
»» invoiceEntryDisplayId |
string |
false |
none |
Unique identifier for the invoice entry display |
» scheduledPaymentMatches |
false |
none |
An array of scheduled payment matches associated with invoice line items, facilitating the tracking and management of payment allocations. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» fromId |
integer(int64) |
false |
none |
Unique identifier for the from |
»» toId |
integer(int64) |
false |
none |
Unique identifier for the to |
»» amount |
number |
false |
none |
Amount value |
» goodsReceiptLineItemLinks |
false |
none |
An array of links to the associated goods receipt line items for the invoice line item, facilitating streamlined tracking and management of inventory transactions. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» fromId |
integer(int64) |
false |
none |
Unique identifier for the from |
»» toId |
integer(int64) |
false |
none |
Unique identifier for the to |
»» linkedQuantity |
integer(int64) |
false |
none |
Quantity of linked quantity |
» invoiceId |
integer(int64) |
false |
none |
Unique identifier for the invoice |
» invoiceDisplayId |
string |
false |
none |
Unique identifier for the invoice display |
» invoiceState |
string |
false |
none |
Represents the current status of the invoice line item, indicating its processing stage within the invoicing workflow. |
» vendorPaymentId |
integer(int64) |
false |
none |
Unique identifier for the vendor payment |
» purchaseOrderLineItemId |
integer(int64) |
false |
none |
Unique identifier for the purchase order line item |
» netAmount |
number |
false |
none |
Amount of net |
» allowsSystemGenerateNewId |
boolean |
false |
none |
Unique identifier for the allows system generate new |
» numberRangeIdentifierValue |
string |
false |
none |
Represents a unique identifier for the range of invoice line items, facilitating accurate tracking and management of billing details. |
» numberRangeIdentifierType |
false |
none |
Data transfer object representing a numerical range identifier used for categorizing and validating data entries within business processes, ensuring consistency and accuracy in data management. |
|
»» name |
string |
false |
none |
Name of the resource |
» numberRangeType |
false |
none |
Data structure representing a numerical range, utilized for defining limits or thresholds within business processes, ensuring precise data validation and operational efficiency. |
|
»» name |
string |
true |
none |
Name of the resource |
Enumerated Values
Attribute |
Value |
|---|---|
accountCategory |
BALANCESHEET, PROFITANDLOSS |
amountType |
NET_AMOUNT, TAX_AMOUNT |
currencyDefinitionType |
COMPANY_CURRENCY, CONTRACT_CURRENCY, MONTH_END_CURRENCY, REPORTING_CURRENCY, SECOND_LOCAL_CURRENCY, THIRD_LOCAL_CURRENCY |
expenseCategoryType |
CASH_INCENTIVE, CASUALTY, EXPECTED_GRV, INCENTIVE, NON_LEASE, PAYMENT, PURCHASE_OPTION, TERMINATION_OPTION |
invoiceState |
GOODS_RECEIPT_DRAFT, GOODS_RECEIPT_MATCHED, GOODS_RECEIPT_RECEIVED, GOODS_RECEIPT_REJECTED, INVOICE_PAYMENT_DRAFT, INVOICE_PAYMENT_JOURNALS_GENERATING, INVOICE_PAYMENT_POSTED, INVOICE_PAYMENT_POSTING, INVOICE_PAYMENT_REVIEW, INV_APPROVED, INV_DRAFT, INV_GENERATING_JOURNALS, INV_PAID, INV_POSTED, INV_POSTING, INV_REJECTED, INV_REVIEW, INV_WAITING_FOR_APPROVAL, PURCHASE_ORDER_APPROVED, PURCHASE_ORDER_DRAFT, PURCHASE_ORDER_REJECTED, PURCHASE_ORDER_WAITING_FOR_APPROVAL, PURCHASE_REQUISITION_APPROVED, PURCHASE_REQUISITION_DRAFT, PURCHASE_REQUISITION_REJECTED, PURCHASE_REQUISITION_WAITING_FOR_APPROVAL, VENDOR_REQUEST_APPROVED, VENDOR_REQUEST_DRAFT, VENDOR_REQUEST_PENDING_APPROVAL, VENDOR_REQUEST_REJECTED, WORKSPACE_CLOSED, WORKSPACE_JOURNALS_GENERATING, WORKSPACE_OPEN, WORKSPACE_POSTING, WORKSPACE_REVIEW |
status |
ACTIVE, CREATED, DECOMMISSIONED, DISABLED |
translationDateType |
, DOCUMENT_DATE, POSTING_DATE, TRANSLATION_DATE |
Search Resources¶
HTTP Request
POST /api/v1/invoice-line-item/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 invoice line items based on business requirements. |
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 "expenseCategoryIdEqual": 0,
20 "expenseCategoryDisplayIdLike": "string",
21 "descriptionLike": "string",
22 "unitOfMeasureEqual": {
23 "id": 0,
24 "displayId": "string",
25 "status": "CREATED",
26 "name": "string",
27 "erpSystemId": 0
28 },
29 "quantityEqual": 0,
30 "unitPriceEqual": 0,
31 "unitPriceGreaterThanOrEqual": 0,
32 "unitPriceLessThanOrEqual": 0,
33 "costCenterIdEqual": 0,
34 "costCenterDisplayIdLike": "string",
35 "costCenterNameLike": "string",
36 "profitCenterIdEqual": 0,
37 "profitCenterDisplayIdLike": "string",
38 "profitCenterNameLike": "string",
39 "invoiceIdEqual": 0,
40 "invoiceDisplayIdLike": "string",
41 "invoiceStateIn": [
42 "INV_DRAFT"
43 ],
44 "invoiceStateEqual": "INV_DRAFT",
45 "purchaseOrderLineItemIdIn": [
46 0
47 ],
48 "purchaseOrderLineItemIdEqual": 0
49}
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 "expenseCategory": {
23 "id": 0,
24 "displayId": "string",
25 "status": "CREATED",
26 "name": "string",
27 "expenseCategoryType": "PAYMENT"
28 },
29 "description": "string",
30 "unitOfMeasure": {
31 "id": 0,
32 "displayId": "string",
33 "status": "CREATED",
34 "name": "string",
35 "erpSystemId": 0
36 },
37 "quantity": 0,
38 "unitPrice": 0,
39 "taxJurisdiction": {
40 "id": 0,
41 "displayId": "string",
42 "status": "CREATED",
43 "name": "string",
44 "erpSystemId": 0,
45 "schema": "string",
46 "countryDisplayId": "string"
47 },
48 "taxCode": {
49 "id": 0,
50 "displayId": "string",
51 "status": "CREATED",
52 "name": "string",
53 "erpSystemId": 0
54 },
55 "taxExpenseAccount": {
56 "id": 0,
57 "displayId": "string",
58 "generalLedgerAccountName": "string",
59 "generalLedgerAccountCode": "string",
60 "openItemManagement": true,
61 "accountCategory": "BALANCESHEET",
62 "shortName": "string",
63 "longName": "string"
64 },
65 "taxLineItems": [
66 {
67 "id": 0,
68 "taxRate": 0.1,
69 "taxAmount": 0,
70 "taxType": "string",
71 "invoiceLineItemId": 0
72 }
73 ],
74 "workBreakdownStructure": {
75 "id": 0,
76 "displayId": "string",
77 "status": "CREATED",
78 "name": "string",
79 "erpSystemId": 0
80 },
81 "costCenter": {
82 "id": 0,
83 "displayId": "string",
84 "status": "CREATED",
85 "name": "string",
86 "erpSystemId": 0
87 },
88 "profitCenter": {
89 "id": 0,
90 "displayId": "string",
91 "status": "CREATED",
92 "name": "string",
93 "validTo": "2019-08-24",
94 "erpSystemId": 0,
95 "erpSystemDisplayId": "string"
96 },
97 "functionalArea": {
98 "id": 0,
99 "displayId": "string",
100 "status": "CREATED",
101 "name": "string",
102 "erpSystemId": 0
103 },
104 "businessArea": {
105 "id": 0,
106 "displayId": "string",
107 "status": "CREATED",
108 "name": "string",
109 "erpSystemId": 0
110 },
111 "segment": {
112 "id": 0,
113 "displayId": "string",
114 "status": "CREATED",
115 "name": "string",
116 "erpSystemId": 0
117 },
118 "network": {
119 "id": 0,
120 "displayId": "string",
121 "status": "CREATED",
122 "name": "string",
123 "erpSystemId": 0
124 },
125 "internalOrderType": {
126 "id": 0,
127 "displayId": "string",
128 "status": "CREATED",
129 "name": "string",
130 "erpSystemId": 0
131 },
132 "internalOrder": {
133 "id": 0,
134 "displayId": "string",
135 "status": "CREATED",
136 "name": "string",
137 "erpSystemId": 0,
138 "internalOrderTypeId": 0
139 },
140 "additionalCurrencies": [
141 {
142 "id": 0,
143 "amount": 0,
144 "currency": {
145 "id": 0,
146 "displayId": "string",
147 "status": "CREATED",
148 "name": "string",
149 "decimalPoints": 0
150 },
151 "conversionRate": 0,
152 "conversionDate": "2019-08-24",
153 "translationDateType": "DOCUMENT_DATE",
154 "amountType": "NET_AMOUNT",
155 "currencyDefinitionType": "CONTRACT_CURRENCY",
156 "invoiceEntryId": 0,
157 "invoiceEntryDisplayId": "string"
158 }
159 ],
160 "scheduledPaymentMatches": [
161 {
162 "id": 0,
163 "fromId": 0,
164 "toId": 0,
165 "amount": 0
166 }
167 ],
168 "goodsReceiptLineItemLinks": [
169 {
170 "id": 0,
171 "fromId": 0,
172 "toId": 0,
173 "linkedQuantity": 0
174 }
175 ],
176 "invoiceId": 0,
177 "invoiceDisplayId": "string",
178 "invoiceState": "INV_DRAFT",
179 "vendorPaymentId": 0,
180 "purchaseOrderLineItemId": 0,
181 "netAmount": 0,
182 "allowsSystemGenerateNewId": true,
183 "numberRangeIdentifierValue": "string",
184 "numberRangeIdentifierType": {
185 "name": "string"
186 },
187 "numberRangeType": {
188 "name": "string"
189 }
190 }
191 ],
192 "number": 0,
193 "sort": {
194 "unsorted": true,
195 "sorted": true,
196 "empty": true
197 },
198 "first": true,
199 "last": true,
200 "empty": true
201}
Link Purchase Order Line Items To Invoice Line Items¶
HTTP Request
POST /api/v1/invoice-line-item/link-purchase-order-line-items
📋 Description: Associates existing invoice line items with purchase order line items. Copies the quantity and unit price from the PO line item if not already set. The operation is all-or-nothing: the entire batch is validated upfront and rolled back if any item fails.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the invoice line item details and associated purchase order line item identifiers for linking purposes. |
Body Parameters
1[
2 {
3 "purchaseOrderLineItemId": 0,
4 "invoiceLineItemId": 0,
5 "quantity": 0,
6 "unitPrice": 0
7 }
8]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
|
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
Example Responses
1[
2 {
3 "id": 0,
4 "displayId": "string",
5 "expenseCategory": {
6 "id": 0,
7 "displayId": "string",
8 "status": "CREATED",
9 "name": "string",
10 "expenseCategoryType": "PAYMENT"
11 },
12 "description": "string",
13 "unitOfMeasure": {
14 "id": 0,
15 "displayId": "string",
16 "status": "CREATED",
17 "name": "string",
18 "erpSystemId": 0
19 },
20 "quantity": 0,
21 "unitPrice": 0,
22 "taxJurisdiction": {
23 "id": 0,
24 "displayId": "string",
25 "status": "CREATED",
26 "name": "string",
27 "erpSystemId": 0,
28 "schema": "string",
29 "countryDisplayId": "string"
30 },
31 "taxCode": {
32 "id": 0,
33 "displayId": "string",
34 "status": "CREATED",
35 "name": "string",
36 "erpSystemId": 0
37 },
38 "taxExpenseAccount": {
39 "id": 0,
40 "displayId": "string",
41 "generalLedgerAccountName": "string",
42 "generalLedgerAccountCode": "string",
43 "openItemManagement": true,
44 "accountCategory": "BALANCESHEET",
45 "shortName": "string",
46 "longName": "string"
47 },
48 "taxLineItems": [
49 {
50 "id": 0,
51 "taxRate": 0.1,
52 "taxAmount": 0,
53 "taxType": "string",
54 "invoiceLineItemId": 0
55 }
56 ],
57 "workBreakdownStructure": {
58 "id": 0,
59 "displayId": "string",
60 "status": "CREATED",
61 "name": "string",
62 "erpSystemId": 0
63 },
64 "costCenter": {
65 "id": 0,
66 "displayId": "string",
67 "status": "CREATED",
68 "name": "string",
69 "erpSystemId": 0
70 },
71 "profitCenter": {
72 "id": 0,
73 "displayId": "string",
74 "status": "CREATED",
75 "name": "string",
76 "validTo": "2019-08-24",
77 "erpSystemId": 0,
78 "erpSystemDisplayId": "string"
79 },
80 "functionalArea": {
81 "id": 0,
82 "displayId": "string",
83 "status": "CREATED",
84 "name": "string",
85 "erpSystemId": 0
86 },
87 "businessArea": {
88 "id": 0,
89 "displayId": "string",
90 "status": "CREATED",
91 "name": "string",
92 "erpSystemId": 0
93 },
94 "segment": {
95 "id": 0,
96 "displayId": "string",
97 "status": "CREATED",
98 "name": "string",
99 "erpSystemId": 0
100 },
101 "network": {
102 "id": 0,
103 "displayId": "string",
104 "status": "CREATED",
105 "name": "string",
106 "erpSystemId": 0
107 },
108 "internalOrderType": {
109 "id": 0,
110 "displayId": "string",
111 "status": "CREATED",
112 "name": "string",
113 "erpSystemId": 0
114 },
115 "internalOrder": {
116 "id": 0,
117 "displayId": "string",
118 "status": "CREATED",
119 "name": "string",
120 "erpSystemId": 0,
121 "internalOrderTypeId": 0
122 },
123 "additionalCurrencies": [
124 {
125 "id": 0,
126 "amount": 0,
127 "currency": {
128 "id": 0,
129 "displayId": "string",
130 "status": "CREATED",
131 "name": "string",
132 "decimalPoints": 0
133 },
134 "conversionRate": 0,
135 "conversionDate": "2019-08-24",
136 "translationDateType": "DOCUMENT_DATE",
137 "amountType": "NET_AMOUNT",
138 "currencyDefinitionType": "CONTRACT_CURRENCY",
139 "invoiceEntryId": 0,
140 "invoiceEntryDisplayId": "string"
141 }
142 ],
143 "scheduledPaymentMatches": [
144 {
145 "id": 0,
146 "fromId": 0,
147 "toId": 0,
148 "amount": 0
149 }
150 ],
151 "goodsReceiptLineItemLinks": [
152 {
153 "id": 0,
154 "fromId": 0,
155 "toId": 0,
156 "linkedQuantity": 0
157 }
158 ],
159 "invoiceId": 0,
160 "invoiceDisplayId": "string",
161 "invoiceState": "INV_DRAFT",
162 "vendorPaymentId": 0,
163 "purchaseOrderLineItemId": 0,
164 "netAmount": 0,
165 "allowsSystemGenerateNewId": true,
166 "numberRangeIdentifierValue": "string",
167 "numberRangeIdentifierType": {
168 "name": "string"
169 },
170 "numberRangeType": {
171 "name": "string"
172 }
173 }
174]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a line item within an invoice, detailing the specific goods or services provided, their quantities, and associated costs, essential for accurate billing and financial reporting.] |
|
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» displayId |
string |
false |
none |
Unique identifier for the display |
» expenseCategory |
false |
none |
Data transfer object representing a simplified categorization of expenses, enabling efficient tracking and reporting of financial allocations within the organization. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
»» expenseCategoryType |
string |
false |
none |
Type of the expense category |
» description |
string |
false |
none |
Description of the resource |
» unitOfMeasure |
false |
none |
Data transfer object representing a simplified unit of measure, utilized for standardizing quantities in various business processes, ensuring consistency and accuracy in reporting and analysis. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
» quantity |
integer(int64) |
false |
none |
Quantity value |
» unitPrice |
number |
false |
none |
The unitPrice field represents the cost per individual item in an invoice line, facilitating accurate billing and financial reporting. |
» taxJurisdiction |
false |
none |
Data transfer object representing a simplified tax jurisdiction, encapsulating key attributes necessary for tax compliance and reporting within various business operations. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
»» schema |
string |
false |
none |
Represents the tax jurisdiction information in a simplified format, facilitating compliance and reporting requirements. |
»» countryDisplayId |
string |
false |
none |
Unique identifier for the country display |
» taxCode |
false |
none |
Data transfer object representing a simplified tax code, designed to facilitate efficient tax calculations and compliance within financial applications. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
» taxExpenseAccount |
false |
none |
Data transfer object representing the general ledger information, including account details, transaction summaries, and financial metrics essential for comprehensive financial reporting and analysis. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» generalLedgerAccountName |
string |
true |
none |
Name of the general ledger account |
»» generalLedgerAccountCode |
string |
true |
none |
Code for the general ledger account |
»» openItemManagement |
boolean |
true |
none |
Indicates whether open item management is enabled for the general ledger, facilitating the tracking and reconciliation of outstanding transactions. |
»» accountCategory |
string |
true |
none |
Category of the account |
»» shortName |
string |
false |
none |
Abbreviated name of the resource |
»» longName |
string |
false |
none |
Name of the long |
» taxLineItems |
false |
none |
An array of tax line items associated with the invoice, detailing the specific tax amounts applied to each line item for accurate financial reporting. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» taxRate |
number(double) |
false |
none |
Rate of tax |
»» taxAmount |
number |
false |
none |
Amount of tax |
»» taxType |
string |
false |
none |
Type of the tax |
»» invoiceLineItemId |
integer(int64) |
false |
none |
Unique identifier for the invoice line item |
» workBreakdownStructure |
false |
none |
Data transfer object representing a simplified version of a work breakdown structure, facilitating project management by outlining tasks, deliverables, and their hierarchical relationships for effective resource allocation and tracking. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
» costCenter |
false |
none |
CostCenterLite is a data transfer object that encapsulates essential information about a cost center, including its identifier and financial attributes, facilitating streamlined budget management and resource allocation within an organization. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
» profitCenter |
false |
none |
Data transfer object representing a profit center, encapsulating key financial metrics and performance indicators essential for effective budget management and strategic decision-making. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
»» validTo |
string(date) |
false |
none |
Date until which the resource is valid |
»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
»» erpSystemDisplayId |
string |
false |
none |
Unique identifier for the erp system display |
» functionalArea |
false |
none |
Data transfer object representing a streamlined overview of a functional area within the organization, including key attributes and identifiers essential for effective resource allocation and operational management. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
» businessArea |
false |
none |
Data transfer object representing a streamlined overview of a business area, including essential attributes for effective resource allocation and strategic planning. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
» segment |
false |
none |
SegmentLite is a streamlined data representation object that encapsulates essential information about market segments, enabling businesses to efficiently analyze and target specific customer groups for enhanced marketing strategies. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
» network |
false |
none |
Data structure representing a streamlined network configuration, designed to facilitate efficient resource allocation and management within enterprise environments. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
» internalOrderType |
false |
none |
Data transfer object representing a simplified internal order type, capturing essential details for order management and processing within the enterprise. This object facilitates streamlined operations by providing key attributes necessary for efficient order handling. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
» internalOrder |
false |
none |
Data transfer object representing a simplified internal order, encapsulating essential order details and status for streamlined processing within the organization’s supply chain management. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
»» internalOrderTypeId |
integer(int64) |
false |
none |
Unique identifier for the internal order type |
» additionalCurrencies |
false |
none |
List of additional currencies applicable to the invoice line item, enabling multi-currency transactions for enhanced financial flexibility. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» amount |
number |
false |
none |
Amount value |
»» currency |
false |
none |
Data transfer object representing a simplified currency model, designed to facilitate seamless currency conversions and transactions within financial applications, enhancing operational efficiency and accuracy in monetary exchanges. |
|
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» displayId |
string |
false |
none |
Unique identifier for the display |
»»» status |
string |
false |
none |
Status of the resource |
»»» name |
string |
false |
none |
Name of the resource |
»»» decimalPoints |
integer(int32) |
false |
none |
Specifies the number of decimal places to be used for currency values, ensuring accurate financial representation in transactions. |
»» conversionRate |
number |
false |
none |
Rate of conversion |
»» conversionDate |
string(date) |
false |
none |
Date of the conversion |
»» translationDateType |
string |
false |
none |
Type of the translation date |
»» amountType |
string |
false |
none |
Type of the amount |
»» currencyDefinitionType |
string |
false |
none |
Type of the currency definition |
»» invoiceEntryId |
integer(int64) |
false |
none |
Unique identifier for the invoice entry |
»» invoiceEntryDisplayId |
string |
false |
none |
Unique identifier for the invoice entry display |
» scheduledPaymentMatches |
false |
none |
An array of scheduled payment matches associated with invoice line items, facilitating the tracking and management of payment allocations. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» fromId |
integer(int64) |
false |
none |
Unique identifier for the from |
»» toId |
integer(int64) |
false |
none |
Unique identifier for the to |
»» amount |
number |
false |
none |
Amount value |
» goodsReceiptLineItemLinks |
false |
none |
An array of links to the associated goods receipt line items for the invoice line item, facilitating streamlined tracking and management of inventory transactions. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» fromId |
integer(int64) |
false |
none |
Unique identifier for the from |
»» toId |
integer(int64) |
false |
none |
Unique identifier for the to |
»» linkedQuantity |
integer(int64) |
false |
none |
Quantity of linked quantity |
» invoiceId |
integer(int64) |
false |
none |
Unique identifier for the invoice |
» invoiceDisplayId |
string |
false |
none |
Unique identifier for the invoice display |
» invoiceState |
string |
false |
none |
Represents the current status of the invoice line item, indicating its processing stage within the invoicing workflow. |
» vendorPaymentId |
integer(int64) |
false |
none |
Unique identifier for the vendor payment |
» purchaseOrderLineItemId |
integer(int64) |
false |
none |
Unique identifier for the purchase order line item |
» netAmount |
number |
false |
none |
Amount of net |
» allowsSystemGenerateNewId |
boolean |
false |
none |
Unique identifier for the allows system generate new |
» numberRangeIdentifierValue |
string |
false |
none |
Represents a unique identifier for the range of invoice line items, facilitating accurate tracking and management of billing details. |
» numberRangeIdentifierType |
false |
none |
Data transfer object representing a numerical range identifier used for categorizing and validating data entries within business processes, ensuring consistency and accuracy in data management. |
|
»» name |
string |
false |
none |
Name of the resource |
» numberRangeType |
false |
none |
Data structure representing a numerical range, utilized for defining limits or thresholds within business processes, ensuring precise data validation and operational efficiency. |
|
»» name |
string |
true |
none |
Name of the resource |
Enumerated Values
Attribute |
Value |
|---|---|
accountCategory |
BALANCESHEET, PROFITANDLOSS |
amountType |
NET_AMOUNT, TAX_AMOUNT |
currencyDefinitionType |
COMPANY_CURRENCY, CONTRACT_CURRENCY, MONTH_END_CURRENCY, REPORTING_CURRENCY, SECOND_LOCAL_CURRENCY, THIRD_LOCAL_CURRENCY |
expenseCategoryType |
CASH_INCENTIVE, CASUALTY, EXPECTED_GRV, INCENTIVE, NON_LEASE, PAYMENT, PURCHASE_OPTION, TERMINATION_OPTION |
invoiceState |
GOODS_RECEIPT_DRAFT, GOODS_RECEIPT_MATCHED, GOODS_RECEIPT_RECEIVED, GOODS_RECEIPT_REJECTED, INVOICE_PAYMENT_DRAFT, INVOICE_PAYMENT_JOURNALS_GENERATING, INVOICE_PAYMENT_POSTED, INVOICE_PAYMENT_POSTING, INVOICE_PAYMENT_REVIEW, INV_APPROVED, INV_DRAFT, INV_GENERATING_JOURNALS, INV_PAID, INV_POSTED, INV_POSTING, INV_REJECTED, INV_REVIEW, INV_WAITING_FOR_APPROVAL, PURCHASE_ORDER_APPROVED, PURCHASE_ORDER_DRAFT, PURCHASE_ORDER_REJECTED, PURCHASE_ORDER_WAITING_FOR_APPROVAL, PURCHASE_REQUISITION_APPROVED, PURCHASE_REQUISITION_DRAFT, PURCHASE_REQUISITION_REJECTED, PURCHASE_REQUISITION_WAITING_FOR_APPROVAL, VENDOR_REQUEST_APPROVED, VENDOR_REQUEST_DRAFT, VENDOR_REQUEST_PENDING_APPROVAL, VENDOR_REQUEST_REJECTED, WORKSPACE_CLOSED, WORKSPACE_JOURNALS_GENERATING, WORKSPACE_OPEN, WORKSPACE_POSTING, WORKSPACE_REVIEW |
status |
ACTIVE, CREATED, DECOMMISSIONED, DISABLED |
translationDateType |
, DOCUMENT_DATE, POSTING_DATE, TRANSLATION_DATE |
Link Goods Receipt Line Items To An Invoice Line Item¶
HTTP Request
POST /api/v1/invoice-line-item/link-goods-receipt-line-items
📋 Description: Associates one or more goods receipt line items with the specified invoice line items for 3-way matching. The operation is all-or-nothing: the entire batch is validated upfront and rolled back if any item fails.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the invoice line item details and associated goods receipt line item identifiers for linking purposes. |
Body Parameters
1[
2 {
3 "invoiceLineItemId": 0,
4 "goodsReceiptLineItemRecords": [
5 {
6 "goodsReceiptLineItemId": 0,
7 "goodsReceiptLineItemQuantity": 0
8 }
9 ]
10 }
11]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
|
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
Example Responses
1[
2 {
3 "id": 0,
4 "displayId": "string",
5 "expenseCategory": {
6 "id": 0,
7 "displayId": "string",
8 "status": "CREATED",
9 "name": "string",
10 "expenseCategoryType": "PAYMENT"
11 },
12 "description": "string",
13 "unitOfMeasure": {
14 "id": 0,
15 "displayId": "string",
16 "status": "CREATED",
17 "name": "string",
18 "erpSystemId": 0
19 },
20 "quantity": 0,
21 "unitPrice": 0,
22 "taxJurisdiction": {
23 "id": 0,
24 "displayId": "string",
25 "status": "CREATED",
26 "name": "string",
27 "erpSystemId": 0,
28 "schema": "string",
29 "countryDisplayId": "string"
30 },
31 "taxCode": {
32 "id": 0,
33 "displayId": "string",
34 "status": "CREATED",
35 "name": "string",
36 "erpSystemId": 0
37 },
38 "taxExpenseAccount": {
39 "id": 0,
40 "displayId": "string",
41 "generalLedgerAccountName": "string",
42 "generalLedgerAccountCode": "string",
43 "openItemManagement": true,
44 "accountCategory": "BALANCESHEET",
45 "shortName": "string",
46 "longName": "string"
47 },
48 "taxLineItems": [
49 {
50 "id": 0,
51 "taxRate": 0.1,
52 "taxAmount": 0,
53 "taxType": "string",
54 "invoiceLineItemId": 0
55 }
56 ],
57 "workBreakdownStructure": {
58 "id": 0,
59 "displayId": "string",
60 "status": "CREATED",
61 "name": "string",
62 "erpSystemId": 0
63 },
64 "costCenter": {
65 "id": 0,
66 "displayId": "string",
67 "status": "CREATED",
68 "name": "string",
69 "erpSystemId": 0
70 },
71 "profitCenter": {
72 "id": 0,
73 "displayId": "string",
74 "status": "CREATED",
75 "name": "string",
76 "validTo": "2019-08-24",
77 "erpSystemId": 0,
78 "erpSystemDisplayId": "string"
79 },
80 "functionalArea": {
81 "id": 0,
82 "displayId": "string",
83 "status": "CREATED",
84 "name": "string",
85 "erpSystemId": 0
86 },
87 "businessArea": {
88 "id": 0,
89 "displayId": "string",
90 "status": "CREATED",
91 "name": "string",
92 "erpSystemId": 0
93 },
94 "segment": {
95 "id": 0,
96 "displayId": "string",
97 "status": "CREATED",
98 "name": "string",
99 "erpSystemId": 0
100 },
101 "network": {
102 "id": 0,
103 "displayId": "string",
104 "status": "CREATED",
105 "name": "string",
106 "erpSystemId": 0
107 },
108 "internalOrderType": {
109 "id": 0,
110 "displayId": "string",
111 "status": "CREATED",
112 "name": "string",
113 "erpSystemId": 0
114 },
115 "internalOrder": {
116 "id": 0,
117 "displayId": "string",
118 "status": "CREATED",
119 "name": "string",
120 "erpSystemId": 0,
121 "internalOrderTypeId": 0
122 },
123 "additionalCurrencies": [
124 {
125 "id": 0,
126 "amount": 0,
127 "currency": {
128 "id": 0,
129 "displayId": "string",
130 "status": "CREATED",
131 "name": "string",
132 "decimalPoints": 0
133 },
134 "conversionRate": 0,
135 "conversionDate": "2019-08-24",
136 "translationDateType": "DOCUMENT_DATE",
137 "amountType": "NET_AMOUNT",
138 "currencyDefinitionType": "CONTRACT_CURRENCY",
139 "invoiceEntryId": 0,
140 "invoiceEntryDisplayId": "string"
141 }
142 ],
143 "scheduledPaymentMatches": [
144 {
145 "id": 0,
146 "fromId": 0,
147 "toId": 0,
148 "amount": 0
149 }
150 ],
151 "goodsReceiptLineItemLinks": [
152 {
153 "id": 0,
154 "fromId": 0,
155 "toId": 0,
156 "linkedQuantity": 0
157 }
158 ],
159 "invoiceId": 0,
160 "invoiceDisplayId": "string",
161 "invoiceState": "INV_DRAFT",
162 "vendorPaymentId": 0,
163 "purchaseOrderLineItemId": 0,
164 "netAmount": 0,
165 "allowsSystemGenerateNewId": true,
166 "numberRangeIdentifierValue": "string",
167 "numberRangeIdentifierType": {
168 "name": "string"
169 },
170 "numberRangeType": {
171 "name": "string"
172 }
173 }
174]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a line item within an invoice, detailing the specific goods or services provided, their quantities, and associated costs, essential for accurate billing and financial reporting.] |
|
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» displayId |
string |
false |
none |
Unique identifier for the display |
» expenseCategory |
false |
none |
Data transfer object representing a simplified categorization of expenses, enabling efficient tracking and reporting of financial allocations within the organization. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
»» expenseCategoryType |
string |
false |
none |
Type of the expense category |
» description |
string |
false |
none |
Description of the resource |
» unitOfMeasure |
false |
none |
Data transfer object representing a simplified unit of measure, utilized for standardizing quantities in various business processes, ensuring consistency and accuracy in reporting and analysis. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
» quantity |
integer(int64) |
false |
none |
Quantity value |
» unitPrice |
number |
false |
none |
The unitPrice field represents the cost per individual item in an invoice line, facilitating accurate billing and financial reporting. |
» taxJurisdiction |
false |
none |
Data transfer object representing a simplified tax jurisdiction, encapsulating key attributes necessary for tax compliance and reporting within various business operations. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
»» schema |
string |
false |
none |
Represents the tax jurisdiction information in a simplified format, facilitating compliance and reporting requirements. |
»» countryDisplayId |
string |
false |
none |
Unique identifier for the country display |
» taxCode |
false |
none |
Data transfer object representing a simplified tax code, designed to facilitate efficient tax calculations and compliance within financial applications. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
» taxExpenseAccount |
false |
none |
Data transfer object representing the general ledger information, including account details, transaction summaries, and financial metrics essential for comprehensive financial reporting and analysis. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» generalLedgerAccountName |
string |
true |
none |
Name of the general ledger account |
»» generalLedgerAccountCode |
string |
true |
none |
Code for the general ledger account |
»» openItemManagement |
boolean |
true |
none |
Indicates whether open item management is enabled for the general ledger, facilitating the tracking and reconciliation of outstanding transactions. |
»» accountCategory |
string |
true |
none |
Category of the account |
»» shortName |
string |
false |
none |
Abbreviated name of the resource |
»» longName |
string |
false |
none |
Name of the long |
» taxLineItems |
false |
none |
An array of tax line items associated with the invoice, detailing the specific tax amounts applied to each line item for accurate financial reporting. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» taxRate |
number(double) |
false |
none |
Rate of tax |
»» taxAmount |
number |
false |
none |
Amount of tax |
»» taxType |
string |
false |
none |
Type of the tax |
»» invoiceLineItemId |
integer(int64) |
false |
none |
Unique identifier for the invoice line item |
» workBreakdownStructure |
false |
none |
Data transfer object representing a simplified version of a work breakdown structure, facilitating project management by outlining tasks, deliverables, and their hierarchical relationships for effective resource allocation and tracking. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
» costCenter |
false |
none |
CostCenterLite is a data transfer object that encapsulates essential information about a cost center, including its identifier and financial attributes, facilitating streamlined budget management and resource allocation within an organization. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
» profitCenter |
false |
none |
Data transfer object representing a profit center, encapsulating key financial metrics and performance indicators essential for effective budget management and strategic decision-making. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
»» validTo |
string(date) |
false |
none |
Date until which the resource is valid |
»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
»» erpSystemDisplayId |
string |
false |
none |
Unique identifier for the erp system display |
» functionalArea |
false |
none |
Data transfer object representing a streamlined overview of a functional area within the organization, including key attributes and identifiers essential for effective resource allocation and operational management. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
» businessArea |
false |
none |
Data transfer object representing a streamlined overview of a business area, including essential attributes for effective resource allocation and strategic planning. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
» segment |
false |
none |
SegmentLite is a streamlined data representation object that encapsulates essential information about market segments, enabling businesses to efficiently analyze and target specific customer groups for enhanced marketing strategies. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
» network |
false |
none |
Data structure representing a streamlined network configuration, designed to facilitate efficient resource allocation and management within enterprise environments. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
» internalOrderType |
false |
none |
Data transfer object representing a simplified internal order type, capturing essential details for order management and processing within the enterprise. This object facilitates streamlined operations by providing key attributes necessary for efficient order handling. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
» internalOrder |
false |
none |
Data transfer object representing a simplified internal order, encapsulating essential order details and status for streamlined processing within the organization’s supply chain management. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
»» internalOrderTypeId |
integer(int64) |
false |
none |
Unique identifier for the internal order type |
» additionalCurrencies |
false |
none |
List of additional currencies applicable to the invoice line item, enabling multi-currency transactions for enhanced financial flexibility. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» amount |
number |
false |
none |
Amount value |
»» currency |
false |
none |
Data transfer object representing a simplified currency model, designed to facilitate seamless currency conversions and transactions within financial applications, enhancing operational efficiency and accuracy in monetary exchanges. |
|
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» displayId |
string |
false |
none |
Unique identifier for the display |
»»» status |
string |
false |
none |
Status of the resource |
»»» name |
string |
false |
none |
Name of the resource |
»»» decimalPoints |
integer(int32) |
false |
none |
Specifies the number of decimal places to be used for currency values, ensuring accurate financial representation in transactions. |
»» conversionRate |
number |
false |
none |
Rate of conversion |
»» conversionDate |
string(date) |
false |
none |
Date of the conversion |
»» translationDateType |
string |
false |
none |
Type of the translation date |
»» amountType |
string |
false |
none |
Type of the amount |
»» currencyDefinitionType |
string |
false |
none |
Type of the currency definition |
»» invoiceEntryId |
integer(int64) |
false |
none |
Unique identifier for the invoice entry |
»» invoiceEntryDisplayId |
string |
false |
none |
Unique identifier for the invoice entry display |
» scheduledPaymentMatches |
false |
none |
An array of scheduled payment matches associated with invoice line items, facilitating the tracking and management of payment allocations. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» fromId |
integer(int64) |
false |
none |
Unique identifier for the from |
»» toId |
integer(int64) |
false |
none |
Unique identifier for the to |
»» amount |
number |
false |
none |
Amount value |
» goodsReceiptLineItemLinks |
false |
none |
An array of links to the associated goods receipt line items for the invoice line item, facilitating streamlined tracking and management of inventory transactions. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» fromId |
integer(int64) |
false |
none |
Unique identifier for the from |
»» toId |
integer(int64) |
false |
none |
Unique identifier for the to |
»» linkedQuantity |
integer(int64) |
false |
none |
Quantity of linked quantity |
» invoiceId |
integer(int64) |
false |
none |
Unique identifier for the invoice |
» invoiceDisplayId |
string |
false |
none |
Unique identifier for the invoice display |
» invoiceState |
string |
false |
none |
Represents the current status of the invoice line item, indicating its processing stage within the invoicing workflow. |
» vendorPaymentId |
integer(int64) |
false |
none |
Unique identifier for the vendor payment |
» purchaseOrderLineItemId |
integer(int64) |
false |
none |
Unique identifier for the purchase order line item |
» netAmount |
number |
false |
none |
Amount of net |
» allowsSystemGenerateNewId |
boolean |
false |
none |
Unique identifier for the allows system generate new |
» numberRangeIdentifierValue |
string |
false |
none |
Represents a unique identifier for the range of invoice line items, facilitating accurate tracking and management of billing details. |
» numberRangeIdentifierType |
false |
none |
Data transfer object representing a numerical range identifier used for categorizing and validating data entries within business processes, ensuring consistency and accuracy in data management. |
|
»» name |
string |
false |
none |
Name of the resource |
» numberRangeType |
false |
none |
Data structure representing a numerical range, utilized for defining limits or thresholds within business processes, ensuring precise data validation and operational efficiency. |
|
»» name |
string |
true |
none |
Name of the resource |
Enumerated Values
Attribute |
Value |
|---|---|
accountCategory |
BALANCESHEET, PROFITANDLOSS |
amountType |
NET_AMOUNT, TAX_AMOUNT |
currencyDefinitionType |
COMPANY_CURRENCY, CONTRACT_CURRENCY, MONTH_END_CURRENCY, REPORTING_CURRENCY, SECOND_LOCAL_CURRENCY, THIRD_LOCAL_CURRENCY |
expenseCategoryType |
CASH_INCENTIVE, CASUALTY, EXPECTED_GRV, INCENTIVE, NON_LEASE, PAYMENT, PURCHASE_OPTION, TERMINATION_OPTION |
invoiceState |
GOODS_RECEIPT_DRAFT, GOODS_RECEIPT_MATCHED, GOODS_RECEIPT_RECEIVED, GOODS_RECEIPT_REJECTED, INVOICE_PAYMENT_DRAFT, INVOICE_PAYMENT_JOURNALS_GENERATING, INVOICE_PAYMENT_POSTED, INVOICE_PAYMENT_POSTING, INVOICE_PAYMENT_REVIEW, INV_APPROVED, INV_DRAFT, INV_GENERATING_JOURNALS, INV_PAID, INV_POSTED, INV_POSTING, INV_REJECTED, INV_REVIEW, INV_WAITING_FOR_APPROVAL, PURCHASE_ORDER_APPROVED, PURCHASE_ORDER_DRAFT, PURCHASE_ORDER_REJECTED, PURCHASE_ORDER_WAITING_FOR_APPROVAL, PURCHASE_REQUISITION_APPROVED, PURCHASE_REQUISITION_DRAFT, PURCHASE_REQUISITION_REJECTED, PURCHASE_REQUISITION_WAITING_FOR_APPROVAL, VENDOR_REQUEST_APPROVED, VENDOR_REQUEST_DRAFT, VENDOR_REQUEST_PENDING_APPROVAL, VENDOR_REQUEST_REJECTED, WORKSPACE_CLOSED, WORKSPACE_JOURNALS_GENERATING, WORKSPACE_OPEN, WORKSPACE_POSTING, WORKSPACE_REVIEW |
status |
ACTIVE, CREATED, DECOMMISSIONED, DISABLED |
translationDateType |
, DOCUMENT_DATE, POSTING_DATE, TRANSLATION_DATE |
Bulk Unmatch Scheduled Payments From Multiple Invoice Line Items¶
HTTP Request
POST /api/v1/invoice-line-item/bulk-unmatch-scheduled-payments
📋 Description: Removes match associations between multiple invoice line items and their scheduled payments in a single request. Each entry identifies one invoice line item and the clearing ledger entry IDs to unmatch. The operation is all-or-nothing: if any line item fails validation the entire request is rolled back.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing an array of invoice line item identifiers and associated scheduled payment details to facilitate bulk unmatching operations. |
Body Parameters
1[
2 {
3 "invoiceLineItemId": 0,
4 "clearingLedgerEntryIds": [
5 0
6 ]
7 }
8]
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}
Bulk Match Scheduled Payments To Multiple Invoice Line Items¶
HTTP Request
POST /api/v1/invoice-line-item/bulk-match-scheduled-payments
📋 Description: Creates match associations between multiple invoice line items and their respective scheduled payments in a single request. Each entry in the request body targets one invoice line item and may specify one or more scheduled payments with their allocated amounts. The operation is all-or-nothing: if any line item fails validation the entire request is rolled back. Returns a map of invoice line item ID → list of created match records.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing an array of invoice line items and their corresponding scheduled payment details for bulk matching purposes. |
Body Parameters
1[
2 {
3 "invoiceLineItemId": 0,
4 "matches": [
5 {
6 "clearingLedgerEntryId": 0,
7 "amount": 0
8 }
9 ]
10 }
11]
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 "property1": [
16 {
17 "id": 0,
18 "fromId": 0,
19 "toId": 0,
20 "amount": 0
21 }
22 ],
23 "property2": [
24 {
25 "id": 0,
26 "fromId": 0,
27 "toId": 0,
28 "amount": 0
29 }
30 ]
31 }
32}
Allocate Purchase Order Line Items To Invoice Line Items¶
HTTP Request
POST /api/v1/invoice-line-item/allocate-from-purchase-order-line-items
📋 Description: Creates new invoice line items pre-populated from the specified purchase order line items. Each allocation DTO maps a PO line item to its target invoice. The operation is all-or-nothing: the entire batch is validated upfront and rolled back if any item fails.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the allocation details for invoice line items sourced from purchase order line items, including quantities and identifiers for accurate processing. |
Body Parameters
1[
2 {
3 "purchaseOrderLineItemId": 0,
4 "invoiceId": 0,
5 "quantity": 0,
6 "unitPrice": 0,
7 "taxJurisdiction": {
8 "id": 0,
9 "displayId": "string",
10 "status": "CREATED",
11 "name": "string",
12 "erpSystemId": 0,
13 "schema": "string",
14 "countryDisplayId": "string"
15 },
16 "taxCode": {
17 "id": 0,
18 "displayId": "string",
19 "status": "CREATED",
20 "name": "string",
21 "erpSystemId": 0
22 },
23 "taxExpenseAccount": {
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 "taxLineItems": [
34 {
35 "id": 0,
36 "taxRate": 0.1,
37 "taxAmount": 0,
38 "taxType": "string",
39 "invoiceLineItemId": 0
40 }
41 ],
42 "costCenter": {
43 "id": 0,
44 "displayId": "string",
45 "status": "CREATED",
46 "name": "string",
47 "erpSystemId": 0
48 },
49 "profitCenter": {
50 "id": 0,
51 "displayId": "string",
52 "status": "CREATED",
53 "name": "string",
54 "validTo": "2019-08-24",
55 "erpSystemId": 0,
56 "erpSystemDisplayId": "string"
57 }
58 }
59]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
|
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
Example Responses
1[
2 {
3 "id": 0,
4 "displayId": "string",
5 "expenseCategory": {
6 "id": 0,
7 "displayId": "string",
8 "status": "CREATED",
9 "name": "string",
10 "expenseCategoryType": "PAYMENT"
11 },
12 "description": "string",
13 "unitOfMeasure": {
14 "id": 0,
15 "displayId": "string",
16 "status": "CREATED",
17 "name": "string",
18 "erpSystemId": 0
19 },
20 "quantity": 0,
21 "unitPrice": 0,
22 "taxJurisdiction": {
23 "id": 0,
24 "displayId": "string",
25 "status": "CREATED",
26 "name": "string",
27 "erpSystemId": 0,
28 "schema": "string",
29 "countryDisplayId": "string"
30 },
31 "taxCode": {
32 "id": 0,
33 "displayId": "string",
34 "status": "CREATED",
35 "name": "string",
36 "erpSystemId": 0
37 },
38 "taxExpenseAccount": {
39 "id": 0,
40 "displayId": "string",
41 "generalLedgerAccountName": "string",
42 "generalLedgerAccountCode": "string",
43 "openItemManagement": true,
44 "accountCategory": "BALANCESHEET",
45 "shortName": "string",
46 "longName": "string"
47 },
48 "taxLineItems": [
49 {
50 "id": 0,
51 "taxRate": 0.1,
52 "taxAmount": 0,
53 "taxType": "string",
54 "invoiceLineItemId": 0
55 }
56 ],
57 "workBreakdownStructure": {
58 "id": 0,
59 "displayId": "string",
60 "status": "CREATED",
61 "name": "string",
62 "erpSystemId": 0
63 },
64 "costCenter": {
65 "id": 0,
66 "displayId": "string",
67 "status": "CREATED",
68 "name": "string",
69 "erpSystemId": 0
70 },
71 "profitCenter": {
72 "id": 0,
73 "displayId": "string",
74 "status": "CREATED",
75 "name": "string",
76 "validTo": "2019-08-24",
77 "erpSystemId": 0,
78 "erpSystemDisplayId": "string"
79 },
80 "functionalArea": {
81 "id": 0,
82 "displayId": "string",
83 "status": "CREATED",
84 "name": "string",
85 "erpSystemId": 0
86 },
87 "businessArea": {
88 "id": 0,
89 "displayId": "string",
90 "status": "CREATED",
91 "name": "string",
92 "erpSystemId": 0
93 },
94 "segment": {
95 "id": 0,
96 "displayId": "string",
97 "status": "CREATED",
98 "name": "string",
99 "erpSystemId": 0
100 },
101 "network": {
102 "id": 0,
103 "displayId": "string",
104 "status": "CREATED",
105 "name": "string",
106 "erpSystemId": 0
107 },
108 "internalOrderType": {
109 "id": 0,
110 "displayId": "string",
111 "status": "CREATED",
112 "name": "string",
113 "erpSystemId": 0
114 },
115 "internalOrder": {
116 "id": 0,
117 "displayId": "string",
118 "status": "CREATED",
119 "name": "string",
120 "erpSystemId": 0,
121 "internalOrderTypeId": 0
122 },
123 "additionalCurrencies": [
124 {
125 "id": 0,
126 "amount": 0,
127 "currency": {
128 "id": 0,
129 "displayId": "string",
130 "status": "CREATED",
131 "name": "string",
132 "decimalPoints": 0
133 },
134 "conversionRate": 0,
135 "conversionDate": "2019-08-24",
136 "translationDateType": "DOCUMENT_DATE",
137 "amountType": "NET_AMOUNT",
138 "currencyDefinitionType": "CONTRACT_CURRENCY",
139 "invoiceEntryId": 0,
140 "invoiceEntryDisplayId": "string"
141 }
142 ],
143 "scheduledPaymentMatches": [
144 {
145 "id": 0,
146 "fromId": 0,
147 "toId": 0,
148 "amount": 0
149 }
150 ],
151 "goodsReceiptLineItemLinks": [
152 {
153 "id": 0,
154 "fromId": 0,
155 "toId": 0,
156 "linkedQuantity": 0
157 }
158 ],
159 "invoiceId": 0,
160 "invoiceDisplayId": "string",
161 "invoiceState": "INV_DRAFT",
162 "vendorPaymentId": 0,
163 "purchaseOrderLineItemId": 0,
164 "netAmount": 0,
165 "allowsSystemGenerateNewId": true,
166 "numberRangeIdentifierValue": "string",
167 "numberRangeIdentifierType": {
168 "name": "string"
169 },
170 "numberRangeType": {
171 "name": "string"
172 }
173 }
174]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a line item within an invoice, detailing the specific goods or services provided, their quantities, and associated costs, essential for accurate billing and financial reporting.] |
|
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» displayId |
string |
false |
none |
Unique identifier for the display |
» expenseCategory |
false |
none |
Data transfer object representing a simplified categorization of expenses, enabling efficient tracking and reporting of financial allocations within the organization. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
»» expenseCategoryType |
string |
false |
none |
Type of the expense category |
» description |
string |
false |
none |
Description of the resource |
» unitOfMeasure |
false |
none |
Data transfer object representing a simplified unit of measure, utilized for standardizing quantities in various business processes, ensuring consistency and accuracy in reporting and analysis. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
» quantity |
integer(int64) |
false |
none |
Quantity value |
» unitPrice |
number |
false |
none |
The unitPrice field represents the cost per individual item in an invoice line, facilitating accurate billing and financial reporting. |
» taxJurisdiction |
false |
none |
Data transfer object representing a simplified tax jurisdiction, encapsulating key attributes necessary for tax compliance and reporting within various business operations. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
»» schema |
string |
false |
none |
Represents the tax jurisdiction information in a simplified format, facilitating compliance and reporting requirements. |
»» countryDisplayId |
string |
false |
none |
Unique identifier for the country display |
» taxCode |
false |
none |
Data transfer object representing a simplified tax code, designed to facilitate efficient tax calculations and compliance within financial applications. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
» taxExpenseAccount |
false |
none |
Data transfer object representing the general ledger information, including account details, transaction summaries, and financial metrics essential for comprehensive financial reporting and analysis. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» generalLedgerAccountName |
string |
true |
none |
Name of the general ledger account |
»» generalLedgerAccountCode |
string |
true |
none |
Code for the general ledger account |
»» openItemManagement |
boolean |
true |
none |
Indicates whether open item management is enabled for the general ledger, facilitating the tracking and reconciliation of outstanding transactions. |
»» accountCategory |
string |
true |
none |
Category of the account |
»» shortName |
string |
false |
none |
Abbreviated name of the resource |
»» longName |
string |
false |
none |
Name of the long |
» taxLineItems |
false |
none |
An array of tax line items associated with the invoice, detailing the specific tax amounts applied to each line item for accurate financial reporting. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» taxRate |
number(double) |
false |
none |
Rate of tax |
»» taxAmount |
number |
false |
none |
Amount of tax |
»» taxType |
string |
false |
none |
Type of the tax |
»» invoiceLineItemId |
integer(int64) |
false |
none |
Unique identifier for the invoice line item |
» workBreakdownStructure |
false |
none |
Data transfer object representing a simplified version of a work breakdown structure, facilitating project management by outlining tasks, deliverables, and their hierarchical relationships for effective resource allocation and tracking. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
» costCenter |
false |
none |
CostCenterLite is a data transfer object that encapsulates essential information about a cost center, including its identifier and financial attributes, facilitating streamlined budget management and resource allocation within an organization. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
» profitCenter |
false |
none |
Data transfer object representing a profit center, encapsulating key financial metrics and performance indicators essential for effective budget management and strategic decision-making. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
»» validTo |
string(date) |
false |
none |
Date until which the resource is valid |
»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
»» erpSystemDisplayId |
string |
false |
none |
Unique identifier for the erp system display |
» functionalArea |
false |
none |
Data transfer object representing a streamlined overview of a functional area within the organization, including key attributes and identifiers essential for effective resource allocation and operational management. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
» businessArea |
false |
none |
Data transfer object representing a streamlined overview of a business area, including essential attributes for effective resource allocation and strategic planning. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
» segment |
false |
none |
SegmentLite is a streamlined data representation object that encapsulates essential information about market segments, enabling businesses to efficiently analyze and target specific customer groups for enhanced marketing strategies. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
» network |
false |
none |
Data structure representing a streamlined network configuration, designed to facilitate efficient resource allocation and management within enterprise environments. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
» internalOrderType |
false |
none |
Data transfer object representing a simplified internal order type, capturing essential details for order management and processing within the enterprise. This object facilitates streamlined operations by providing key attributes necessary for efficient order handling. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
» internalOrder |
false |
none |
Data transfer object representing a simplified internal order, encapsulating essential order details and status for streamlined processing within the organization’s supply chain management. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
»» internalOrderTypeId |
integer(int64) |
false |
none |
Unique identifier for the internal order type |
» additionalCurrencies |
false |
none |
List of additional currencies applicable to the invoice line item, enabling multi-currency transactions for enhanced financial flexibility. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» amount |
number |
false |
none |
Amount value |
»» currency |
false |
none |
Data transfer object representing a simplified currency model, designed to facilitate seamless currency conversions and transactions within financial applications, enhancing operational efficiency and accuracy in monetary exchanges. |
|
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» displayId |
string |
false |
none |
Unique identifier for the display |
»»» status |
string |
false |
none |
Status of the resource |
»»» name |
string |
false |
none |
Name of the resource |
»»» decimalPoints |
integer(int32) |
false |
none |
Specifies the number of decimal places to be used for currency values, ensuring accurate financial representation in transactions. |
»» conversionRate |
number |
false |
none |
Rate of conversion |
»» conversionDate |
string(date) |
false |
none |
Date of the conversion |
»» translationDateType |
string |
false |
none |
Type of the translation date |
»» amountType |
string |
false |
none |
Type of the amount |
»» currencyDefinitionType |
string |
false |
none |
Type of the currency definition |
»» invoiceEntryId |
integer(int64) |
false |
none |
Unique identifier for the invoice entry |
»» invoiceEntryDisplayId |
string |
false |
none |
Unique identifier for the invoice entry display |
» scheduledPaymentMatches |
false |
none |
An array of scheduled payment matches associated with invoice line items, facilitating the tracking and management of payment allocations. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» fromId |
integer(int64) |
false |
none |
Unique identifier for the from |
»» toId |
integer(int64) |
false |
none |
Unique identifier for the to |
»» amount |
number |
false |
none |
Amount value |
» goodsReceiptLineItemLinks |
false |
none |
An array of links to the associated goods receipt line items for the invoice line item, facilitating streamlined tracking and management of inventory transactions. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» fromId |
integer(int64) |
false |
none |
Unique identifier for the from |
»» toId |
integer(int64) |
false |
none |
Unique identifier for the to |
»» linkedQuantity |
integer(int64) |
false |
none |
Quantity of linked quantity |
» invoiceId |
integer(int64) |
false |
none |
Unique identifier for the invoice |
» invoiceDisplayId |
string |
false |
none |
Unique identifier for the invoice display |
» invoiceState |
string |
false |
none |
Represents the current status of the invoice line item, indicating its processing stage within the invoicing workflow. |
» vendorPaymentId |
integer(int64) |
false |
none |
Unique identifier for the vendor payment |
» purchaseOrderLineItemId |
integer(int64) |
false |
none |
Unique identifier for the purchase order line item |
» netAmount |
number |
false |
none |
Amount of net |
» allowsSystemGenerateNewId |
boolean |
false |
none |
Unique identifier for the allows system generate new |
» numberRangeIdentifierValue |
string |
false |
none |
Represents a unique identifier for the range of invoice line items, facilitating accurate tracking and management of billing details. |
» numberRangeIdentifierType |
false |
none |
Data transfer object representing a numerical range identifier used for categorizing and validating data entries within business processes, ensuring consistency and accuracy in data management. |
|
»» name |
string |
false |
none |
Name of the resource |
» numberRangeType |
false |
none |
Data structure representing a numerical range, utilized for defining limits or thresholds within business processes, ensuring precise data validation and operational efficiency. |
|
»» name |
string |
true |
none |
Name of the resource |
Enumerated Values
Attribute |
Value |
|---|---|
accountCategory |
BALANCESHEET, PROFITANDLOSS |
amountType |
NET_AMOUNT, TAX_AMOUNT |
currencyDefinitionType |
COMPANY_CURRENCY, CONTRACT_CURRENCY, MONTH_END_CURRENCY, REPORTING_CURRENCY, SECOND_LOCAL_CURRENCY, THIRD_LOCAL_CURRENCY |
expenseCategoryType |
CASH_INCENTIVE, CASUALTY, EXPECTED_GRV, INCENTIVE, NON_LEASE, PAYMENT, PURCHASE_OPTION, TERMINATION_OPTION |
invoiceState |
GOODS_RECEIPT_DRAFT, GOODS_RECEIPT_MATCHED, GOODS_RECEIPT_RECEIVED, GOODS_RECEIPT_REJECTED, INVOICE_PAYMENT_DRAFT, INVOICE_PAYMENT_JOURNALS_GENERATING, INVOICE_PAYMENT_POSTED, INVOICE_PAYMENT_POSTING, INVOICE_PAYMENT_REVIEW, INV_APPROVED, INV_DRAFT, INV_GENERATING_JOURNALS, INV_PAID, INV_POSTED, INV_POSTING, INV_REJECTED, INV_REVIEW, INV_WAITING_FOR_APPROVAL, PURCHASE_ORDER_APPROVED, PURCHASE_ORDER_DRAFT, PURCHASE_ORDER_REJECTED, PURCHASE_ORDER_WAITING_FOR_APPROVAL, PURCHASE_REQUISITION_APPROVED, PURCHASE_REQUISITION_DRAFT, PURCHASE_REQUISITION_REJECTED, PURCHASE_REQUISITION_WAITING_FOR_APPROVAL, VENDOR_REQUEST_APPROVED, VENDOR_REQUEST_DRAFT, VENDOR_REQUEST_PENDING_APPROVAL, VENDOR_REQUEST_REJECTED, WORKSPACE_CLOSED, WORKSPACE_JOURNALS_GENERATING, WORKSPACE_OPEN, WORKSPACE_POSTING, WORKSPACE_REVIEW |
status |
ACTIVE, CREATED, DECOMMISSIONED, DISABLED |
translationDateType |
, DOCUMENT_DATE, POSTING_DATE, TRANSLATION_DATE |
Advanced Invoice Line Item Search¶
HTTP Request
POST /api/v1/invoice-line-item/advanced-search
📋 Description: Full-text / multi-field search with faceting. Applies company-access and vendor-access filtering.
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 |
true |
Request body containing advanced search criteria for invoice line items, including filters such as date range, amount, and status to facilitate targeted data retrieval. |
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 "facets": [
3 "ID"
4 ],
5 "facetSelections": {
6 "property1": [
7 "string"
8 ],
9 "property2": [
10 "string"
11 ]
12 },
13 "aggregations": {
14 "property1": {
15 "type": "TERMS",
16 "field": "ID",
17 "size": 0,
18 "missing": "string"
19 },
20 "property2": {
21 "type": "TERMS",
22 "field": "ID",
23 "size": 0,
24 "missing": "string"
25 }
26 },
27 "filter": {
28 "operator": "AND",
29 "children": [
30 {}
31 ],
32 "field": "ID",
33 "comparison": "EQUAL",
34 "value": "string",
35 "values": [
36 "string"
37 ],
38 "from": "string",
39 "to": "string"
40 }
41}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
||
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
Example Responses
1{
2 "results": [
3 {
4 "id": 0,
5 "displayId": "string",
6 "expenseCategory": {
7 "id": 0,
8 "displayId": "string",
9 "status": "CREATED",
10 "name": "string",
11 "expenseCategoryType": "PAYMENT"
12 },
13 "description": "string",
14 "unitOfMeasure": {
15 "id": 0,
16 "displayId": "string",
17 "status": "CREATED",
18 "name": "string",
19 "erpSystemId": 0
20 },
21 "quantity": 0,
22 "unitPrice": 0,
23 "taxJurisdiction": {
24 "id": 0,
25 "displayId": "string",
26 "status": "CREATED",
27 "name": "string",
28 "erpSystemId": 0,
29 "schema": "string",
30 "countryDisplayId": "string"
31 },
32 "taxCode": {
33 "id": 0,
34 "displayId": "string",
35 "status": "CREATED",
36 "name": "string",
37 "erpSystemId": 0
38 },
39 "taxExpenseAccount": {
40 "id": 0,
41 "displayId": "string",
42 "generalLedgerAccountName": "string",
43 "generalLedgerAccountCode": "string",
44 "openItemManagement": true,
45 "accountCategory": "BALANCESHEET",
46 "shortName": "string",
47 "longName": "string"
48 },
49 "taxLineItems": [
50 {
51 "id": 0,
52 "taxRate": 0.1,
53 "taxAmount": 0,
54 "taxType": "string",
55 "invoiceLineItemId": 0
56 }
57 ],
58 "workBreakdownStructure": {
59 "id": 0,
60 "displayId": "string",
61 "status": "CREATED",
62 "name": "string",
63 "erpSystemId": 0
64 },
65 "costCenter": {
66 "id": 0,
67 "displayId": "string",
68 "status": "CREATED",
69 "name": "string",
70 "erpSystemId": 0
71 },
72 "profitCenter": {
73 "id": 0,
74 "displayId": "string",
75 "status": "CREATED",
76 "name": "string",
77 "validTo": "2019-08-24",
78 "erpSystemId": 0,
79 "erpSystemDisplayId": "string"
80 },
81 "functionalArea": {
82 "id": 0,
83 "displayId": "string",
84 "status": "CREATED",
85 "name": "string",
86 "erpSystemId": 0
87 },
88 "businessArea": {
89 "id": 0,
90 "displayId": "string",
91 "status": "CREATED",
92 "name": "string",
93 "erpSystemId": 0
94 },
95 "segment": {
96 "id": 0,
97 "displayId": "string",
98 "status": "CREATED",
99 "name": "string",
100 "erpSystemId": 0
101 },
102 "network": {
103 "id": 0,
104 "displayId": "string",
105 "status": "CREATED",
106 "name": "string",
107 "erpSystemId": 0
108 },
109 "internalOrderType": {
110 "id": 0,
111 "displayId": "string",
112 "status": "CREATED",
113 "name": "string",
114 "erpSystemId": 0
115 },
116 "internalOrder": {
117 "id": 0,
118 "displayId": "string",
119 "status": "CREATED",
120 "name": "string",
121 "erpSystemId": 0,
122 "internalOrderTypeId": 0
123 },
124 "additionalCurrencies": [
125 {
126 "id": 0,
127 "amount": 0,
128 "currency": {
129 "id": 0,
130 "displayId": "string",
131 "status": "CREATED",
132 "name": "string",
133 "decimalPoints": 0
134 },
135 "conversionRate": 0,
136 "conversionDate": "2019-08-24",
137 "translationDateType": "DOCUMENT_DATE",
138 "amountType": "NET_AMOUNT",
139 "currencyDefinitionType": "CONTRACT_CURRENCY",
140 "invoiceEntryId": 0,
141 "invoiceEntryDisplayId": "string"
142 }
143 ],
144 "scheduledPaymentMatches": [
145 {
146 "id": 0,
147 "fromId": 0,
148 "toId": 0,
149 "amount": 0
150 }
151 ],
152 "goodsReceiptLineItemLinks": [
153 {
154 "id": 0,
155 "fromId": 0,
156 "toId": 0,
157 "linkedQuantity": 0
158 }
159 ],
160 "invoiceId": 0,
161 "invoiceDisplayId": "string",
162 "invoiceState": "INV_DRAFT",
163 "vendorPaymentId": 0,
164 "purchaseOrderLineItemId": 0,
165 "netAmount": 0,
166 "allowsSystemGenerateNewId": true,
167 "numberRangeIdentifierValue": "string",
168 "numberRangeIdentifierType": {
169 "name": "string"
170 },
171 "numberRangeType": {
172 "name": "string"
173 }
174 }
175 ],
176 "facets": {
177 "property1": {},
178 "property2": {}
179 },
180 "aggregations": {
181 "property1": {},
182 "property2": {}
183 },
184 "pagination": {
185 "number": 0,
186 "size": 0,
187 "totalElements": 0,
188 "totalPages": 0,
189 "first": true,
190 "last": true,
191 "empty": true,
192 "numberOfElements": 0
193 }
194}
Update Allocated Amounts For Existing Scheduled Payment Matches¶
HTTP Request
PATCH /api/v1/invoice-line-item/scheduled-payment-matches
📋 Description: Partially updates the allocated amount of one or more existing invoice-line-item-to-scheduled-payment match records. Each update identifies the match by its unique match ID (not the line item or scheduled payment ID). The amount must be greater than zero; setting an amount effectively reallocates the match without removing it. Returns the updated match records.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the scheduled payment match details for invoice line items, including relevant identifiers and payment information for accurate processing. |
Body Parameters
1[
2 {
3 "matchId": 0,
4 "amount": 0
5 }
6]
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 "fromId": 0,
18 "toId": 0,
19 "amount": 0
20 }
21 ]
22}