Purchase Order Line Item¶
Get A Resource By ID¶
HTTP Request
GET /api/v1/purchase-order-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 "quantity": 0,
18 "allocatedQuantity": 0,
19 "receivedQuantity": 0,
20 "unitPrice": 0,
21 "description": "string",
22 "expenseCategory": {
23 "id": 0,
24 "displayId": "string",
25 "status": "CREATED",
26 "name": "string",
27 "expenseCategoryType": "PAYMENT"
28 },
29 "costCenter": {
30 "id": 0,
31 "displayId": "string",
32 "status": "CREATED",
33 "name": "string",
34 "erpSystemId": 0
35 },
36 "profitCenter": {
37 "id": 0,
38 "displayId": "string",
39 "status": "CREATED",
40 "name": "string",
41 "validTo": "2019-08-24",
42 "erpSystemId": 0,
43 "erpSystemDisplayId": "string"
44 },
45 "taxJurisdiction": {
46 "id": 0,
47 "displayId": "string",
48 "status": "CREATED",
49 "name": "string",
50 "erpSystemId": 0,
51 "schema": "string",
52 "countryDisplayId": "string"
53 },
54 "taxCode": {
55 "id": 0,
56 "displayId": "string",
57 "status": "CREATED",
58 "name": "string",
59 "erpSystemId": 0
60 },
61 "taxLineItems": [
62 {
63 "id": 0,
64 "taxRate": 0.1,
65 "taxAmount": 0,
66 "taxType": "string",
67 "purchaseOrderLineItemId": 0
68 }
69 ],
70 "purchaseOrderId": 0,
71 "purchaseOrderDisplayId": "string",
72 "purchaseOrderState": "INV_DRAFT",
73 "invoiceLineItems": [
74 {
75 "id": 0,
76 "displayId": "string",
77 "expenseCategory": {
78 "id": 0,
79 "displayId": "string",
80 "status": "CREATED",
81 "name": "string",
82 "expenseCategoryType": "PAYMENT"
83 },
84 "description": "string",
85 "unitOfMeasure": {
86 "id": 0,
87 "displayId": "string",
88 "status": "CREATED",
89 "name": "string",
90 "erpSystemId": 0
91 },
92 "quantity": 0,
93 "unitPrice": 0,
94 "taxJurisdiction": {
95 "id": 0,
96 "displayId": "string",
97 "status": "CREATED",
98 "name": "string",
99 "erpSystemId": 0,
100 "schema": "string",
101 "countryDisplayId": "string"
102 },
103 "taxCode": {
104 "id": 0,
105 "displayId": "string",
106 "status": "CREATED",
107 "name": "string",
108 "erpSystemId": 0
109 },
110 "taxExpenseAccount": {
111 "id": 0,
112 "displayId": "string",
113 "generalLedgerAccountName": "string",
114 "generalLedgerAccountCode": "string",
115 "openItemManagement": true,
116 "accountCategory": "BALANCESHEET",
117 "shortName": "string",
118 "longName": "string"
119 },
120 "taxLineItems": [
121 {
122 "id": 0,
123 "taxRate": 0.1,
124 "taxAmount": 0,
125 "taxType": "string",
126 "invoiceLineItemId": 0
127 }
128 ],
129 "workBreakdownStructure": {
130 "id": 0,
131 "displayId": "string",
132 "status": "CREATED",
133 "name": "string",
134 "erpSystemId": 0
135 },
136 "costCenter": {
137 "id": 0,
138 "displayId": "string",
139 "status": "CREATED",
140 "name": "string",
141 "erpSystemId": 0
142 },
143 "profitCenter": {
144 "id": 0,
145 "displayId": "string",
146 "status": "CREATED",
147 "name": "string",
148 "validTo": "2019-08-24",
149 "erpSystemId": 0,
150 "erpSystemDisplayId": "string"
151 },
152 "functionalArea": {
153 "id": 0,
154 "displayId": "string",
155 "status": "CREATED",
156 "name": "string",
157 "erpSystemId": 0
158 },
159 "businessArea": {
160 "id": 0,
161 "displayId": "string",
162 "status": "CREATED",
163 "name": "string",
164 "erpSystemId": 0
165 },
166 "segment": {
167 "id": 0,
168 "displayId": "string",
169 "status": "CREATED",
170 "name": "string",
171 "erpSystemId": 0
172 },
173 "network": {
174 "id": 0,
175 "displayId": "string",
176 "status": "CREATED",
177 "name": "string",
178 "erpSystemId": 0
179 },
180 "internalOrderType": {
181 "id": 0,
182 "displayId": "string",
183 "status": "CREATED",
184 "name": "string",
185 "erpSystemId": 0
186 },
187 "internalOrder": {
188 "id": 0,
189 "displayId": "string",
190 "status": "CREATED",
191 "name": "string",
192 "erpSystemId": 0,
193 "internalOrderTypeId": 0
194 },
195 "additionalCurrencies": [
196 {
197 "id": 0,
198 "amount": 0,
199 "currency": {
200 "id": 0,
201 "displayId": "string",
202 "status": "CREATED",
203 "name": "string",
204 "decimalPoints": 0
205 },
206 "conversionRate": 0,
207 "conversionDate": "2019-08-24",
208 "translationDateType": "DOCUMENT_DATE",
209 "amountType": "NET_AMOUNT",
210 "currencyDefinitionType": "CONTRACT_CURRENCY",
211 "invoiceEntryId": 0,
212 "invoiceEntryDisplayId": "string"
213 }
214 ],
215 "scheduledPaymentMatches": [
216 {
217 "id": 0,
218 "fromId": 0,
219 "toId": 0,
220 "amount": 0
221 }
222 ],
223 "goodsReceiptLineItemLinks": [
224 {
225 "id": 0,
226 "fromId": 0,
227 "toId": 0,
228 "linkedQuantity": 0
229 }
230 ],
231 "invoiceId": 0,
232 "invoiceDisplayId": "string",
233 "invoiceState": "INV_DRAFT",
234 "vendorPaymentId": 0,
235 "purchaseOrderLineItemId": 0,
236 "netAmount": 0,
237 "allowsSystemGenerateNewId": true,
238 "numberRangeIdentifierValue": "string",
239 "numberRangeIdentifierType": {
240 "name": "string"
241 },
242 "numberRangeType": {
243 "name": "string"
244 }
245 }
246 ],
247 "goodsReceiptLineItems": [
248 {
249 "id": 0,
250 "displayId": "string",
251 "quantity": 0,
252 "invoicedQuantity": 0,
253 "description": "string",
254 "expenseCategory": {
255 "id": 0,
256 "displayId": "string",
257 "status": "CREATED",
258 "name": "string",
259 "expenseCategoryType": "PAYMENT"
260 },
261 "goodsReceiptId": 0,
262 "goodsReceiptDisplayId": "string",
263 "goodsReceiptState": "INV_DRAFT",
264 "purchaseOrderLineItemId": 0,
265 "invoiceLineItemLinks": [
266 {
267 "id": 0,
268 "fromId": 0,
269 "toId": 0,
270 "linkedQuantity": 0
271 }
272 ],
273 "availableQuantity": 0,
274 "allowsSystemGenerateNewId": true,
275 "numberRangeIdentifierValue": "string",
276 "numberRangeIdentifierType": {
277 "name": "string"
278 },
279 "numberRangeType": {
280 "name": "string"
281 }
282 }
283 ],
284 "vendorPaymentId": 0,
285 "purchaseRequisitionLineItemId": 0,
286 "purchaseRequisitionDisplayId": "string",
287 "purchaseRequisitionLineItemAvailableQuantity": 0,
288 "remainingQuantity": 0,
289 "availableQuantity": 0,
290 "allowsSystemGenerateNewId": true,
291 "numberRangeIdentifierValue": "string",
292 "numberRangeIdentifierType": {
293 "name": "string"
294 },
295 "numberRangeType": {
296 "name": "string"
297 }
298 }
299}
Update A Resource¶
HTTP Request
PUT /api/v1/purchase-order-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 details of the purchase order line item, including quantity, price, and any relevant adjustments necessary for order fulfillment. |
Body Parameters
1{
2 "id": 0,
3 "displayId": "string",
4 "quantity": 0,
5 "allocatedQuantity": 0,
6 "receivedQuantity": 0,
7 "unitPrice": 0,
8 "description": "string",
9 "expenseCategory": {
10 "id": 0,
11 "displayId": "string",
12 "status": "CREATED",
13 "name": "string",
14 "expenseCategoryType": "PAYMENT"
15 },
16 "costCenter": {
17 "id": 0,
18 "displayId": "string",
19 "status": "CREATED",
20 "name": "string",
21 "erpSystemId": 0
22 },
23 "profitCenter": {
24 "id": 0,
25 "displayId": "string",
26 "status": "CREATED",
27 "name": "string",
28 "validTo": "2019-08-24",
29 "erpSystemId": 0,
30 "erpSystemDisplayId": "string"
31 },
32 "taxJurisdiction": {
33 "id": 0,
34 "displayId": "string",
35 "status": "CREATED",
36 "name": "string",
37 "erpSystemId": 0,
38 "schema": "string",
39 "countryDisplayId": "string"
40 },
41 "taxCode": {
42 "id": 0,
43 "displayId": "string",
44 "status": "CREATED",
45 "name": "string",
46 "erpSystemId": 0
47 },
48 "taxLineItems": [
49 {
50 "id": 0,
51 "taxRate": 0.1,
52 "taxAmount": 0,
53 "taxType": "string",
54 "purchaseOrderLineItemId": 0
55 }
56 ],
57 "purchaseOrderId": 0,
58 "purchaseOrderDisplayId": "string",
59 "purchaseOrderState": "INV_DRAFT",
60 "invoiceLineItems": [
61 {
62 "id": 0,
63 "displayId": "string",
64 "expenseCategory": {
65 "id": 0,
66 "displayId": "string",
67 "status": "CREATED",
68 "name": "string",
69 "expenseCategoryType": "PAYMENT"
70 },
71 "description": "string",
72 "unitOfMeasure": {
73 "id": 0,
74 "displayId": "string",
75 "status": "CREATED",
76 "name": "string",
77 "erpSystemId": 0
78 },
79 "quantity": 0,
80 "unitPrice": 0,
81 "taxJurisdiction": {
82 "id": 0,
83 "displayId": "string",
84 "status": "CREATED",
85 "name": "string",
86 "erpSystemId": 0,
87 "schema": "string",
88 "countryDisplayId": "string"
89 },
90 "taxCode": {
91 "id": 0,
92 "displayId": "string",
93 "status": "CREATED",
94 "name": "string",
95 "erpSystemId": 0
96 },
97 "taxExpenseAccount": {
98 "id": 0,
99 "displayId": "string",
100 "generalLedgerAccountName": "string",
101 "generalLedgerAccountCode": "string",
102 "openItemManagement": true,
103 "accountCategory": "BALANCESHEET",
104 "shortName": "string",
105 "longName": "string"
106 },
107 "taxLineItems": [
108 {
109 "id": 0,
110 "taxRate": 0.1,
111 "taxAmount": 0,
112 "taxType": "string",
113 "invoiceLineItemId": 0
114 }
115 ],
116 "workBreakdownStructure": {
117 "id": 0,
118 "displayId": "string",
119 "status": "CREATED",
120 "name": "string",
121 "erpSystemId": 0
122 },
123 "costCenter": {
124 "id": 0,
125 "displayId": "string",
126 "status": "CREATED",
127 "name": "string",
128 "erpSystemId": 0
129 },
130 "profitCenter": {
131 "id": 0,
132 "displayId": "string",
133 "status": "CREATED",
134 "name": "string",
135 "validTo": "2019-08-24",
136 "erpSystemId": 0,
137 "erpSystemDisplayId": "string"
138 },
139 "functionalArea": {
140 "id": 0,
141 "displayId": "string",
142 "status": "CREATED",
143 "name": "string",
144 "erpSystemId": 0
145 },
146 "businessArea": {
147 "id": 0,
148 "displayId": "string",
149 "status": "CREATED",
150 "name": "string",
151 "erpSystemId": 0
152 },
153 "segment": {
154 "id": 0,
155 "displayId": "string",
156 "status": "CREATED",
157 "name": "string",
158 "erpSystemId": 0
159 },
160 "network": {
161 "id": 0,
162 "displayId": "string",
163 "status": "CREATED",
164 "name": "string",
165 "erpSystemId": 0
166 },
167 "internalOrderType": {
168 "id": 0,
169 "displayId": "string",
170 "status": "CREATED",
171 "name": "string",
172 "erpSystemId": 0
173 },
174 "internalOrder": {
175 "id": 0,
176 "displayId": "string",
177 "status": "CREATED",
178 "name": "string",
179 "erpSystemId": 0,
180 "internalOrderTypeId": 0
181 },
182 "additionalCurrencies": [
183 {
184 "id": 0,
185 "amount": 0,
186 "currency": {
187 "id": 0,
188 "displayId": "string",
189 "status": "CREATED",
190 "name": "string",
191 "decimalPoints": 0
192 },
193 "conversionRate": 0,
194 "conversionDate": "2019-08-24",
195 "translationDateType": "DOCUMENT_DATE",
196 "amountType": "NET_AMOUNT",
197 "currencyDefinitionType": "CONTRACT_CURRENCY",
198 "invoiceEntryId": 0,
199 "invoiceEntryDisplayId": "string"
200 }
201 ],
202 "scheduledPaymentMatches": [
203 {
204 "id": 0,
205 "fromId": 0,
206 "toId": 0,
207 "amount": 0
208 }
209 ],
210 "goodsReceiptLineItemLinks": [
211 {
212 "id": 0,
213 "fromId": 0,
214 "toId": 0,
215 "linkedQuantity": 0
216 }
217 ],
218 "invoiceId": 0,
219 "invoiceDisplayId": "string",
220 "invoiceState": "INV_DRAFT",
221 "vendorPaymentId": 0,
222 "purchaseOrderLineItemId": 0,
223 "netAmount": 0,
224 "allowsSystemGenerateNewId": true,
225 "numberRangeIdentifierValue": "string",
226 "numberRangeIdentifierType": {
227 "name": "string"
228 },
229 "numberRangeType": {
230 "name": "string"
231 }
232 }
233 ],
234 "goodsReceiptLineItems": [
235 {
236 "id": 0,
237 "displayId": "string",
238 "quantity": 0,
239 "invoicedQuantity": 0,
240 "description": "string",
241 "expenseCategory": {
242 "id": 0,
243 "displayId": "string",
244 "status": "CREATED",
245 "name": "string",
246 "expenseCategoryType": "PAYMENT"
247 },
248 "goodsReceiptId": 0,
249 "goodsReceiptDisplayId": "string",
250 "goodsReceiptState": "INV_DRAFT",
251 "purchaseOrderLineItemId": 0,
252 "invoiceLineItemLinks": [
253 {
254 "id": 0,
255 "fromId": 0,
256 "toId": 0,
257 "linkedQuantity": 0
258 }
259 ],
260 "allowsSystemGenerateNewId": true,
261 "numberRangeIdentifierValue": "string",
262 "numberRangeIdentifierType": {
263 "name": "string"
264 },
265 "numberRangeType": {
266 "name": "string"
267 }
268 }
269 ],
270 "vendorPaymentId": 0,
271 "purchaseRequisitionLineItemId": 0,
272 "purchaseRequisitionDisplayId": "string",
273 "purchaseRequisitionLineItemAvailableQuantity": 0,
274 "allowsSystemGenerateNewId": true,
275 "numberRangeIdentifierValue": "string",
276 "numberRangeIdentifierType": {
277 "name": "string"
278 },
279 "numberRangeType": {
280 "name": "string"
281 }
282}
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 "quantity": 0,
18 "allocatedQuantity": 0,
19 "receivedQuantity": 0,
20 "unitPrice": 0,
21 "description": "string",
22 "expenseCategory": {
23 "id": 0,
24 "displayId": "string",
25 "status": "CREATED",
26 "name": "string",
27 "expenseCategoryType": "PAYMENT"
28 },
29 "costCenter": {
30 "id": 0,
31 "displayId": "string",
32 "status": "CREATED",
33 "name": "string",
34 "erpSystemId": 0
35 },
36 "profitCenter": {
37 "id": 0,
38 "displayId": "string",
39 "status": "CREATED",
40 "name": "string",
41 "validTo": "2019-08-24",
42 "erpSystemId": 0,
43 "erpSystemDisplayId": "string"
44 },
45 "taxJurisdiction": {
46 "id": 0,
47 "displayId": "string",
48 "status": "CREATED",
49 "name": "string",
50 "erpSystemId": 0,
51 "schema": "string",
52 "countryDisplayId": "string"
53 },
54 "taxCode": {
55 "id": 0,
56 "displayId": "string",
57 "status": "CREATED",
58 "name": "string",
59 "erpSystemId": 0
60 },
61 "taxLineItems": [
62 {
63 "id": 0,
64 "taxRate": 0.1,
65 "taxAmount": 0,
66 "taxType": "string",
67 "purchaseOrderLineItemId": 0
68 }
69 ],
70 "purchaseOrderId": 0,
71 "purchaseOrderDisplayId": "string",
72 "purchaseOrderState": "INV_DRAFT",
73 "invoiceLineItems": [
74 {
75 "id": 0,
76 "displayId": "string",
77 "expenseCategory": {
78 "id": 0,
79 "displayId": "string",
80 "status": "CREATED",
81 "name": "string",
82 "expenseCategoryType": "PAYMENT"
83 },
84 "description": "string",
85 "unitOfMeasure": {
86 "id": 0,
87 "displayId": "string",
88 "status": "CREATED",
89 "name": "string",
90 "erpSystemId": 0
91 },
92 "quantity": 0,
93 "unitPrice": 0,
94 "taxJurisdiction": {
95 "id": 0,
96 "displayId": "string",
97 "status": "CREATED",
98 "name": "string",
99 "erpSystemId": 0,
100 "schema": "string",
101 "countryDisplayId": "string"
102 },
103 "taxCode": {
104 "id": 0,
105 "displayId": "string",
106 "status": "CREATED",
107 "name": "string",
108 "erpSystemId": 0
109 },
110 "taxExpenseAccount": {
111 "id": 0,
112 "displayId": "string",
113 "generalLedgerAccountName": "string",
114 "generalLedgerAccountCode": "string",
115 "openItemManagement": true,
116 "accountCategory": "BALANCESHEET",
117 "shortName": "string",
118 "longName": "string"
119 },
120 "taxLineItems": [
121 {
122 "id": 0,
123 "taxRate": 0.1,
124 "taxAmount": 0,
125 "taxType": "string",
126 "invoiceLineItemId": 0
127 }
128 ],
129 "workBreakdownStructure": {
130 "id": 0,
131 "displayId": "string",
132 "status": "CREATED",
133 "name": "string",
134 "erpSystemId": 0
135 },
136 "costCenter": {
137 "id": 0,
138 "displayId": "string",
139 "status": "CREATED",
140 "name": "string",
141 "erpSystemId": 0
142 },
143 "profitCenter": {
144 "id": 0,
145 "displayId": "string",
146 "status": "CREATED",
147 "name": "string",
148 "validTo": "2019-08-24",
149 "erpSystemId": 0,
150 "erpSystemDisplayId": "string"
151 },
152 "functionalArea": {
153 "id": 0,
154 "displayId": "string",
155 "status": "CREATED",
156 "name": "string",
157 "erpSystemId": 0
158 },
159 "businessArea": {
160 "id": 0,
161 "displayId": "string",
162 "status": "CREATED",
163 "name": "string",
164 "erpSystemId": 0
165 },
166 "segment": {
167 "id": 0,
168 "displayId": "string",
169 "status": "CREATED",
170 "name": "string",
171 "erpSystemId": 0
172 },
173 "network": {
174 "id": 0,
175 "displayId": "string",
176 "status": "CREATED",
177 "name": "string",
178 "erpSystemId": 0
179 },
180 "internalOrderType": {
181 "id": 0,
182 "displayId": "string",
183 "status": "CREATED",
184 "name": "string",
185 "erpSystemId": 0
186 },
187 "internalOrder": {
188 "id": 0,
189 "displayId": "string",
190 "status": "CREATED",
191 "name": "string",
192 "erpSystemId": 0,
193 "internalOrderTypeId": 0
194 },
195 "additionalCurrencies": [
196 {
197 "id": 0,
198 "amount": 0,
199 "currency": {
200 "id": 0,
201 "displayId": "string",
202 "status": "CREATED",
203 "name": "string",
204 "decimalPoints": 0
205 },
206 "conversionRate": 0,
207 "conversionDate": "2019-08-24",
208 "translationDateType": "DOCUMENT_DATE",
209 "amountType": "NET_AMOUNT",
210 "currencyDefinitionType": "CONTRACT_CURRENCY",
211 "invoiceEntryId": 0,
212 "invoiceEntryDisplayId": "string"
213 }
214 ],
215 "scheduledPaymentMatches": [
216 {
217 "id": 0,
218 "fromId": 0,
219 "toId": 0,
220 "amount": 0
221 }
222 ],
223 "goodsReceiptLineItemLinks": [
224 {
225 "id": 0,
226 "fromId": 0,
227 "toId": 0,
228 "linkedQuantity": 0
229 }
230 ],
231 "invoiceId": 0,
232 "invoiceDisplayId": "string",
233 "invoiceState": "INV_DRAFT",
234 "vendorPaymentId": 0,
235 "purchaseOrderLineItemId": 0,
236 "netAmount": 0,
237 "allowsSystemGenerateNewId": true,
238 "numberRangeIdentifierValue": "string",
239 "numberRangeIdentifierType": {
240 "name": "string"
241 },
242 "numberRangeType": {
243 "name": "string"
244 }
245 }
246 ],
247 "goodsReceiptLineItems": [
248 {
249 "id": 0,
250 "displayId": "string",
251 "quantity": 0,
252 "invoicedQuantity": 0,
253 "description": "string",
254 "expenseCategory": {
255 "id": 0,
256 "displayId": "string",
257 "status": "CREATED",
258 "name": "string",
259 "expenseCategoryType": "PAYMENT"
260 },
261 "goodsReceiptId": 0,
262 "goodsReceiptDisplayId": "string",
263 "goodsReceiptState": "INV_DRAFT",
264 "purchaseOrderLineItemId": 0,
265 "invoiceLineItemLinks": [
266 {
267 "id": 0,
268 "fromId": 0,
269 "toId": 0,
270 "linkedQuantity": 0
271 }
272 ],
273 "availableQuantity": 0,
274 "allowsSystemGenerateNewId": true,
275 "numberRangeIdentifierValue": "string",
276 "numberRangeIdentifierType": {
277 "name": "string"
278 },
279 "numberRangeType": {
280 "name": "string"
281 }
282 }
283 ],
284 "vendorPaymentId": 0,
285 "purchaseRequisitionLineItemId": 0,
286 "purchaseRequisitionDisplayId": "string",
287 "purchaseRequisitionLineItemAvailableQuantity": 0,
288 "remainingQuantity": 0,
289 "availableQuantity": 0,
290 "allowsSystemGenerateNewId": true,
291 "numberRangeIdentifierValue": "string",
292 "numberRangeIdentifierType": {
293 "name": "string"
294 },
295 "numberRangeType": {
296 "name": "string"
297 }
298 }
299}
Delete A Single Resource¶
HTTP Request
DELETE /api/v1/purchase-order-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/purchase-order-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 of the purchase order line item, including quantity, price adjustments, and any relevant notes for effective order management. |
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 "quantity": 0,
18 "allocatedQuantity": 0,
19 "receivedQuantity": 0,
20 "unitPrice": 0,
21 "description": "string",
22 "expenseCategory": {
23 "id": 0,
24 "displayId": "string",
25 "status": "CREATED",
26 "name": "string",
27 "expenseCategoryType": "PAYMENT"
28 },
29 "costCenter": {
30 "id": 0,
31 "displayId": "string",
32 "status": "CREATED",
33 "name": "string",
34 "erpSystemId": 0
35 },
36 "profitCenter": {
37 "id": 0,
38 "displayId": "string",
39 "status": "CREATED",
40 "name": "string",
41 "validTo": "2019-08-24",
42 "erpSystemId": 0,
43 "erpSystemDisplayId": "string"
44 },
45 "taxJurisdiction": {
46 "id": 0,
47 "displayId": "string",
48 "status": "CREATED",
49 "name": "string",
50 "erpSystemId": 0,
51 "schema": "string",
52 "countryDisplayId": "string"
53 },
54 "taxCode": {
55 "id": 0,
56 "displayId": "string",
57 "status": "CREATED",
58 "name": "string",
59 "erpSystemId": 0
60 },
61 "taxLineItems": [
62 {
63 "id": 0,
64 "taxRate": 0.1,
65 "taxAmount": 0,
66 "taxType": "string",
67 "purchaseOrderLineItemId": 0
68 }
69 ],
70 "purchaseOrderId": 0,
71 "purchaseOrderDisplayId": "string",
72 "purchaseOrderState": "INV_DRAFT",
73 "invoiceLineItems": [
74 {
75 "id": 0,
76 "displayId": "string",
77 "expenseCategory": {
78 "id": 0,
79 "displayId": "string",
80 "status": "CREATED",
81 "name": "string",
82 "expenseCategoryType": "PAYMENT"
83 },
84 "description": "string",
85 "unitOfMeasure": {
86 "id": 0,
87 "displayId": "string",
88 "status": "CREATED",
89 "name": "string",
90 "erpSystemId": 0
91 },
92 "quantity": 0,
93 "unitPrice": 0,
94 "taxJurisdiction": {
95 "id": 0,
96 "displayId": "string",
97 "status": "CREATED",
98 "name": "string",
99 "erpSystemId": 0,
100 "schema": "string",
101 "countryDisplayId": "string"
102 },
103 "taxCode": {
104 "id": 0,
105 "displayId": "string",
106 "status": "CREATED",
107 "name": "string",
108 "erpSystemId": 0
109 },
110 "taxExpenseAccount": {
111 "id": 0,
112 "displayId": "string",
113 "generalLedgerAccountName": "string",
114 "generalLedgerAccountCode": "string",
115 "openItemManagement": true,
116 "accountCategory": "BALANCESHEET",
117 "shortName": "string",
118 "longName": "string"
119 },
120 "taxLineItems": [
121 {
122 "id": 0,
123 "taxRate": 0.1,
124 "taxAmount": 0,
125 "taxType": "string",
126 "invoiceLineItemId": 0
127 }
128 ],
129 "workBreakdownStructure": {
130 "id": 0,
131 "displayId": "string",
132 "status": "CREATED",
133 "name": "string",
134 "erpSystemId": 0
135 },
136 "costCenter": {
137 "id": 0,
138 "displayId": "string",
139 "status": "CREATED",
140 "name": "string",
141 "erpSystemId": 0
142 },
143 "profitCenter": {
144 "id": 0,
145 "displayId": "string",
146 "status": "CREATED",
147 "name": "string",
148 "validTo": "2019-08-24",
149 "erpSystemId": 0,
150 "erpSystemDisplayId": "string"
151 },
152 "functionalArea": {
153 "id": 0,
154 "displayId": "string",
155 "status": "CREATED",
156 "name": "string",
157 "erpSystemId": 0
158 },
159 "businessArea": {
160 "id": 0,
161 "displayId": "string",
162 "status": "CREATED",
163 "name": "string",
164 "erpSystemId": 0
165 },
166 "segment": {
167 "id": 0,
168 "displayId": "string",
169 "status": "CREATED",
170 "name": "string",
171 "erpSystemId": 0
172 },
173 "network": {
174 "id": 0,
175 "displayId": "string",
176 "status": "CREATED",
177 "name": "string",
178 "erpSystemId": 0
179 },
180 "internalOrderType": {
181 "id": 0,
182 "displayId": "string",
183 "status": "CREATED",
184 "name": "string",
185 "erpSystemId": 0
186 },
187 "internalOrder": {
188 "id": 0,
189 "displayId": "string",
190 "status": "CREATED",
191 "name": "string",
192 "erpSystemId": 0,
193 "internalOrderTypeId": 0
194 },
195 "additionalCurrencies": [
196 {
197 "id": 0,
198 "amount": 0,
199 "currency": {
200 "id": 0,
201 "displayId": "string",
202 "status": "CREATED",
203 "name": "string",
204 "decimalPoints": 0
205 },
206 "conversionRate": 0,
207 "conversionDate": "2019-08-24",
208 "translationDateType": "DOCUMENT_DATE",
209 "amountType": "NET_AMOUNT",
210 "currencyDefinitionType": "CONTRACT_CURRENCY",
211 "invoiceEntryId": 0,
212 "invoiceEntryDisplayId": "string"
213 }
214 ],
215 "scheduledPaymentMatches": [
216 {
217 "id": 0,
218 "fromId": 0,
219 "toId": 0,
220 "amount": 0
221 }
222 ],
223 "goodsReceiptLineItemLinks": [
224 {
225 "id": 0,
226 "fromId": 0,
227 "toId": 0,
228 "linkedQuantity": 0
229 }
230 ],
231 "invoiceId": 0,
232 "invoiceDisplayId": "string",
233 "invoiceState": "INV_DRAFT",
234 "vendorPaymentId": 0,
235 "purchaseOrderLineItemId": 0,
236 "netAmount": 0,
237 "allowsSystemGenerateNewId": true,
238 "numberRangeIdentifierValue": "string",
239 "numberRangeIdentifierType": {
240 "name": "string"
241 },
242 "numberRangeType": {
243 "name": "string"
244 }
245 }
246 ],
247 "goodsReceiptLineItems": [
248 {
249 "id": 0,
250 "displayId": "string",
251 "quantity": 0,
252 "invoicedQuantity": 0,
253 "description": "string",
254 "expenseCategory": {
255 "id": 0,
256 "displayId": "string",
257 "status": "CREATED",
258 "name": "string",
259 "expenseCategoryType": "PAYMENT"
260 },
261 "goodsReceiptId": 0,
262 "goodsReceiptDisplayId": "string",
263 "goodsReceiptState": "INV_DRAFT",
264 "purchaseOrderLineItemId": 0,
265 "invoiceLineItemLinks": [
266 {
267 "id": 0,
268 "fromId": 0,
269 "toId": 0,
270 "linkedQuantity": 0
271 }
272 ],
273 "availableQuantity": 0,
274 "allowsSystemGenerateNewId": true,
275 "numberRangeIdentifierValue": "string",
276 "numberRangeIdentifierType": {
277 "name": "string"
278 },
279 "numberRangeType": {
280 "name": "string"
281 }
282 }
283 ],
284 "vendorPaymentId": 0,
285 "purchaseRequisitionLineItemId": 0,
286 "purchaseRequisitionDisplayId": "string",
287 "purchaseRequisitionLineItemAvailableQuantity": 0,
288 "remainingQuantity": 0,
289 "availableQuantity": 0,
290 "allowsSystemGenerateNewId": true,
291 "numberRangeIdentifierValue": "string",
292 "numberRangeIdentifierType": {
293 "name": "string"
294 },
295 "numberRangeType": {
296 "name": "string"
297 }
298 }
299}
Bulk Create-Or-Update Resources¶
HTTP Request
PUT /api/v1/purchase-order-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 purchase order line item details for bulk creation or updates, including item identifiers, quantities, and pricing information. |
Body Parameters
1[
2 {
3 "id": 0,
4 "displayId": "string",
5 "quantity": 0,
6 "allocatedQuantity": 0,
7 "receivedQuantity": 0,
8 "unitPrice": 0,
9 "description": "string",
10 "expenseCategory": {
11 "id": 0,
12 "displayId": "string",
13 "status": "CREATED",
14 "name": "string",
15 "expenseCategoryType": "PAYMENT"
16 },
17 "costCenter": {
18 "id": 0,
19 "displayId": "string",
20 "status": "CREATED",
21 "name": "string",
22 "erpSystemId": 0
23 },
24 "profitCenter": {
25 "id": 0,
26 "displayId": "string",
27 "status": "CREATED",
28 "name": "string",
29 "validTo": "2019-08-24",
30 "erpSystemId": 0,
31 "erpSystemDisplayId": "string"
32 },
33 "taxJurisdiction": {
34 "id": 0,
35 "displayId": "string",
36 "status": "CREATED",
37 "name": "string",
38 "erpSystemId": 0,
39 "schema": "string",
40 "countryDisplayId": "string"
41 },
42 "taxCode": {
43 "id": 0,
44 "displayId": "string",
45 "status": "CREATED",
46 "name": "string",
47 "erpSystemId": 0
48 },
49 "taxLineItems": [
50 {
51 "id": 0,
52 "taxRate": 0.1,
53 "taxAmount": 0,
54 "taxType": "string",
55 "purchaseOrderLineItemId": 0
56 }
57 ],
58 "purchaseOrderId": 0,
59 "purchaseOrderDisplayId": "string",
60 "purchaseOrderState": "INV_DRAFT",
61 "invoiceLineItems": [
62 {
63 "id": 0,
64 "displayId": "string",
65 "expenseCategory": {
66 "id": 0,
67 "displayId": "string",
68 "status": "CREATED",
69 "name": "string",
70 "expenseCategoryType": "PAYMENT"
71 },
72 "description": "string",
73 "unitOfMeasure": {
74 "id": 0,
75 "displayId": "string",
76 "status": "CREATED",
77 "name": "string",
78 "erpSystemId": 0
79 },
80 "quantity": 0,
81 "unitPrice": 0,
82 "taxJurisdiction": {
83 "id": 0,
84 "displayId": "string",
85 "status": "CREATED",
86 "name": "string",
87 "erpSystemId": 0,
88 "schema": "string",
89 "countryDisplayId": "string"
90 },
91 "taxCode": {
92 "id": 0,
93 "displayId": "string",
94 "status": "CREATED",
95 "name": "string",
96 "erpSystemId": 0
97 },
98 "taxExpenseAccount": {
99 "id": 0,
100 "displayId": "string",
101 "generalLedgerAccountName": "string",
102 "generalLedgerAccountCode": "string",
103 "openItemManagement": true,
104 "accountCategory": "BALANCESHEET",
105 "shortName": "string",
106 "longName": "string"
107 },
108 "taxLineItems": [
109 {
110 "id": 0,
111 "taxRate": 0.1,
112 "taxAmount": 0,
113 "taxType": "string",
114 "invoiceLineItemId": 0
115 }
116 ],
117 "workBreakdownStructure": {
118 "id": 0,
119 "displayId": "string",
120 "status": "CREATED",
121 "name": "string",
122 "erpSystemId": 0
123 },
124 "costCenter": {
125 "id": 0,
126 "displayId": "string",
127 "status": "CREATED",
128 "name": "string",
129 "erpSystemId": 0
130 },
131 "profitCenter": {
132 "id": 0,
133 "displayId": "string",
134 "status": "CREATED",
135 "name": "string",
136 "validTo": "2019-08-24",
137 "erpSystemId": 0,
138 "erpSystemDisplayId": "string"
139 },
140 "functionalArea": {
141 "id": 0,
142 "displayId": "string",
143 "status": "CREATED",
144 "name": "string",
145 "erpSystemId": 0
146 },
147 "businessArea": {
148 "id": 0,
149 "displayId": "string",
150 "status": "CREATED",
151 "name": "string",
152 "erpSystemId": 0
153 },
154 "segment": {
155 "id": 0,
156 "displayId": "string",
157 "status": "CREATED",
158 "name": "string",
159 "erpSystemId": 0
160 },
161 "network": {
162 "id": 0,
163 "displayId": "string",
164 "status": "CREATED",
165 "name": "string",
166 "erpSystemId": 0
167 },
168 "internalOrderType": {
169 "id": 0,
170 "displayId": "string",
171 "status": "CREATED",
172 "name": "string",
173 "erpSystemId": 0
174 },
175 "internalOrder": {
176 "id": 0,
177 "displayId": "string",
178 "status": "CREATED",
179 "name": "string",
180 "erpSystemId": 0,
181 "internalOrderTypeId": 0
182 },
183 "additionalCurrencies": [
184 {
185 "id": 0,
186 "amount": 0,
187 "currency": {
188 "id": 0,
189 "displayId": "string",
190 "status": "CREATED",
191 "name": "string",
192 "decimalPoints": 0
193 },
194 "conversionRate": 0,
195 "conversionDate": "2019-08-24",
196 "translationDateType": "DOCUMENT_DATE",
197 "amountType": "NET_AMOUNT",
198 "currencyDefinitionType": "CONTRACT_CURRENCY",
199 "invoiceEntryId": 0,
200 "invoiceEntryDisplayId": "string"
201 }
202 ],
203 "scheduledPaymentMatches": [
204 {
205 "id": 0,
206 "fromId": 0,
207 "toId": 0,
208 "amount": 0
209 }
210 ],
211 "goodsReceiptLineItemLinks": [
212 {
213 "id": 0,
214 "fromId": 0,
215 "toId": 0,
216 "linkedQuantity": 0
217 }
218 ],
219 "invoiceId": 0,
220 "invoiceDisplayId": "string",
221 "invoiceState": "INV_DRAFT",
222 "vendorPaymentId": 0,
223 "purchaseOrderLineItemId": 0,
224 "netAmount": 0,
225 "allowsSystemGenerateNewId": true,
226 "numberRangeIdentifierValue": "string",
227 "numberRangeIdentifierType": {
228 "name": "string"
229 },
230 "numberRangeType": {
231 "name": "string"
232 }
233 }
234 ],
235 "goodsReceiptLineItems": [
236 {
237 "id": 0,
238 "displayId": "string",
239 "quantity": 0,
240 "invoicedQuantity": 0,
241 "description": "string",
242 "expenseCategory": {
243 "id": 0,
244 "displayId": "string",
245 "status": "CREATED",
246 "name": "string",
247 "expenseCategoryType": "PAYMENT"
248 },
249 "goodsReceiptId": 0,
250 "goodsReceiptDisplayId": "string",
251 "goodsReceiptState": "INV_DRAFT",
252 "purchaseOrderLineItemId": 0,
253 "invoiceLineItemLinks": [
254 {
255 "id": 0,
256 "fromId": 0,
257 "toId": 0,
258 "linkedQuantity": 0
259 }
260 ],
261 "allowsSystemGenerateNewId": true,
262 "numberRangeIdentifierValue": "string",
263 "numberRangeIdentifierType": {
264 "name": "string"
265 },
266 "numberRangeType": {
267 "name": "string"
268 }
269 }
270 ],
271 "vendorPaymentId": 0,
272 "purchaseRequisitionLineItemId": 0,
273 "purchaseRequisitionDisplayId": "string",
274 "purchaseRequisitionLineItemAvailableQuantity": 0,
275 "allowsSystemGenerateNewId": true,
276 "numberRangeIdentifierValue": "string",
277 "numberRangeIdentifierType": {
278 "name": "string"
279 },
280 "numberRangeType": {
281 "name": "string"
282 }
283 }
284]
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 "quantity": 0,
19 "allocatedQuantity": 0,
20 "receivedQuantity": 0,
21 "unitPrice": 0,
22 "description": "string",
23 "expenseCategory": {
24 "id": 0,
25 "displayId": "string",
26 "status": "CREATED",
27 "name": "string",
28 "expenseCategoryType": "PAYMENT"
29 },
30 "costCenter": {
31 "id": 0,
32 "displayId": "string",
33 "status": "CREATED",
34 "name": "string",
35 "erpSystemId": 0
36 },
37 "profitCenter": {
38 "id": 0,
39 "displayId": "string",
40 "status": "CREATED",
41 "name": "string",
42 "validTo": "2019-08-24",
43 "erpSystemId": 0,
44 "erpSystemDisplayId": "string"
45 },
46 "taxJurisdiction": {
47 "id": 0,
48 "displayId": "string",
49 "status": "CREATED",
50 "name": "string",
51 "erpSystemId": 0,
52 "schema": "string",
53 "countryDisplayId": "string"
54 },
55 "taxCode": {
56 "id": 0,
57 "displayId": "string",
58 "status": "CREATED",
59 "name": "string",
60 "erpSystemId": 0
61 },
62 "taxLineItems": [
63 {
64 "id": 0,
65 "taxRate": 0.1,
66 "taxAmount": 0,
67 "taxType": "string",
68 "purchaseOrderLineItemId": 0
69 }
70 ],
71 "purchaseOrderId": 0,
72 "purchaseOrderDisplayId": "string",
73 "purchaseOrderState": "INV_DRAFT",
74 "invoiceLineItems": [
75 {
76 "id": 0,
77 "displayId": "string",
78 "expenseCategory": {
79 "id": 0,
80 "displayId": "string",
81 "status": "CREATED",
82 "name": "string",
83 "expenseCategoryType": "PAYMENT"
84 },
85 "description": "string",
86 "unitOfMeasure": {
87 "id": 0,
88 "displayId": "string",
89 "status": "CREATED",
90 "name": "string",
91 "erpSystemId": 0
92 },
93 "quantity": 0,
94 "unitPrice": 0,
95 "taxJurisdiction": {
96 "id": 0,
97 "displayId": "string",
98 "status": "CREATED",
99 "name": "string",
100 "erpSystemId": 0,
101 "schema": "string",
102 "countryDisplayId": "string"
103 },
104 "taxCode": {
105 "id": 0,
106 "displayId": "string",
107 "status": "CREATED",
108 "name": "string",
109 "erpSystemId": 0
110 },
111 "taxExpenseAccount": {
112 "id": 0,
113 "displayId": "string",
114 "generalLedgerAccountName": "string",
115 "generalLedgerAccountCode": "string",
116 "openItemManagement": true,
117 "accountCategory": "BALANCESHEET",
118 "shortName": "string",
119 "longName": "string"
120 },
121 "taxLineItems": [
122 {
123 "id": 0,
124 "taxRate": 0.1,
125 "taxAmount": 0,
126 "taxType": "string",
127 "invoiceLineItemId": 0
128 }
129 ],
130 "workBreakdownStructure": {
131 "id": 0,
132 "displayId": "string",
133 "status": "CREATED",
134 "name": "string",
135 "erpSystemId": 0
136 },
137 "costCenter": {
138 "id": 0,
139 "displayId": "string",
140 "status": "CREATED",
141 "name": "string",
142 "erpSystemId": 0
143 },
144 "profitCenter": {
145 "id": 0,
146 "displayId": "string",
147 "status": "CREATED",
148 "name": "string",
149 "validTo": "2019-08-24",
150 "erpSystemId": 0,
151 "erpSystemDisplayId": "string"
152 },
153 "functionalArea": {
154 "id": 0,
155 "displayId": "string",
156 "status": "CREATED",
157 "name": "string",
158 "erpSystemId": 0
159 },
160 "businessArea": {
161 "id": 0,
162 "displayId": "string",
163 "status": "CREATED",
164 "name": "string",
165 "erpSystemId": 0
166 },
167 "segment": {
168 "id": 0,
169 "displayId": "string",
170 "status": "CREATED",
171 "name": "string",
172 "erpSystemId": 0
173 },
174 "network": {
175 "id": 0,
176 "displayId": "string",
177 "status": "CREATED",
178 "name": "string",
179 "erpSystemId": 0
180 },
181 "internalOrderType": {
182 "id": 0,
183 "displayId": "string",
184 "status": "CREATED",
185 "name": "string",
186 "erpSystemId": 0
187 },
188 "internalOrder": {
189 "id": 0,
190 "displayId": "string",
191 "status": "CREATED",
192 "name": "string",
193 "erpSystemId": 0,
194 "internalOrderTypeId": 0
195 },
196 "additionalCurrencies": [
197 {
198 "id": 0,
199 "amount": 0,
200 "currency": {
201 "id": 0,
202 "displayId": "string",
203 "status": "CREATED",
204 "name": "string",
205 "decimalPoints": 0
206 },
207 "conversionRate": 0,
208 "conversionDate": "2019-08-24",
209 "translationDateType": "DOCUMENT_DATE",
210 "amountType": "NET_AMOUNT",
211 "currencyDefinitionType": "CONTRACT_CURRENCY",
212 "invoiceEntryId": 0,
213 "invoiceEntryDisplayId": "string"
214 }
215 ],
216 "scheduledPaymentMatches": [
217 {
218 "id": 0,
219 "fromId": 0,
220 "toId": 0,
221 "amount": 0
222 }
223 ],
224 "goodsReceiptLineItemLinks": [
225 {
226 "id": 0,
227 "fromId": 0,
228 "toId": 0,
229 "linkedQuantity": 0
230 }
231 ],
232 "invoiceId": 0,
233 "invoiceDisplayId": "string",
234 "invoiceState": "INV_DRAFT",
235 "vendorPaymentId": 0,
236 "purchaseOrderLineItemId": 0,
237 "netAmount": 0,
238 "allowsSystemGenerateNewId": true,
239 "numberRangeIdentifierValue": "string",
240 "numberRangeIdentifierType": {
241 "name": "string"
242 },
243 "numberRangeType": {
244 "name": "string"
245 }
246 }
247 ],
248 "goodsReceiptLineItems": [
249 {
250 "id": 0,
251 "displayId": "string",
252 "quantity": 0,
253 "invoicedQuantity": 0,
254 "description": "string",
255 "expenseCategory": {
256 "id": 0,
257 "displayId": "string",
258 "status": "CREATED",
259 "name": "string",
260 "expenseCategoryType": "PAYMENT"
261 },
262 "goodsReceiptId": 0,
263 "goodsReceiptDisplayId": "string",
264 "goodsReceiptState": "INV_DRAFT",
265 "purchaseOrderLineItemId": 0,
266 "invoiceLineItemLinks": [
267 {
268 "id": 0,
269 "fromId": 0,
270 "toId": 0,
271 "linkedQuantity": 0
272 }
273 ],
274 "availableQuantity": 0,
275 "allowsSystemGenerateNewId": true,
276 "numberRangeIdentifierValue": "string",
277 "numberRangeIdentifierType": {
278 "name": "string"
279 },
280 "numberRangeType": {
281 "name": "string"
282 }
283 }
284 ],
285 "vendorPaymentId": 0,
286 "purchaseRequisitionLineItemId": 0,
287 "purchaseRequisitionDisplayId": "string",
288 "purchaseRequisitionLineItemAvailableQuantity": 0,
289 "remainingQuantity": 0,
290 "availableQuantity": 0,
291 "allowsSystemGenerateNewId": true,
292 "numberRangeIdentifierValue": "string",
293 "numberRangeIdentifierType": {
294 "name": "string"
295 },
296 "numberRangeType": {
297 "name": "string"
298 }
299 }
300 ]
301}
Create Or Update A Resource¶
HTTP Request
PUT /api/v1/purchase-order-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 purchase order line item details, including item specifications, quantities, and pricing information for creation or update purposes. |
Body Parameters
1{
2 "id": 0,
3 "displayId": "string",
4 "quantity": 0,
5 "allocatedQuantity": 0,
6 "receivedQuantity": 0,
7 "unitPrice": 0,
8 "description": "string",
9 "expenseCategory": {
10 "id": 0,
11 "displayId": "string",
12 "status": "CREATED",
13 "name": "string",
14 "expenseCategoryType": "PAYMENT"
15 },
16 "costCenter": {
17 "id": 0,
18 "displayId": "string",
19 "status": "CREATED",
20 "name": "string",
21 "erpSystemId": 0
22 },
23 "profitCenter": {
24 "id": 0,
25 "displayId": "string",
26 "status": "CREATED",
27 "name": "string",
28 "validTo": "2019-08-24",
29 "erpSystemId": 0,
30 "erpSystemDisplayId": "string"
31 },
32 "taxJurisdiction": {
33 "id": 0,
34 "displayId": "string",
35 "status": "CREATED",
36 "name": "string",
37 "erpSystemId": 0,
38 "schema": "string",
39 "countryDisplayId": "string"
40 },
41 "taxCode": {
42 "id": 0,
43 "displayId": "string",
44 "status": "CREATED",
45 "name": "string",
46 "erpSystemId": 0
47 },
48 "taxLineItems": [
49 {
50 "id": 0,
51 "taxRate": 0.1,
52 "taxAmount": 0,
53 "taxType": "string",
54 "purchaseOrderLineItemId": 0
55 }
56 ],
57 "purchaseOrderId": 0,
58 "purchaseOrderDisplayId": "string",
59 "purchaseOrderState": "INV_DRAFT",
60 "invoiceLineItems": [
61 {
62 "id": 0,
63 "displayId": "string",
64 "expenseCategory": {
65 "id": 0,
66 "displayId": "string",
67 "status": "CREATED",
68 "name": "string",
69 "expenseCategoryType": "PAYMENT"
70 },
71 "description": "string",
72 "unitOfMeasure": {
73 "id": 0,
74 "displayId": "string",
75 "status": "CREATED",
76 "name": "string",
77 "erpSystemId": 0
78 },
79 "quantity": 0,
80 "unitPrice": 0,
81 "taxJurisdiction": {
82 "id": 0,
83 "displayId": "string",
84 "status": "CREATED",
85 "name": "string",
86 "erpSystemId": 0,
87 "schema": "string",
88 "countryDisplayId": "string"
89 },
90 "taxCode": {
91 "id": 0,
92 "displayId": "string",
93 "status": "CREATED",
94 "name": "string",
95 "erpSystemId": 0
96 },
97 "taxExpenseAccount": {
98 "id": 0,
99 "displayId": "string",
100 "generalLedgerAccountName": "string",
101 "generalLedgerAccountCode": "string",
102 "openItemManagement": true,
103 "accountCategory": "BALANCESHEET",
104 "shortName": "string",
105 "longName": "string"
106 },
107 "taxLineItems": [
108 {
109 "id": 0,
110 "taxRate": 0.1,
111 "taxAmount": 0,
112 "taxType": "string",
113 "invoiceLineItemId": 0
114 }
115 ],
116 "workBreakdownStructure": {
117 "id": 0,
118 "displayId": "string",
119 "status": "CREATED",
120 "name": "string",
121 "erpSystemId": 0
122 },
123 "costCenter": {
124 "id": 0,
125 "displayId": "string",
126 "status": "CREATED",
127 "name": "string",
128 "erpSystemId": 0
129 },
130 "profitCenter": {
131 "id": 0,
132 "displayId": "string",
133 "status": "CREATED",
134 "name": "string",
135 "validTo": "2019-08-24",
136 "erpSystemId": 0,
137 "erpSystemDisplayId": "string"
138 },
139 "functionalArea": {
140 "id": 0,
141 "displayId": "string",
142 "status": "CREATED",
143 "name": "string",
144 "erpSystemId": 0
145 },
146 "businessArea": {
147 "id": 0,
148 "displayId": "string",
149 "status": "CREATED",
150 "name": "string",
151 "erpSystemId": 0
152 },
153 "segment": {
154 "id": 0,
155 "displayId": "string",
156 "status": "CREATED",
157 "name": "string",
158 "erpSystemId": 0
159 },
160 "network": {
161 "id": 0,
162 "displayId": "string",
163 "status": "CREATED",
164 "name": "string",
165 "erpSystemId": 0
166 },
167 "internalOrderType": {
168 "id": 0,
169 "displayId": "string",
170 "status": "CREATED",
171 "name": "string",
172 "erpSystemId": 0
173 },
174 "internalOrder": {
175 "id": 0,
176 "displayId": "string",
177 "status": "CREATED",
178 "name": "string",
179 "erpSystemId": 0,
180 "internalOrderTypeId": 0
181 },
182 "additionalCurrencies": [
183 {
184 "id": 0,
185 "amount": 0,
186 "currency": {
187 "id": 0,
188 "displayId": "string",
189 "status": "CREATED",
190 "name": "string",
191 "decimalPoints": 0
192 },
193 "conversionRate": 0,
194 "conversionDate": "2019-08-24",
195 "translationDateType": "DOCUMENT_DATE",
196 "amountType": "NET_AMOUNT",
197 "currencyDefinitionType": "CONTRACT_CURRENCY",
198 "invoiceEntryId": 0,
199 "invoiceEntryDisplayId": "string"
200 }
201 ],
202 "scheduledPaymentMatches": [
203 {
204 "id": 0,
205 "fromId": 0,
206 "toId": 0,
207 "amount": 0
208 }
209 ],
210 "goodsReceiptLineItemLinks": [
211 {
212 "id": 0,
213 "fromId": 0,
214 "toId": 0,
215 "linkedQuantity": 0
216 }
217 ],
218 "invoiceId": 0,
219 "invoiceDisplayId": "string",
220 "invoiceState": "INV_DRAFT",
221 "vendorPaymentId": 0,
222 "purchaseOrderLineItemId": 0,
223 "netAmount": 0,
224 "allowsSystemGenerateNewId": true,
225 "numberRangeIdentifierValue": "string",
226 "numberRangeIdentifierType": {
227 "name": "string"
228 },
229 "numberRangeType": {
230 "name": "string"
231 }
232 }
233 ],
234 "goodsReceiptLineItems": [
235 {
236 "id": 0,
237 "displayId": "string",
238 "quantity": 0,
239 "invoicedQuantity": 0,
240 "description": "string",
241 "expenseCategory": {
242 "id": 0,
243 "displayId": "string",
244 "status": "CREATED",
245 "name": "string",
246 "expenseCategoryType": "PAYMENT"
247 },
248 "goodsReceiptId": 0,
249 "goodsReceiptDisplayId": "string",
250 "goodsReceiptState": "INV_DRAFT",
251 "purchaseOrderLineItemId": 0,
252 "invoiceLineItemLinks": [
253 {
254 "id": 0,
255 "fromId": 0,
256 "toId": 0,
257 "linkedQuantity": 0
258 }
259 ],
260 "allowsSystemGenerateNewId": true,
261 "numberRangeIdentifierValue": "string",
262 "numberRangeIdentifierType": {
263 "name": "string"
264 },
265 "numberRangeType": {
266 "name": "string"
267 }
268 }
269 ],
270 "vendorPaymentId": 0,
271 "purchaseRequisitionLineItemId": 0,
272 "purchaseRequisitionDisplayId": "string",
273 "purchaseRequisitionLineItemAvailableQuantity": 0,
274 "allowsSystemGenerateNewId": true,
275 "numberRangeIdentifierValue": "string",
276 "numberRangeIdentifierType": {
277 "name": "string"
278 },
279 "numberRangeType": {
280 "name": "string"
281 }
282}
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 "quantity": 0,
18 "allocatedQuantity": 0,
19 "receivedQuantity": 0,
20 "unitPrice": 0,
21 "description": "string",
22 "expenseCategory": {
23 "id": 0,
24 "displayId": "string",
25 "status": "CREATED",
26 "name": "string",
27 "expenseCategoryType": "PAYMENT"
28 },
29 "costCenter": {
30 "id": 0,
31 "displayId": "string",
32 "status": "CREATED",
33 "name": "string",
34 "erpSystemId": 0
35 },
36 "profitCenter": {
37 "id": 0,
38 "displayId": "string",
39 "status": "CREATED",
40 "name": "string",
41 "validTo": "2019-08-24",
42 "erpSystemId": 0,
43 "erpSystemDisplayId": "string"
44 },
45 "taxJurisdiction": {
46 "id": 0,
47 "displayId": "string",
48 "status": "CREATED",
49 "name": "string",
50 "erpSystemId": 0,
51 "schema": "string",
52 "countryDisplayId": "string"
53 },
54 "taxCode": {
55 "id": 0,
56 "displayId": "string",
57 "status": "CREATED",
58 "name": "string",
59 "erpSystemId": 0
60 },
61 "taxLineItems": [
62 {
63 "id": 0,
64 "taxRate": 0.1,
65 "taxAmount": 0,
66 "taxType": "string",
67 "purchaseOrderLineItemId": 0
68 }
69 ],
70 "purchaseOrderId": 0,
71 "purchaseOrderDisplayId": "string",
72 "purchaseOrderState": "INV_DRAFT",
73 "invoiceLineItems": [
74 {
75 "id": 0,
76 "displayId": "string",
77 "expenseCategory": {
78 "id": 0,
79 "displayId": "string",
80 "status": "CREATED",
81 "name": "string",
82 "expenseCategoryType": "PAYMENT"
83 },
84 "description": "string",
85 "unitOfMeasure": {
86 "id": 0,
87 "displayId": "string",
88 "status": "CREATED",
89 "name": "string",
90 "erpSystemId": 0
91 },
92 "quantity": 0,
93 "unitPrice": 0,
94 "taxJurisdiction": {
95 "id": 0,
96 "displayId": "string",
97 "status": "CREATED",
98 "name": "string",
99 "erpSystemId": 0,
100 "schema": "string",
101 "countryDisplayId": "string"
102 },
103 "taxCode": {
104 "id": 0,
105 "displayId": "string",
106 "status": "CREATED",
107 "name": "string",
108 "erpSystemId": 0
109 },
110 "taxExpenseAccount": {
111 "id": 0,
112 "displayId": "string",
113 "generalLedgerAccountName": "string",
114 "generalLedgerAccountCode": "string",
115 "openItemManagement": true,
116 "accountCategory": "BALANCESHEET",
117 "shortName": "string",
118 "longName": "string"
119 },
120 "taxLineItems": [
121 {
122 "id": 0,
123 "taxRate": 0.1,
124 "taxAmount": 0,
125 "taxType": "string",
126 "invoiceLineItemId": 0
127 }
128 ],
129 "workBreakdownStructure": {
130 "id": 0,
131 "displayId": "string",
132 "status": "CREATED",
133 "name": "string",
134 "erpSystemId": 0
135 },
136 "costCenter": {
137 "id": 0,
138 "displayId": "string",
139 "status": "CREATED",
140 "name": "string",
141 "erpSystemId": 0
142 },
143 "profitCenter": {
144 "id": 0,
145 "displayId": "string",
146 "status": "CREATED",
147 "name": "string",
148 "validTo": "2019-08-24",
149 "erpSystemId": 0,
150 "erpSystemDisplayId": "string"
151 },
152 "functionalArea": {
153 "id": 0,
154 "displayId": "string",
155 "status": "CREATED",
156 "name": "string",
157 "erpSystemId": 0
158 },
159 "businessArea": {
160 "id": 0,
161 "displayId": "string",
162 "status": "CREATED",
163 "name": "string",
164 "erpSystemId": 0
165 },
166 "segment": {
167 "id": 0,
168 "displayId": "string",
169 "status": "CREATED",
170 "name": "string",
171 "erpSystemId": 0
172 },
173 "network": {
174 "id": 0,
175 "displayId": "string",
176 "status": "CREATED",
177 "name": "string",
178 "erpSystemId": 0
179 },
180 "internalOrderType": {
181 "id": 0,
182 "displayId": "string",
183 "status": "CREATED",
184 "name": "string",
185 "erpSystemId": 0
186 },
187 "internalOrder": {
188 "id": 0,
189 "displayId": "string",
190 "status": "CREATED",
191 "name": "string",
192 "erpSystemId": 0,
193 "internalOrderTypeId": 0
194 },
195 "additionalCurrencies": [
196 {
197 "id": 0,
198 "amount": 0,
199 "currency": {
200 "id": 0,
201 "displayId": "string",
202 "status": "CREATED",
203 "name": "string",
204 "decimalPoints": 0
205 },
206 "conversionRate": 0,
207 "conversionDate": "2019-08-24",
208 "translationDateType": "DOCUMENT_DATE",
209 "amountType": "NET_AMOUNT",
210 "currencyDefinitionType": "CONTRACT_CURRENCY",
211 "invoiceEntryId": 0,
212 "invoiceEntryDisplayId": "string"
213 }
214 ],
215 "scheduledPaymentMatches": [
216 {
217 "id": 0,
218 "fromId": 0,
219 "toId": 0,
220 "amount": 0
221 }
222 ],
223 "goodsReceiptLineItemLinks": [
224 {
225 "id": 0,
226 "fromId": 0,
227 "toId": 0,
228 "linkedQuantity": 0
229 }
230 ],
231 "invoiceId": 0,
232 "invoiceDisplayId": "string",
233 "invoiceState": "INV_DRAFT",
234 "vendorPaymentId": 0,
235 "purchaseOrderLineItemId": 0,
236 "netAmount": 0,
237 "allowsSystemGenerateNewId": true,
238 "numberRangeIdentifierValue": "string",
239 "numberRangeIdentifierType": {
240 "name": "string"
241 },
242 "numberRangeType": {
243 "name": "string"
244 }
245 }
246 ],
247 "goodsReceiptLineItems": [
248 {
249 "id": 0,
250 "displayId": "string",
251 "quantity": 0,
252 "invoicedQuantity": 0,
253 "description": "string",
254 "expenseCategory": {
255 "id": 0,
256 "displayId": "string",
257 "status": "CREATED",
258 "name": "string",
259 "expenseCategoryType": "PAYMENT"
260 },
261 "goodsReceiptId": 0,
262 "goodsReceiptDisplayId": "string",
263 "goodsReceiptState": "INV_DRAFT",
264 "purchaseOrderLineItemId": 0,
265 "invoiceLineItemLinks": [
266 {
267 "id": 0,
268 "fromId": 0,
269 "toId": 0,
270 "linkedQuantity": 0
271 }
272 ],
273 "availableQuantity": 0,
274 "allowsSystemGenerateNewId": true,
275 "numberRangeIdentifierValue": "string",
276 "numberRangeIdentifierType": {
277 "name": "string"
278 },
279 "numberRangeType": {
280 "name": "string"
281 }
282 }
283 ],
284 "vendorPaymentId": 0,
285 "purchaseRequisitionLineItemId": 0,
286 "purchaseRequisitionDisplayId": "string",
287 "purchaseRequisitionLineItemAvailableQuantity": 0,
288 "remainingQuantity": 0,
289 "availableQuantity": 0,
290 "allowsSystemGenerateNewId": true,
291 "numberRangeIdentifierValue": "string",
292 "numberRangeIdentifierType": {
293 "name": "string"
294 },
295 "numberRangeType": {
296 "name": "string"
297 }
298 }
299}
Bulk-Update Resources¶
HTTP Request
PUT /api/v1/purchase-order-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 purchase order line items for bulk updates, including item details, quantities, and associated metadata. |
Body Parameters
1[
2 {
3 "id": 0,
4 "displayId": "string",
5 "quantity": 0,
6 "allocatedQuantity": 0,
7 "receivedQuantity": 0,
8 "unitPrice": 0,
9 "description": "string",
10 "expenseCategory": {
11 "id": 0,
12 "displayId": "string",
13 "status": "CREATED",
14 "name": "string",
15 "expenseCategoryType": "PAYMENT"
16 },
17 "costCenter": {
18 "id": 0,
19 "displayId": "string",
20 "status": "CREATED",
21 "name": "string",
22 "erpSystemId": 0
23 },
24 "profitCenter": {
25 "id": 0,
26 "displayId": "string",
27 "status": "CREATED",
28 "name": "string",
29 "validTo": "2019-08-24",
30 "erpSystemId": 0,
31 "erpSystemDisplayId": "string"
32 },
33 "taxJurisdiction": {
34 "id": 0,
35 "displayId": "string",
36 "status": "CREATED",
37 "name": "string",
38 "erpSystemId": 0,
39 "schema": "string",
40 "countryDisplayId": "string"
41 },
42 "taxCode": {
43 "id": 0,
44 "displayId": "string",
45 "status": "CREATED",
46 "name": "string",
47 "erpSystemId": 0
48 },
49 "taxLineItems": [
50 {
51 "id": 0,
52 "taxRate": 0.1,
53 "taxAmount": 0,
54 "taxType": "string",
55 "purchaseOrderLineItemId": 0
56 }
57 ],
58 "purchaseOrderId": 0,
59 "purchaseOrderDisplayId": "string",
60 "purchaseOrderState": "INV_DRAFT",
61 "invoiceLineItems": [
62 {
63 "id": 0,
64 "displayId": "string",
65 "expenseCategory": {
66 "id": 0,
67 "displayId": "string",
68 "status": "CREATED",
69 "name": "string",
70 "expenseCategoryType": "PAYMENT"
71 },
72 "description": "string",
73 "unitOfMeasure": {
74 "id": 0,
75 "displayId": "string",
76 "status": "CREATED",
77 "name": "string",
78 "erpSystemId": 0
79 },
80 "quantity": 0,
81 "unitPrice": 0,
82 "taxJurisdiction": {
83 "id": 0,
84 "displayId": "string",
85 "status": "CREATED",
86 "name": "string",
87 "erpSystemId": 0,
88 "schema": "string",
89 "countryDisplayId": "string"
90 },
91 "taxCode": {
92 "id": 0,
93 "displayId": "string",
94 "status": "CREATED",
95 "name": "string",
96 "erpSystemId": 0
97 },
98 "taxExpenseAccount": {
99 "id": 0,
100 "displayId": "string",
101 "generalLedgerAccountName": "string",
102 "generalLedgerAccountCode": "string",
103 "openItemManagement": true,
104 "accountCategory": "BALANCESHEET",
105 "shortName": "string",
106 "longName": "string"
107 },
108 "taxLineItems": [
109 {
110 "id": 0,
111 "taxRate": 0.1,
112 "taxAmount": 0,
113 "taxType": "string",
114 "invoiceLineItemId": 0
115 }
116 ],
117 "workBreakdownStructure": {
118 "id": 0,
119 "displayId": "string",
120 "status": "CREATED",
121 "name": "string",
122 "erpSystemId": 0
123 },
124 "costCenter": {
125 "id": 0,
126 "displayId": "string",
127 "status": "CREATED",
128 "name": "string",
129 "erpSystemId": 0
130 },
131 "profitCenter": {
132 "id": 0,
133 "displayId": "string",
134 "status": "CREATED",
135 "name": "string",
136 "validTo": "2019-08-24",
137 "erpSystemId": 0,
138 "erpSystemDisplayId": "string"
139 },
140 "functionalArea": {
141 "id": 0,
142 "displayId": "string",
143 "status": "CREATED",
144 "name": "string",
145 "erpSystemId": 0
146 },
147 "businessArea": {
148 "id": 0,
149 "displayId": "string",
150 "status": "CREATED",
151 "name": "string",
152 "erpSystemId": 0
153 },
154 "segment": {
155 "id": 0,
156 "displayId": "string",
157 "status": "CREATED",
158 "name": "string",
159 "erpSystemId": 0
160 },
161 "network": {
162 "id": 0,
163 "displayId": "string",
164 "status": "CREATED",
165 "name": "string",
166 "erpSystemId": 0
167 },
168 "internalOrderType": {
169 "id": 0,
170 "displayId": "string",
171 "status": "CREATED",
172 "name": "string",
173 "erpSystemId": 0
174 },
175 "internalOrder": {
176 "id": 0,
177 "displayId": "string",
178 "status": "CREATED",
179 "name": "string",
180 "erpSystemId": 0,
181 "internalOrderTypeId": 0
182 },
183 "additionalCurrencies": [
184 {
185 "id": 0,
186 "amount": 0,
187 "currency": {
188 "id": 0,
189 "displayId": "string",
190 "status": "CREATED",
191 "name": "string",
192 "decimalPoints": 0
193 },
194 "conversionRate": 0,
195 "conversionDate": "2019-08-24",
196 "translationDateType": "DOCUMENT_DATE",
197 "amountType": "NET_AMOUNT",
198 "currencyDefinitionType": "CONTRACT_CURRENCY",
199 "invoiceEntryId": 0,
200 "invoiceEntryDisplayId": "string"
201 }
202 ],
203 "scheduledPaymentMatches": [
204 {
205 "id": 0,
206 "fromId": 0,
207 "toId": 0,
208 "amount": 0
209 }
210 ],
211 "goodsReceiptLineItemLinks": [
212 {
213 "id": 0,
214 "fromId": 0,
215 "toId": 0,
216 "linkedQuantity": 0
217 }
218 ],
219 "invoiceId": 0,
220 "invoiceDisplayId": "string",
221 "invoiceState": "INV_DRAFT",
222 "vendorPaymentId": 0,
223 "purchaseOrderLineItemId": 0,
224 "netAmount": 0,
225 "allowsSystemGenerateNewId": true,
226 "numberRangeIdentifierValue": "string",
227 "numberRangeIdentifierType": {
228 "name": "string"
229 },
230 "numberRangeType": {
231 "name": "string"
232 }
233 }
234 ],
235 "goodsReceiptLineItems": [
236 {
237 "id": 0,
238 "displayId": "string",
239 "quantity": 0,
240 "invoicedQuantity": 0,
241 "description": "string",
242 "expenseCategory": {
243 "id": 0,
244 "displayId": "string",
245 "status": "CREATED",
246 "name": "string",
247 "expenseCategoryType": "PAYMENT"
248 },
249 "goodsReceiptId": 0,
250 "goodsReceiptDisplayId": "string",
251 "goodsReceiptState": "INV_DRAFT",
252 "purchaseOrderLineItemId": 0,
253 "invoiceLineItemLinks": [
254 {
255 "id": 0,
256 "fromId": 0,
257 "toId": 0,
258 "linkedQuantity": 0
259 }
260 ],
261 "allowsSystemGenerateNewId": true,
262 "numberRangeIdentifierValue": "string",
263 "numberRangeIdentifierType": {
264 "name": "string"
265 },
266 "numberRangeType": {
267 "name": "string"
268 }
269 }
270 ],
271 "vendorPaymentId": 0,
272 "purchaseRequisitionLineItemId": 0,
273 "purchaseRequisitionDisplayId": "string",
274 "purchaseRequisitionLineItemAvailableQuantity": 0,
275 "allowsSystemGenerateNewId": true,
276 "numberRangeIdentifierValue": "string",
277 "numberRangeIdentifierType": {
278 "name": "string"
279 },
280 "numberRangeType": {
281 "name": "string"
282 }
283 }
284]
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 "quantity": 0,
19 "allocatedQuantity": 0,
20 "receivedQuantity": 0,
21 "unitPrice": 0,
22 "description": "string",
23 "expenseCategory": {
24 "id": 0,
25 "displayId": "string",
26 "status": "CREATED",
27 "name": "string",
28 "expenseCategoryType": "PAYMENT"
29 },
30 "costCenter": {
31 "id": 0,
32 "displayId": "string",
33 "status": "CREATED",
34 "name": "string",
35 "erpSystemId": 0
36 },
37 "profitCenter": {
38 "id": 0,
39 "displayId": "string",
40 "status": "CREATED",
41 "name": "string",
42 "validTo": "2019-08-24",
43 "erpSystemId": 0,
44 "erpSystemDisplayId": "string"
45 },
46 "taxJurisdiction": {
47 "id": 0,
48 "displayId": "string",
49 "status": "CREATED",
50 "name": "string",
51 "erpSystemId": 0,
52 "schema": "string",
53 "countryDisplayId": "string"
54 },
55 "taxCode": {
56 "id": 0,
57 "displayId": "string",
58 "status": "CREATED",
59 "name": "string",
60 "erpSystemId": 0
61 },
62 "taxLineItems": [
63 {
64 "id": 0,
65 "taxRate": 0.1,
66 "taxAmount": 0,
67 "taxType": "string",
68 "purchaseOrderLineItemId": 0
69 }
70 ],
71 "purchaseOrderId": 0,
72 "purchaseOrderDisplayId": "string",
73 "purchaseOrderState": "INV_DRAFT",
74 "invoiceLineItems": [
75 {
76 "id": 0,
77 "displayId": "string",
78 "expenseCategory": {
79 "id": 0,
80 "displayId": "string",
81 "status": "CREATED",
82 "name": "string",
83 "expenseCategoryType": "PAYMENT"
84 },
85 "description": "string",
86 "unitOfMeasure": {
87 "id": 0,
88 "displayId": "string",
89 "status": "CREATED",
90 "name": "string",
91 "erpSystemId": 0
92 },
93 "quantity": 0,
94 "unitPrice": 0,
95 "taxJurisdiction": {
96 "id": 0,
97 "displayId": "string",
98 "status": "CREATED",
99 "name": "string",
100 "erpSystemId": 0,
101 "schema": "string",
102 "countryDisplayId": "string"
103 },
104 "taxCode": {
105 "id": 0,
106 "displayId": "string",
107 "status": "CREATED",
108 "name": "string",
109 "erpSystemId": 0
110 },
111 "taxExpenseAccount": {
112 "id": 0,
113 "displayId": "string",
114 "generalLedgerAccountName": "string",
115 "generalLedgerAccountCode": "string",
116 "openItemManagement": true,
117 "accountCategory": "BALANCESHEET",
118 "shortName": "string",
119 "longName": "string"
120 },
121 "taxLineItems": [
122 {
123 "id": 0,
124 "taxRate": 0.1,
125 "taxAmount": 0,
126 "taxType": "string",
127 "invoiceLineItemId": 0
128 }
129 ],
130 "workBreakdownStructure": {
131 "id": 0,
132 "displayId": "string",
133 "status": "CREATED",
134 "name": "string",
135 "erpSystemId": 0
136 },
137 "costCenter": {
138 "id": 0,
139 "displayId": "string",
140 "status": "CREATED",
141 "name": "string",
142 "erpSystemId": 0
143 },
144 "profitCenter": {
145 "id": 0,
146 "displayId": "string",
147 "status": "CREATED",
148 "name": "string",
149 "validTo": "2019-08-24",
150 "erpSystemId": 0,
151 "erpSystemDisplayId": "string"
152 },
153 "functionalArea": {
154 "id": 0,
155 "displayId": "string",
156 "status": "CREATED",
157 "name": "string",
158 "erpSystemId": 0
159 },
160 "businessArea": {
161 "id": 0,
162 "displayId": "string",
163 "status": "CREATED",
164 "name": "string",
165 "erpSystemId": 0
166 },
167 "segment": {
168 "id": 0,
169 "displayId": "string",
170 "status": "CREATED",
171 "name": "string",
172 "erpSystemId": 0
173 },
174 "network": {
175 "id": 0,
176 "displayId": "string",
177 "status": "CREATED",
178 "name": "string",
179 "erpSystemId": 0
180 },
181 "internalOrderType": {
182 "id": 0,
183 "displayId": "string",
184 "status": "CREATED",
185 "name": "string",
186 "erpSystemId": 0
187 },
188 "internalOrder": {
189 "id": 0,
190 "displayId": "string",
191 "status": "CREATED",
192 "name": "string",
193 "erpSystemId": 0,
194 "internalOrderTypeId": 0
195 },
196 "additionalCurrencies": [
197 {
198 "id": 0,
199 "amount": 0,
200 "currency": {
201 "id": 0,
202 "displayId": "string",
203 "status": "CREATED",
204 "name": "string",
205 "decimalPoints": 0
206 },
207 "conversionRate": 0,
208 "conversionDate": "2019-08-24",
209 "translationDateType": "DOCUMENT_DATE",
210 "amountType": "NET_AMOUNT",
211 "currencyDefinitionType": "CONTRACT_CURRENCY",
212 "invoiceEntryId": 0,
213 "invoiceEntryDisplayId": "string"
214 }
215 ],
216 "scheduledPaymentMatches": [
217 {
218 "id": 0,
219 "fromId": 0,
220 "toId": 0,
221 "amount": 0
222 }
223 ],
224 "goodsReceiptLineItemLinks": [
225 {
226 "id": 0,
227 "fromId": 0,
228 "toId": 0,
229 "linkedQuantity": 0
230 }
231 ],
232 "invoiceId": 0,
233 "invoiceDisplayId": "string",
234 "invoiceState": "INV_DRAFT",
235 "vendorPaymentId": 0,
236 "purchaseOrderLineItemId": 0,
237 "netAmount": 0,
238 "allowsSystemGenerateNewId": true,
239 "numberRangeIdentifierValue": "string",
240 "numberRangeIdentifierType": {
241 "name": "string"
242 },
243 "numberRangeType": {
244 "name": "string"
245 }
246 }
247 ],
248 "goodsReceiptLineItems": [
249 {
250 "id": 0,
251 "displayId": "string",
252 "quantity": 0,
253 "invoicedQuantity": 0,
254 "description": "string",
255 "expenseCategory": {
256 "id": 0,
257 "displayId": "string",
258 "status": "CREATED",
259 "name": "string",
260 "expenseCategoryType": "PAYMENT"
261 },
262 "goodsReceiptId": 0,
263 "goodsReceiptDisplayId": "string",
264 "goodsReceiptState": "INV_DRAFT",
265 "purchaseOrderLineItemId": 0,
266 "invoiceLineItemLinks": [
267 {
268 "id": 0,
269 "fromId": 0,
270 "toId": 0,
271 "linkedQuantity": 0
272 }
273 ],
274 "availableQuantity": 0,
275 "allowsSystemGenerateNewId": true,
276 "numberRangeIdentifierValue": "string",
277 "numberRangeIdentifierType": {
278 "name": "string"
279 },
280 "numberRangeType": {
281 "name": "string"
282 }
283 }
284 ],
285 "vendorPaymentId": 0,
286 "purchaseRequisitionLineItemId": 0,
287 "purchaseRequisitionDisplayId": "string",
288 "purchaseRequisitionLineItemAvailableQuantity": 0,
289 "remainingQuantity": 0,
290 "availableQuantity": 0,
291 "allowsSystemGenerateNewId": true,
292 "numberRangeIdentifierValue": "string",
293 "numberRangeIdentifierType": {
294 "name": "string"
295 },
296 "numberRangeType": {
297 "name": "string"
298 }
299 }
300 ]
301}
Bulk-Create Resources¶
HTTP Request
POST /api/v1/purchase-order-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 purchase order line item details, including item specifications, quantities, and pricing information for bulk processing. |
Body Parameters
1[
2 {
3 "id": 0,
4 "displayId": "string",
5 "quantity": 0,
6 "allocatedQuantity": 0,
7 "receivedQuantity": 0,
8 "unitPrice": 0,
9 "description": "string",
10 "expenseCategory": {
11 "id": 0,
12 "displayId": "string",
13 "status": "CREATED",
14 "name": "string",
15 "expenseCategoryType": "PAYMENT"
16 },
17 "costCenter": {
18 "id": 0,
19 "displayId": "string",
20 "status": "CREATED",
21 "name": "string",
22 "erpSystemId": 0
23 },
24 "profitCenter": {
25 "id": 0,
26 "displayId": "string",
27 "status": "CREATED",
28 "name": "string",
29 "validTo": "2019-08-24",
30 "erpSystemId": 0,
31 "erpSystemDisplayId": "string"
32 },
33 "taxJurisdiction": {
34 "id": 0,
35 "displayId": "string",
36 "status": "CREATED",
37 "name": "string",
38 "erpSystemId": 0,
39 "schema": "string",
40 "countryDisplayId": "string"
41 },
42 "taxCode": {
43 "id": 0,
44 "displayId": "string",
45 "status": "CREATED",
46 "name": "string",
47 "erpSystemId": 0
48 },
49 "taxLineItems": [
50 {
51 "id": 0,
52 "taxRate": 0.1,
53 "taxAmount": 0,
54 "taxType": "string",
55 "purchaseOrderLineItemId": 0
56 }
57 ],
58 "purchaseOrderId": 0,
59 "purchaseOrderDisplayId": "string",
60 "purchaseOrderState": "INV_DRAFT",
61 "invoiceLineItems": [
62 {
63 "id": 0,
64 "displayId": "string",
65 "expenseCategory": {
66 "id": 0,
67 "displayId": "string",
68 "status": "CREATED",
69 "name": "string",
70 "expenseCategoryType": "PAYMENT"
71 },
72 "description": "string",
73 "unitOfMeasure": {
74 "id": 0,
75 "displayId": "string",
76 "status": "CREATED",
77 "name": "string",
78 "erpSystemId": 0
79 },
80 "quantity": 0,
81 "unitPrice": 0,
82 "taxJurisdiction": {
83 "id": 0,
84 "displayId": "string",
85 "status": "CREATED",
86 "name": "string",
87 "erpSystemId": 0,
88 "schema": "string",
89 "countryDisplayId": "string"
90 },
91 "taxCode": {
92 "id": 0,
93 "displayId": "string",
94 "status": "CREATED",
95 "name": "string",
96 "erpSystemId": 0
97 },
98 "taxExpenseAccount": {
99 "id": 0,
100 "displayId": "string",
101 "generalLedgerAccountName": "string",
102 "generalLedgerAccountCode": "string",
103 "openItemManagement": true,
104 "accountCategory": "BALANCESHEET",
105 "shortName": "string",
106 "longName": "string"
107 },
108 "taxLineItems": [
109 {
110 "id": 0,
111 "taxRate": 0.1,
112 "taxAmount": 0,
113 "taxType": "string",
114 "invoiceLineItemId": 0
115 }
116 ],
117 "workBreakdownStructure": {
118 "id": 0,
119 "displayId": "string",
120 "status": "CREATED",
121 "name": "string",
122 "erpSystemId": 0
123 },
124 "costCenter": {
125 "id": 0,
126 "displayId": "string",
127 "status": "CREATED",
128 "name": "string",
129 "erpSystemId": 0
130 },
131 "profitCenter": {
132 "id": 0,
133 "displayId": "string",
134 "status": "CREATED",
135 "name": "string",
136 "validTo": "2019-08-24",
137 "erpSystemId": 0,
138 "erpSystemDisplayId": "string"
139 },
140 "functionalArea": {
141 "id": 0,
142 "displayId": "string",
143 "status": "CREATED",
144 "name": "string",
145 "erpSystemId": 0
146 },
147 "businessArea": {
148 "id": 0,
149 "displayId": "string",
150 "status": "CREATED",
151 "name": "string",
152 "erpSystemId": 0
153 },
154 "segment": {
155 "id": 0,
156 "displayId": "string",
157 "status": "CREATED",
158 "name": "string",
159 "erpSystemId": 0
160 },
161 "network": {
162 "id": 0,
163 "displayId": "string",
164 "status": "CREATED",
165 "name": "string",
166 "erpSystemId": 0
167 },
168 "internalOrderType": {
169 "id": 0,
170 "displayId": "string",
171 "status": "CREATED",
172 "name": "string",
173 "erpSystemId": 0
174 },
175 "internalOrder": {
176 "id": 0,
177 "displayId": "string",
178 "status": "CREATED",
179 "name": "string",
180 "erpSystemId": 0,
181 "internalOrderTypeId": 0
182 },
183 "additionalCurrencies": [
184 {
185 "id": 0,
186 "amount": 0,
187 "currency": {
188 "id": 0,
189 "displayId": "string",
190 "status": "CREATED",
191 "name": "string",
192 "decimalPoints": 0
193 },
194 "conversionRate": 0,
195 "conversionDate": "2019-08-24",
196 "translationDateType": "DOCUMENT_DATE",
197 "amountType": "NET_AMOUNT",
198 "currencyDefinitionType": "CONTRACT_CURRENCY",
199 "invoiceEntryId": 0,
200 "invoiceEntryDisplayId": "string"
201 }
202 ],
203 "scheduledPaymentMatches": [
204 {
205 "id": 0,
206 "fromId": 0,
207 "toId": 0,
208 "amount": 0
209 }
210 ],
211 "goodsReceiptLineItemLinks": [
212 {
213 "id": 0,
214 "fromId": 0,
215 "toId": 0,
216 "linkedQuantity": 0
217 }
218 ],
219 "invoiceId": 0,
220 "invoiceDisplayId": "string",
221 "invoiceState": "INV_DRAFT",
222 "vendorPaymentId": 0,
223 "purchaseOrderLineItemId": 0,
224 "netAmount": 0,
225 "allowsSystemGenerateNewId": true,
226 "numberRangeIdentifierValue": "string",
227 "numberRangeIdentifierType": {
228 "name": "string"
229 },
230 "numberRangeType": {
231 "name": "string"
232 }
233 }
234 ],
235 "goodsReceiptLineItems": [
236 {
237 "id": 0,
238 "displayId": "string",
239 "quantity": 0,
240 "invoicedQuantity": 0,
241 "description": "string",
242 "expenseCategory": {
243 "id": 0,
244 "displayId": "string",
245 "status": "CREATED",
246 "name": "string",
247 "expenseCategoryType": "PAYMENT"
248 },
249 "goodsReceiptId": 0,
250 "goodsReceiptDisplayId": "string",
251 "goodsReceiptState": "INV_DRAFT",
252 "purchaseOrderLineItemId": 0,
253 "invoiceLineItemLinks": [
254 {
255 "id": 0,
256 "fromId": 0,
257 "toId": 0,
258 "linkedQuantity": 0
259 }
260 ],
261 "allowsSystemGenerateNewId": true,
262 "numberRangeIdentifierValue": "string",
263 "numberRangeIdentifierType": {
264 "name": "string"
265 },
266 "numberRangeType": {
267 "name": "string"
268 }
269 }
270 ],
271 "vendorPaymentId": 0,
272 "purchaseRequisitionLineItemId": 0,
273 "purchaseRequisitionDisplayId": "string",
274 "purchaseRequisitionLineItemAvailableQuantity": 0,
275 "allowsSystemGenerateNewId": true,
276 "numberRangeIdentifierValue": "string",
277 "numberRangeIdentifierType": {
278 "name": "string"
279 },
280 "numberRangeType": {
281 "name": "string"
282 }
283 }
284]
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 "quantity": 0,
19 "allocatedQuantity": 0,
20 "receivedQuantity": 0,
21 "unitPrice": 0,
22 "description": "string",
23 "expenseCategory": {
24 "id": 0,
25 "displayId": "string",
26 "status": "CREATED",
27 "name": "string",
28 "expenseCategoryType": "PAYMENT"
29 },
30 "costCenter": {
31 "id": 0,
32 "displayId": "string",
33 "status": "CREATED",
34 "name": "string",
35 "erpSystemId": 0
36 },
37 "profitCenter": {
38 "id": 0,
39 "displayId": "string",
40 "status": "CREATED",
41 "name": "string",
42 "validTo": "2019-08-24",
43 "erpSystemId": 0,
44 "erpSystemDisplayId": "string"
45 },
46 "taxJurisdiction": {
47 "id": 0,
48 "displayId": "string",
49 "status": "CREATED",
50 "name": "string",
51 "erpSystemId": 0,
52 "schema": "string",
53 "countryDisplayId": "string"
54 },
55 "taxCode": {
56 "id": 0,
57 "displayId": "string",
58 "status": "CREATED",
59 "name": "string",
60 "erpSystemId": 0
61 },
62 "taxLineItems": [
63 {
64 "id": 0,
65 "taxRate": 0.1,
66 "taxAmount": 0,
67 "taxType": "string",
68 "purchaseOrderLineItemId": 0
69 }
70 ],
71 "purchaseOrderId": 0,
72 "purchaseOrderDisplayId": "string",
73 "purchaseOrderState": "INV_DRAFT",
74 "invoiceLineItems": [
75 {
76 "id": 0,
77 "displayId": "string",
78 "expenseCategory": {
79 "id": 0,
80 "displayId": "string",
81 "status": "CREATED",
82 "name": "string",
83 "expenseCategoryType": "PAYMENT"
84 },
85 "description": "string",
86 "unitOfMeasure": {
87 "id": 0,
88 "displayId": "string",
89 "status": "CREATED",
90 "name": "string",
91 "erpSystemId": 0
92 },
93 "quantity": 0,
94 "unitPrice": 0,
95 "taxJurisdiction": {
96 "id": 0,
97 "displayId": "string",
98 "status": "CREATED",
99 "name": "string",
100 "erpSystemId": 0,
101 "schema": "string",
102 "countryDisplayId": "string"
103 },
104 "taxCode": {
105 "id": 0,
106 "displayId": "string",
107 "status": "CREATED",
108 "name": "string",
109 "erpSystemId": 0
110 },
111 "taxExpenseAccount": {
112 "id": 0,
113 "displayId": "string",
114 "generalLedgerAccountName": "string",
115 "generalLedgerAccountCode": "string",
116 "openItemManagement": true,
117 "accountCategory": "BALANCESHEET",
118 "shortName": "string",
119 "longName": "string"
120 },
121 "taxLineItems": [
122 {
123 "id": 0,
124 "taxRate": 0.1,
125 "taxAmount": 0,
126 "taxType": "string",
127 "invoiceLineItemId": 0
128 }
129 ],
130 "workBreakdownStructure": {
131 "id": 0,
132 "displayId": "string",
133 "status": "CREATED",
134 "name": "string",
135 "erpSystemId": 0
136 },
137 "costCenter": {
138 "id": 0,
139 "displayId": "string",
140 "status": "CREATED",
141 "name": "string",
142 "erpSystemId": 0
143 },
144 "profitCenter": {
145 "id": 0,
146 "displayId": "string",
147 "status": "CREATED",
148 "name": "string",
149 "validTo": "2019-08-24",
150 "erpSystemId": 0,
151 "erpSystemDisplayId": "string"
152 },
153 "functionalArea": {
154 "id": 0,
155 "displayId": "string",
156 "status": "CREATED",
157 "name": "string",
158 "erpSystemId": 0
159 },
160 "businessArea": {
161 "id": 0,
162 "displayId": "string",
163 "status": "CREATED",
164 "name": "string",
165 "erpSystemId": 0
166 },
167 "segment": {
168 "id": 0,
169 "displayId": "string",
170 "status": "CREATED",
171 "name": "string",
172 "erpSystemId": 0
173 },
174 "network": {
175 "id": 0,
176 "displayId": "string",
177 "status": "CREATED",
178 "name": "string",
179 "erpSystemId": 0
180 },
181 "internalOrderType": {
182 "id": 0,
183 "displayId": "string",
184 "status": "CREATED",
185 "name": "string",
186 "erpSystemId": 0
187 },
188 "internalOrder": {
189 "id": 0,
190 "displayId": "string",
191 "status": "CREATED",
192 "name": "string",
193 "erpSystemId": 0,
194 "internalOrderTypeId": 0
195 },
196 "additionalCurrencies": [
197 {
198 "id": 0,
199 "amount": 0,
200 "currency": {
201 "id": 0,
202 "displayId": "string",
203 "status": "CREATED",
204 "name": "string",
205 "decimalPoints": 0
206 },
207 "conversionRate": 0,
208 "conversionDate": "2019-08-24",
209 "translationDateType": "DOCUMENT_DATE",
210 "amountType": "NET_AMOUNT",
211 "currencyDefinitionType": "CONTRACT_CURRENCY",
212 "invoiceEntryId": 0,
213 "invoiceEntryDisplayId": "string"
214 }
215 ],
216 "scheduledPaymentMatches": [
217 {
218 "id": 0,
219 "fromId": 0,
220 "toId": 0,
221 "amount": 0
222 }
223 ],
224 "goodsReceiptLineItemLinks": [
225 {
226 "id": 0,
227 "fromId": 0,
228 "toId": 0,
229 "linkedQuantity": 0
230 }
231 ],
232 "invoiceId": 0,
233 "invoiceDisplayId": "string",
234 "invoiceState": "INV_DRAFT",
235 "vendorPaymentId": 0,
236 "purchaseOrderLineItemId": 0,
237 "netAmount": 0,
238 "allowsSystemGenerateNewId": true,
239 "numberRangeIdentifierValue": "string",
240 "numberRangeIdentifierType": {
241 "name": "string"
242 },
243 "numberRangeType": {
244 "name": "string"
245 }
246 }
247 ],
248 "goodsReceiptLineItems": [
249 {
250 "id": 0,
251 "displayId": "string",
252 "quantity": 0,
253 "invoicedQuantity": 0,
254 "description": "string",
255 "expenseCategory": {
256 "id": 0,
257 "displayId": "string",
258 "status": "CREATED",
259 "name": "string",
260 "expenseCategoryType": "PAYMENT"
261 },
262 "goodsReceiptId": 0,
263 "goodsReceiptDisplayId": "string",
264 "goodsReceiptState": "INV_DRAFT",
265 "purchaseOrderLineItemId": 0,
266 "invoiceLineItemLinks": [
267 {
268 "id": 0,
269 "fromId": 0,
270 "toId": 0,
271 "linkedQuantity": 0
272 }
273 ],
274 "availableQuantity": 0,
275 "allowsSystemGenerateNewId": true,
276 "numberRangeIdentifierValue": "string",
277 "numberRangeIdentifierType": {
278 "name": "string"
279 },
280 "numberRangeType": {
281 "name": "string"
282 }
283 }
284 ],
285 "vendorPaymentId": 0,
286 "purchaseRequisitionLineItemId": 0,
287 "purchaseRequisitionDisplayId": "string",
288 "purchaseRequisitionLineItemAvailableQuantity": 0,
289 "remainingQuantity": 0,
290 "availableQuantity": 0,
291 "allowsSystemGenerateNewId": true,
292 "numberRangeIdentifierValue": "string",
293 "numberRangeIdentifierType": {
294 "name": "string"
295 },
296 "numberRangeType": {
297 "name": "string"
298 }
299 }
300 ]
301}
Bulk-Delete Resources¶
HTTP Request
DELETE /api/v1/purchase-order-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 purchase order line item identifiers to facilitate bulk deletion of specified items from the inventory. |
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}
Unlink Purchase Requisition Line Items From Purchase Order Line Items¶
HTTP Request
POST /api/v1/purchase-order-line-item/unlink-purchase-requisition-line-items
📋 Description: Removes the association between the specified purchase order line items and their purchase requisition 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 purchase requisition line items to be unlinked from the specified purchase order line item. |
Body Parameters
1[
2 {
3 "purchaseRequisitionLineItemId": 0,
4 "purchaseOrderLineItemId": 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 "quantity": 0,
6 "allocatedQuantity": 0,
7 "receivedQuantity": 0,
8 "unitPrice": 0,
9 "description": "string",
10 "expenseCategory": {
11 "id": 0,
12 "displayId": "string",
13 "status": "CREATED",
14 "name": "string",
15 "expenseCategoryType": "PAYMENT"
16 },
17 "costCenter": {
18 "id": 0,
19 "displayId": "string",
20 "status": "CREATED",
21 "name": "string",
22 "erpSystemId": 0
23 },
24 "profitCenter": {
25 "id": 0,
26 "displayId": "string",
27 "status": "CREATED",
28 "name": "string",
29 "validTo": "2019-08-24",
30 "erpSystemId": 0,
31 "erpSystemDisplayId": "string"
32 },
33 "taxJurisdiction": {
34 "id": 0,
35 "displayId": "string",
36 "status": "CREATED",
37 "name": "string",
38 "erpSystemId": 0,
39 "schema": "string",
40 "countryDisplayId": "string"
41 },
42 "taxCode": {
43 "id": 0,
44 "displayId": "string",
45 "status": "CREATED",
46 "name": "string",
47 "erpSystemId": 0
48 },
49 "taxLineItems": [
50 {
51 "id": 0,
52 "taxRate": 0.1,
53 "taxAmount": 0,
54 "taxType": "string",
55 "purchaseOrderLineItemId": 0
56 }
57 ],
58 "purchaseOrderId": 0,
59 "purchaseOrderDisplayId": "string",
60 "purchaseOrderState": "INV_DRAFT",
61 "invoiceLineItems": [
62 {
63 "id": 0,
64 "displayId": "string",
65 "expenseCategory": {
66 "id": 0,
67 "displayId": "string",
68 "status": "CREATED",
69 "name": "string",
70 "expenseCategoryType": "PAYMENT"
71 },
72 "description": "string",
73 "unitOfMeasure": {
74 "id": 0,
75 "displayId": "string",
76 "status": "CREATED",
77 "name": "string",
78 "erpSystemId": 0
79 },
80 "quantity": 0,
81 "unitPrice": 0,
82 "taxJurisdiction": {
83 "id": 0,
84 "displayId": "string",
85 "status": "CREATED",
86 "name": "string",
87 "erpSystemId": 0,
88 "schema": "string",
89 "countryDisplayId": "string"
90 },
91 "taxCode": {
92 "id": 0,
93 "displayId": "string",
94 "status": "CREATED",
95 "name": "string",
96 "erpSystemId": 0
97 },
98 "taxExpenseAccount": {
99 "id": 0,
100 "displayId": "string",
101 "generalLedgerAccountName": "string",
102 "generalLedgerAccountCode": "string",
103 "openItemManagement": true,
104 "accountCategory": "BALANCESHEET",
105 "shortName": "string",
106 "longName": "string"
107 },
108 "taxLineItems": [
109 {
110 "id": 0,
111 "taxRate": 0.1,
112 "taxAmount": 0,
113 "taxType": "string",
114 "invoiceLineItemId": 0
115 }
116 ],
117 "workBreakdownStructure": {
118 "id": 0,
119 "displayId": "string",
120 "status": "CREATED",
121 "name": "string",
122 "erpSystemId": 0
123 },
124 "costCenter": {
125 "id": 0,
126 "displayId": "string",
127 "status": "CREATED",
128 "name": "string",
129 "erpSystemId": 0
130 },
131 "profitCenter": {
132 "id": 0,
133 "displayId": "string",
134 "status": "CREATED",
135 "name": "string",
136 "validTo": "2019-08-24",
137 "erpSystemId": 0,
138 "erpSystemDisplayId": "string"
139 },
140 "functionalArea": {
141 "id": 0,
142 "displayId": "string",
143 "status": "CREATED",
144 "name": "string",
145 "erpSystemId": 0
146 },
147 "businessArea": {
148 "id": 0,
149 "displayId": "string",
150 "status": "CREATED",
151 "name": "string",
152 "erpSystemId": 0
153 },
154 "segment": {
155 "id": 0,
156 "displayId": "string",
157 "status": "CREATED",
158 "name": "string",
159 "erpSystemId": 0
160 },
161 "network": {
162 "id": 0,
163 "displayId": "string",
164 "status": "CREATED",
165 "name": "string",
166 "erpSystemId": 0
167 },
168 "internalOrderType": {
169 "id": 0,
170 "displayId": "string",
171 "status": "CREATED",
172 "name": "string",
173 "erpSystemId": 0
174 },
175 "internalOrder": {
176 "id": 0,
177 "displayId": "string",
178 "status": "CREATED",
179 "name": "string",
180 "erpSystemId": 0,
181 "internalOrderTypeId": 0
182 },
183 "additionalCurrencies": [
184 {
185 "id": 0,
186 "amount": 0,
187 "currency": {
188 "id": 0,
189 "displayId": "string",
190 "status": "CREATED",
191 "name": "string",
192 "decimalPoints": 0
193 },
194 "conversionRate": 0,
195 "conversionDate": "2019-08-24",
196 "translationDateType": "DOCUMENT_DATE",
197 "amountType": "NET_AMOUNT",
198 "currencyDefinitionType": "CONTRACT_CURRENCY",
199 "invoiceEntryId": 0,
200 "invoiceEntryDisplayId": "string"
201 }
202 ],
203 "scheduledPaymentMatches": [
204 {
205 "id": 0,
206 "fromId": 0,
207 "toId": 0,
208 "amount": 0
209 }
210 ],
211 "goodsReceiptLineItemLinks": [
212 {
213 "id": 0,
214 "fromId": 0,
215 "toId": 0,
216 "linkedQuantity": 0
217 }
218 ],
219 "invoiceId": 0,
220 "invoiceDisplayId": "string",
221 "invoiceState": "INV_DRAFT",
222 "vendorPaymentId": 0,
223 "purchaseOrderLineItemId": 0,
224 "netAmount": 0,
225 "allowsSystemGenerateNewId": true,
226 "numberRangeIdentifierValue": "string",
227 "numberRangeIdentifierType": {
228 "name": "string"
229 },
230 "numberRangeType": {
231 "name": "string"
232 }
233 }
234 ],
235 "goodsReceiptLineItems": [
236 {
237 "id": 0,
238 "displayId": "string",
239 "quantity": 0,
240 "invoicedQuantity": 0,
241 "description": "string",
242 "expenseCategory": {
243 "id": 0,
244 "displayId": "string",
245 "status": "CREATED",
246 "name": "string",
247 "expenseCategoryType": "PAYMENT"
248 },
249 "goodsReceiptId": 0,
250 "goodsReceiptDisplayId": "string",
251 "goodsReceiptState": "INV_DRAFT",
252 "purchaseOrderLineItemId": 0,
253 "invoiceLineItemLinks": [
254 {
255 "id": 0,
256 "fromId": 0,
257 "toId": 0,
258 "linkedQuantity": 0
259 }
260 ],
261 "availableQuantity": 0,
262 "allowsSystemGenerateNewId": true,
263 "numberRangeIdentifierValue": "string",
264 "numberRangeIdentifierType": {
265 "name": "string"
266 },
267 "numberRangeType": {
268 "name": "string"
269 }
270 }
271 ],
272 "vendorPaymentId": 0,
273 "purchaseRequisitionLineItemId": 0,
274 "purchaseRequisitionDisplayId": "string",
275 "purchaseRequisitionLineItemAvailableQuantity": 0,
276 "remainingQuantity": 0,
277 "availableQuantity": 0,
278 "allowsSystemGenerateNewId": true,
279 "numberRangeIdentifierValue": "string",
280 "numberRangeIdentifierType": {
281 "name": "string"
282 },
283 "numberRangeType": {
284 "name": "string"
285 }
286 }
287]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a line item within a purchase order, detailing product specifications, quantities, and pricing to facilitate accurate procurement and inventory management.] |
|
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» displayId |
string |
false |
none |
Unique identifier for the display |
» quantity |
integer(int64) |
false |
none |
Quantity value |
» allocatedQuantity |
integer(int64) |
false |
none |
Quantity of allocated quantity |
» receivedQuantity |
integer(int64) |
false |
none |
Quantity of received quantity |
» unitPrice |
number |
false |
none |
The unitPrice field represents the cost per individual item within a purchase order line item, essential for accurate financial reporting and inventory management. |
» description |
string |
false |
none |
Description of the resource |
» 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 |
» 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 |
» 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 |
» taxLineItems |
false |
none |
An array of tax line items associated with the purchase order, detailing the applicable taxes for each line item. |
|
»» 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 |
»» purchaseOrderLineItemId |
integer(int64) |
false |
none |
Unique identifier for the purchase order line item |
» purchaseOrderId |
integer(int64) |
true |
none |
Unique identifier for the purchase order |
» purchaseOrderDisplayId |
string |
false |
none |
Unique identifier for the purchase order display |
» purchaseOrderState |
string |
false |
none |
Indicates the current status of the purchase order, reflecting its progress through the procurement process. |
» invoiceLineItems |
false |
none |
An array of line items associated with the invoice, detailing each product or service included in the purchase order. |
|
»» 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. |
|
»» 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. |
|
»» taxCode |
false |
none |
Data transfer object representing a simplified tax code, designed to facilitate efficient tax calculations and compliance within financial applications. |
|
»» 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. |
|
»» 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. |
|
»» 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 |
» goodsReceiptLineItems |
false |
none |
An array of line items associated with the goods receipt, detailing each purchased order’s specifics for accurate inventory and financial tracking. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» quantity |
integer(int64) |
false |
none |
Quantity value |
»» invoicedQuantity |
integer(int64) |
false |
none |
Quantity of invoiced quantity |
»» description |
string |
false |
none |
Description of the resource |
»» expenseCategory |
false |
none |
Data transfer object representing a simplified categorization of expenses, enabling efficient tracking and reporting of financial allocations within the organization. |
|
»» goodsReceiptId |
integer(int64) |
true |
none |
Unique identifier for the goods receipt |
»» goodsReceiptDisplayId |
string |
false |
none |
Unique identifier for the goods receipt display |
»» goodsReceiptState |
string |
false |
none |
Indicates the current status of the goods receipt, reflecting its processing stage within the supply chain management system. |
»» purchaseOrderLineItemId |
integer(int64) |
false |
none |
Unique identifier for the purchase order line item |
»» invoiceLineItemLinks |
false |
none |
Array of links to associated invoice line items, facilitating the tracking and management of goods receipt transactions. |
|
»» availableQuantity |
integer(int64) |
false |
read-only |
Quantity of available quantity |
»» allowsSystemGenerateNewId |
boolean |
false |
none |
Unique identifier for the allows system generate new |
»» numberRangeIdentifierValue |
string |
false |
none |
Represents a unique identifier for the range of numbers associated with a specific goods receipt line item, facilitating accurate tracking and management of inventory. |
»» 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. |
|
»» 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. |
|
» vendorPaymentId |
integer(int64) |
false |
none |
Unique identifier for the vendor payment |
» purchaseRequisitionLineItemId |
integer(int64) |
false |
none |
Unique identifier for the purchase requisition line item |
» purchaseRequisitionDisplayId |
string |
false |
none |
Unique identifier for the purchase requisition display |
» purchaseRequisitionLineItemAvailableQuantity |
integer(int64) |
false |
none |
Quantity of purchase requisition line item available quantity |
» remainingQuantity |
integer(int64) |
false |
read-only |
Quantity of remaining quantity |
» availableQuantity |
integer(int64) |
false |
read-only |
Quantity of available quantity |
» allowsSystemGenerateNewId |
boolean |
false |
none |
Unique identifier for the allows system generate new |
» numberRangeIdentifierValue |
string |
false |
none |
Represents the specific range identifier for the purchase order line item, facilitating accurate tracking and management of inventory levels. |
» 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. |
|
» 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. |
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 |
goodsReceiptState |
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 |
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 |
purchaseOrderState |
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/purchase-order-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 purchase order 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 "quantityEqual": 0,
20 "allocatedQuantityEqual": 0,
21 "receivedQuantityEqual": 0,
22 "unitPriceEqual": 0,
23 "descriptionLike": "string",
24 "expenseCategoryIdEqual": 0,
25 "expenseCategoryDisplayIdLike": "string",
26 "costCenterIdEqual": 0,
27 "costCenterDisplayIdLike": "string",
28 "costCenterNameLike": "string",
29 "profitCenterIdEqual": 0,
30 "profitCenterDisplayIdLike": "string",
31 "profitCenterNameLike": "string",
32 "purchaseOrderIdIn": [
33 0
34 ],
35 "purchaseOrderIdEqual": 0,
36 "purchaseOrderDisplayIdIn": [
37 "string"
38 ],
39 "purchaseOrderDisplayIdEqual": "string",
40 "purchaseOrderStateIn": [
41 "INV_DRAFT"
42 ],
43 "purchaseOrderStateEqual": "INV_DRAFT",
44 "invoiceLineItemsIdIn": [
45 0
46 ],
47 "goodsReceiptLineItemsIdIn": [
48 0
49 ],
50 "purchaseRequisitionLineItemIdIn": [
51 0
52 ],
53 "purchaseRequisitionLineItemIdEqual": 0
54}
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 "quantity": 0,
23 "allocatedQuantity": 0,
24 "receivedQuantity": 0,
25 "unitPrice": 0,
26 "description": "string",
27 "expenseCategory": {
28 "id": 0,
29 "displayId": "string",
30 "status": "CREATED",
31 "name": "string",
32 "expenseCategoryType": "PAYMENT"
33 },
34 "costCenter": {
35 "id": 0,
36 "displayId": "string",
37 "status": "CREATED",
38 "name": "string",
39 "erpSystemId": 0
40 },
41 "profitCenter": {
42 "id": 0,
43 "displayId": "string",
44 "status": "CREATED",
45 "name": "string",
46 "validTo": "2019-08-24",
47 "erpSystemId": 0,
48 "erpSystemDisplayId": "string"
49 },
50 "taxJurisdiction": {
51 "id": 0,
52 "displayId": "string",
53 "status": "CREATED",
54 "name": "string",
55 "erpSystemId": 0,
56 "schema": "string",
57 "countryDisplayId": "string"
58 },
59 "taxCode": {
60 "id": 0,
61 "displayId": "string",
62 "status": "CREATED",
63 "name": "string",
64 "erpSystemId": 0
65 },
66 "taxLineItems": [
67 {
68 "id": 0,
69 "taxRate": 0.1,
70 "taxAmount": 0,
71 "taxType": "string",
72 "purchaseOrderLineItemId": 0
73 }
74 ],
75 "purchaseOrderId": 0,
76 "purchaseOrderDisplayId": "string",
77 "purchaseOrderState": "INV_DRAFT",
78 "invoiceLineItems": [
79 {
80 "id": 0,
81 "displayId": "string",
82 "expenseCategory": {
83 "id": 0,
84 "displayId": "string",
85 "status": "CREATED",
86 "name": "string",
87 "expenseCategoryType": "PAYMENT"
88 },
89 "description": "string",
90 "unitOfMeasure": {
91 "id": 0,
92 "displayId": "string",
93 "status": "CREATED",
94 "name": "string",
95 "erpSystemId": 0
96 },
97 "quantity": 0,
98 "unitPrice": 0,
99 "taxJurisdiction": {
100 "id": 0,
101 "displayId": "string",
102 "status": "CREATED",
103 "name": "string",
104 "erpSystemId": 0,
105 "schema": "string",
106 "countryDisplayId": "string"
107 },
108 "taxCode": {
109 "id": 0,
110 "displayId": "string",
111 "status": "CREATED",
112 "name": "string",
113 "erpSystemId": 0
114 },
115 "taxExpenseAccount": {
116 "id": 0,
117 "displayId": "string",
118 "generalLedgerAccountName": "string",
119 "generalLedgerAccountCode": "string",
120 "openItemManagement": true,
121 "accountCategory": "BALANCESHEET",
122 "shortName": "string",
123 "longName": "string"
124 },
125 "taxLineItems": [
126 {
127 "id": 0,
128 "taxRate": 0.1,
129 "taxAmount": 0,
130 "taxType": "string",
131 "invoiceLineItemId": 0
132 }
133 ],
134 "workBreakdownStructure": {
135 "id": 0,
136 "displayId": "string",
137 "status": "CREATED",
138 "name": "string",
139 "erpSystemId": 0
140 },
141 "costCenter": {
142 "id": 0,
143 "displayId": "string",
144 "status": "CREATED",
145 "name": "string",
146 "erpSystemId": 0
147 },
148 "profitCenter": {
149 "id": 0,
150 "displayId": "string",
151 "status": "CREATED",
152 "name": "string",
153 "validTo": "2019-08-24",
154 "erpSystemId": 0,
155 "erpSystemDisplayId": "string"
156 },
157 "functionalArea": {
158 "id": 0,
159 "displayId": "string",
160 "status": "CREATED",
161 "name": "string",
162 "erpSystemId": 0
163 },
164 "businessArea": {
165 "id": 0,
166 "displayId": "string",
167 "status": "CREATED",
168 "name": "string",
169 "erpSystemId": 0
170 },
171 "segment": {
172 "id": 0,
173 "displayId": "string",
174 "status": "CREATED",
175 "name": "string",
176 "erpSystemId": 0
177 },
178 "network": {
179 "id": 0,
180 "displayId": "string",
181 "status": "CREATED",
182 "name": "string",
183 "erpSystemId": 0
184 },
185 "internalOrderType": {
186 "id": 0,
187 "displayId": "string",
188 "status": "CREATED",
189 "name": "string",
190 "erpSystemId": 0
191 },
192 "internalOrder": {
193 "id": 0,
194 "displayId": "string",
195 "status": "CREATED",
196 "name": "string",
197 "erpSystemId": 0,
198 "internalOrderTypeId": 0
199 },
200 "additionalCurrencies": [
201 {
202 "id": 0,
203 "amount": 0,
204 "currency": {
205 "id": 0,
206 "displayId": "string",
207 "status": "CREATED",
208 "name": "string",
209 "decimalPoints": 0
210 },
211 "conversionRate": 0,
212 "conversionDate": "2019-08-24",
213 "translationDateType": "DOCUMENT_DATE",
214 "amountType": "NET_AMOUNT",
215 "currencyDefinitionType": "CONTRACT_CURRENCY",
216 "invoiceEntryId": 0,
217 "invoiceEntryDisplayId": "string"
218 }
219 ],
220 "scheduledPaymentMatches": [
221 {
222 "id": 0,
223 "fromId": 0,
224 "toId": 0,
225 "amount": 0
226 }
227 ],
228 "goodsReceiptLineItemLinks": [
229 {
230 "id": 0,
231 "fromId": 0,
232 "toId": 0,
233 "linkedQuantity": 0
234 }
235 ],
236 "invoiceId": 0,
237 "invoiceDisplayId": "string",
238 "invoiceState": "INV_DRAFT",
239 "vendorPaymentId": 0,
240 "purchaseOrderLineItemId": 0,
241 "netAmount": 0,
242 "allowsSystemGenerateNewId": true,
243 "numberRangeIdentifierValue": "string",
244 "numberRangeIdentifierType": {
245 "name": "string"
246 },
247 "numberRangeType": {
248 "name": "string"
249 }
250 }
251 ],
252 "goodsReceiptLineItems": [
253 {
254 "id": 0,
255 "displayId": "string",
256 "quantity": 0,
257 "invoicedQuantity": 0,
258 "description": "string",
259 "expenseCategory": {
260 "id": 0,
261 "displayId": "string",
262 "status": "CREATED",
263 "name": "string",
264 "expenseCategoryType": "PAYMENT"
265 },
266 "goodsReceiptId": 0,
267 "goodsReceiptDisplayId": "string",
268 "goodsReceiptState": "INV_DRAFT",
269 "purchaseOrderLineItemId": 0,
270 "invoiceLineItemLinks": [
271 {
272 "id": 0,
273 "fromId": 0,
274 "toId": 0,
275 "linkedQuantity": 0
276 }
277 ],
278 "availableQuantity": 0,
279 "allowsSystemGenerateNewId": true,
280 "numberRangeIdentifierValue": "string",
281 "numberRangeIdentifierType": {
282 "name": "string"
283 },
284 "numberRangeType": {
285 "name": "string"
286 }
287 }
288 ],
289 "vendorPaymentId": 0,
290 "purchaseRequisitionLineItemId": 0,
291 "purchaseRequisitionDisplayId": "string",
292 "purchaseRequisitionLineItemAvailableQuantity": 0,
293 "remainingQuantity": 0,
294 "availableQuantity": 0,
295 "allowsSystemGenerateNewId": true,
296 "numberRangeIdentifierValue": "string",
297 "numberRangeIdentifierType": {
298 "name": "string"
299 },
300 "numberRangeType": {
301 "name": "string"
302 }
303 }
304 ],
305 "number": 0,
306 "sort": {
307 "unsorted": true,
308 "sorted": true,
309 "empty": true
310 },
311 "first": true,
312 "last": true,
313 "empty": true
314}
Link Purchase Requisition Line Items To Purchase Order Line Items¶
HTTP Request
POST /api/v1/purchase-order-line-item/link-purchase-requisition-line-items
📋 Description: Associates existing purchase order line items with purchase requisition 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 purchase order line item details and associated purchase requisition line item identifiers for linking purposes. |
Body Parameters
1[
2 {
3 "purchaseRequisitionLineItemId": 0,
4 "purchaseOrderLineItemId": 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 "quantity": 0,
6 "allocatedQuantity": 0,
7 "receivedQuantity": 0,
8 "unitPrice": 0,
9 "description": "string",
10 "expenseCategory": {
11 "id": 0,
12 "displayId": "string",
13 "status": "CREATED",
14 "name": "string",
15 "expenseCategoryType": "PAYMENT"
16 },
17 "costCenter": {
18 "id": 0,
19 "displayId": "string",
20 "status": "CREATED",
21 "name": "string",
22 "erpSystemId": 0
23 },
24 "profitCenter": {
25 "id": 0,
26 "displayId": "string",
27 "status": "CREATED",
28 "name": "string",
29 "validTo": "2019-08-24",
30 "erpSystemId": 0,
31 "erpSystemDisplayId": "string"
32 },
33 "taxJurisdiction": {
34 "id": 0,
35 "displayId": "string",
36 "status": "CREATED",
37 "name": "string",
38 "erpSystemId": 0,
39 "schema": "string",
40 "countryDisplayId": "string"
41 },
42 "taxCode": {
43 "id": 0,
44 "displayId": "string",
45 "status": "CREATED",
46 "name": "string",
47 "erpSystemId": 0
48 },
49 "taxLineItems": [
50 {
51 "id": 0,
52 "taxRate": 0.1,
53 "taxAmount": 0,
54 "taxType": "string",
55 "purchaseOrderLineItemId": 0
56 }
57 ],
58 "purchaseOrderId": 0,
59 "purchaseOrderDisplayId": "string",
60 "purchaseOrderState": "INV_DRAFT",
61 "invoiceLineItems": [
62 {
63 "id": 0,
64 "displayId": "string",
65 "expenseCategory": {
66 "id": 0,
67 "displayId": "string",
68 "status": "CREATED",
69 "name": "string",
70 "expenseCategoryType": "PAYMENT"
71 },
72 "description": "string",
73 "unitOfMeasure": {
74 "id": 0,
75 "displayId": "string",
76 "status": "CREATED",
77 "name": "string",
78 "erpSystemId": 0
79 },
80 "quantity": 0,
81 "unitPrice": 0,
82 "taxJurisdiction": {
83 "id": 0,
84 "displayId": "string",
85 "status": "CREATED",
86 "name": "string",
87 "erpSystemId": 0,
88 "schema": "string",
89 "countryDisplayId": "string"
90 },
91 "taxCode": {
92 "id": 0,
93 "displayId": "string",
94 "status": "CREATED",
95 "name": "string",
96 "erpSystemId": 0
97 },
98 "taxExpenseAccount": {
99 "id": 0,
100 "displayId": "string",
101 "generalLedgerAccountName": "string",
102 "generalLedgerAccountCode": "string",
103 "openItemManagement": true,
104 "accountCategory": "BALANCESHEET",
105 "shortName": "string",
106 "longName": "string"
107 },
108 "taxLineItems": [
109 {
110 "id": 0,
111 "taxRate": 0.1,
112 "taxAmount": 0,
113 "taxType": "string",
114 "invoiceLineItemId": 0
115 }
116 ],
117 "workBreakdownStructure": {
118 "id": 0,
119 "displayId": "string",
120 "status": "CREATED",
121 "name": "string",
122 "erpSystemId": 0
123 },
124 "costCenter": {
125 "id": 0,
126 "displayId": "string",
127 "status": "CREATED",
128 "name": "string",
129 "erpSystemId": 0
130 },
131 "profitCenter": {
132 "id": 0,
133 "displayId": "string",
134 "status": "CREATED",
135 "name": "string",
136 "validTo": "2019-08-24",
137 "erpSystemId": 0,
138 "erpSystemDisplayId": "string"
139 },
140 "functionalArea": {
141 "id": 0,
142 "displayId": "string",
143 "status": "CREATED",
144 "name": "string",
145 "erpSystemId": 0
146 },
147 "businessArea": {
148 "id": 0,
149 "displayId": "string",
150 "status": "CREATED",
151 "name": "string",
152 "erpSystemId": 0
153 },
154 "segment": {
155 "id": 0,
156 "displayId": "string",
157 "status": "CREATED",
158 "name": "string",
159 "erpSystemId": 0
160 },
161 "network": {
162 "id": 0,
163 "displayId": "string",
164 "status": "CREATED",
165 "name": "string",
166 "erpSystemId": 0
167 },
168 "internalOrderType": {
169 "id": 0,
170 "displayId": "string",
171 "status": "CREATED",
172 "name": "string",
173 "erpSystemId": 0
174 },
175 "internalOrder": {
176 "id": 0,
177 "displayId": "string",
178 "status": "CREATED",
179 "name": "string",
180 "erpSystemId": 0,
181 "internalOrderTypeId": 0
182 },
183 "additionalCurrencies": [
184 {
185 "id": 0,
186 "amount": 0,
187 "currency": {
188 "id": 0,
189 "displayId": "string",
190 "status": "CREATED",
191 "name": "string",
192 "decimalPoints": 0
193 },
194 "conversionRate": 0,
195 "conversionDate": "2019-08-24",
196 "translationDateType": "DOCUMENT_DATE",
197 "amountType": "NET_AMOUNT",
198 "currencyDefinitionType": "CONTRACT_CURRENCY",
199 "invoiceEntryId": 0,
200 "invoiceEntryDisplayId": "string"
201 }
202 ],
203 "scheduledPaymentMatches": [
204 {
205 "id": 0,
206 "fromId": 0,
207 "toId": 0,
208 "amount": 0
209 }
210 ],
211 "goodsReceiptLineItemLinks": [
212 {
213 "id": 0,
214 "fromId": 0,
215 "toId": 0,
216 "linkedQuantity": 0
217 }
218 ],
219 "invoiceId": 0,
220 "invoiceDisplayId": "string",
221 "invoiceState": "INV_DRAFT",
222 "vendorPaymentId": 0,
223 "purchaseOrderLineItemId": 0,
224 "netAmount": 0,
225 "allowsSystemGenerateNewId": true,
226 "numberRangeIdentifierValue": "string",
227 "numberRangeIdentifierType": {
228 "name": "string"
229 },
230 "numberRangeType": {
231 "name": "string"
232 }
233 }
234 ],
235 "goodsReceiptLineItems": [
236 {
237 "id": 0,
238 "displayId": "string",
239 "quantity": 0,
240 "invoicedQuantity": 0,
241 "description": "string",
242 "expenseCategory": {
243 "id": 0,
244 "displayId": "string",
245 "status": "CREATED",
246 "name": "string",
247 "expenseCategoryType": "PAYMENT"
248 },
249 "goodsReceiptId": 0,
250 "goodsReceiptDisplayId": "string",
251 "goodsReceiptState": "INV_DRAFT",
252 "purchaseOrderLineItemId": 0,
253 "invoiceLineItemLinks": [
254 {
255 "id": 0,
256 "fromId": 0,
257 "toId": 0,
258 "linkedQuantity": 0
259 }
260 ],
261 "availableQuantity": 0,
262 "allowsSystemGenerateNewId": true,
263 "numberRangeIdentifierValue": "string",
264 "numberRangeIdentifierType": {
265 "name": "string"
266 },
267 "numberRangeType": {
268 "name": "string"
269 }
270 }
271 ],
272 "vendorPaymentId": 0,
273 "purchaseRequisitionLineItemId": 0,
274 "purchaseRequisitionDisplayId": "string",
275 "purchaseRequisitionLineItemAvailableQuantity": 0,
276 "remainingQuantity": 0,
277 "availableQuantity": 0,
278 "allowsSystemGenerateNewId": true,
279 "numberRangeIdentifierValue": "string",
280 "numberRangeIdentifierType": {
281 "name": "string"
282 },
283 "numberRangeType": {
284 "name": "string"
285 }
286 }
287]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a line item within a purchase order, detailing product specifications, quantities, and pricing to facilitate accurate procurement and inventory management.] |
|
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» displayId |
string |
false |
none |
Unique identifier for the display |
» quantity |
integer(int64) |
false |
none |
Quantity value |
» allocatedQuantity |
integer(int64) |
false |
none |
Quantity of allocated quantity |
» receivedQuantity |
integer(int64) |
false |
none |
Quantity of received quantity |
» unitPrice |
number |
false |
none |
The unitPrice field represents the cost per individual item within a purchase order line item, essential for accurate financial reporting and inventory management. |
» description |
string |
false |
none |
Description of the resource |
» 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 |
» 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 |
» 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 |
» taxLineItems |
false |
none |
An array of tax line items associated with the purchase order, detailing the applicable taxes for each line item. |
|
»» 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 |
»» purchaseOrderLineItemId |
integer(int64) |
false |
none |
Unique identifier for the purchase order line item |
» purchaseOrderId |
integer(int64) |
true |
none |
Unique identifier for the purchase order |
» purchaseOrderDisplayId |
string |
false |
none |
Unique identifier for the purchase order display |
» purchaseOrderState |
string |
false |
none |
Indicates the current status of the purchase order, reflecting its progress through the procurement process. |
» invoiceLineItems |
false |
none |
An array of line items associated with the invoice, detailing each product or service included in the purchase order. |
|
»» 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. |
|
»» 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. |
|
»» taxCode |
false |
none |
Data transfer object representing a simplified tax code, designed to facilitate efficient tax calculations and compliance within financial applications. |
|
»» 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. |
|
»» 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. |
|
»» 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 |
» goodsReceiptLineItems |
false |
none |
An array of line items associated with the goods receipt, detailing each purchased order’s specifics for accurate inventory and financial tracking. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» quantity |
integer(int64) |
false |
none |
Quantity value |
»» invoicedQuantity |
integer(int64) |
false |
none |
Quantity of invoiced quantity |
»» description |
string |
false |
none |
Description of the resource |
»» expenseCategory |
false |
none |
Data transfer object representing a simplified categorization of expenses, enabling efficient tracking and reporting of financial allocations within the organization. |
|
»» goodsReceiptId |
integer(int64) |
true |
none |
Unique identifier for the goods receipt |
»» goodsReceiptDisplayId |
string |
false |
none |
Unique identifier for the goods receipt display |
»» goodsReceiptState |
string |
false |
none |
Indicates the current status of the goods receipt, reflecting its processing stage within the supply chain management system. |
»» purchaseOrderLineItemId |
integer(int64) |
false |
none |
Unique identifier for the purchase order line item |
»» invoiceLineItemLinks |
false |
none |
Array of links to associated invoice line items, facilitating the tracking and management of goods receipt transactions. |
|
»» availableQuantity |
integer(int64) |
false |
read-only |
Quantity of available quantity |
»» allowsSystemGenerateNewId |
boolean |
false |
none |
Unique identifier for the allows system generate new |
»» numberRangeIdentifierValue |
string |
false |
none |
Represents a unique identifier for the range of numbers associated with a specific goods receipt line item, facilitating accurate tracking and management of inventory. |
»» 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. |
|
»» 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. |
|
» vendorPaymentId |
integer(int64) |
false |
none |
Unique identifier for the vendor payment |
» purchaseRequisitionLineItemId |
integer(int64) |
false |
none |
Unique identifier for the purchase requisition line item |
» purchaseRequisitionDisplayId |
string |
false |
none |
Unique identifier for the purchase requisition display |
» purchaseRequisitionLineItemAvailableQuantity |
integer(int64) |
false |
none |
Quantity of purchase requisition line item available quantity |
» remainingQuantity |
integer(int64) |
false |
read-only |
Quantity of remaining quantity |
» availableQuantity |
integer(int64) |
false |
read-only |
Quantity of available quantity |
» allowsSystemGenerateNewId |
boolean |
false |
none |
Unique identifier for the allows system generate new |
» numberRangeIdentifierValue |
string |
false |
none |
Represents the specific range identifier for the purchase order line item, facilitating accurate tracking and management of inventory levels. |
» 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. |
|
» 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. |
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 |
goodsReceiptState |
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 |
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 |
purchaseOrderState |
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 |
Allocate Purchase Requisition Line Items To Purchase Order Line Items¶
HTTP Request
POST /api/v1/purchase-order-line-item/allocate-from-purchase-requisition-line-items
📋 Description: Creates new purchase order line items pre-populated from the specified purchase requisition line items. Each allocation DTO maps a PR line item to its target purchase order. 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 allocation details for purchase order line items sourced from specified purchase requisition line items, facilitating efficient inventory management. |
Body Parameters
1[
2 {
3 "purchaseRequisitionLineItemId": 0,
4 "purchaseOrderId": 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 "taxLineItems": [
24 {
25 "id": 0,
26 "taxRate": 0.1,
27 "taxAmount": 0,
28 "taxType": "string",
29 "purchaseOrderLineItemId": 0
30 }
31 ]
32 }
33]
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 "quantity": 0,
6 "allocatedQuantity": 0,
7 "receivedQuantity": 0,
8 "unitPrice": 0,
9 "description": "string",
10 "expenseCategory": {
11 "id": 0,
12 "displayId": "string",
13 "status": "CREATED",
14 "name": "string",
15 "expenseCategoryType": "PAYMENT"
16 },
17 "costCenter": {
18 "id": 0,
19 "displayId": "string",
20 "status": "CREATED",
21 "name": "string",
22 "erpSystemId": 0
23 },
24 "profitCenter": {
25 "id": 0,
26 "displayId": "string",
27 "status": "CREATED",
28 "name": "string",
29 "validTo": "2019-08-24",
30 "erpSystemId": 0,
31 "erpSystemDisplayId": "string"
32 },
33 "taxJurisdiction": {
34 "id": 0,
35 "displayId": "string",
36 "status": "CREATED",
37 "name": "string",
38 "erpSystemId": 0,
39 "schema": "string",
40 "countryDisplayId": "string"
41 },
42 "taxCode": {
43 "id": 0,
44 "displayId": "string",
45 "status": "CREATED",
46 "name": "string",
47 "erpSystemId": 0
48 },
49 "taxLineItems": [
50 {
51 "id": 0,
52 "taxRate": 0.1,
53 "taxAmount": 0,
54 "taxType": "string",
55 "purchaseOrderLineItemId": 0
56 }
57 ],
58 "purchaseOrderId": 0,
59 "purchaseOrderDisplayId": "string",
60 "purchaseOrderState": "INV_DRAFT",
61 "invoiceLineItems": [
62 {
63 "id": 0,
64 "displayId": "string",
65 "expenseCategory": {
66 "id": 0,
67 "displayId": "string",
68 "status": "CREATED",
69 "name": "string",
70 "expenseCategoryType": "PAYMENT"
71 },
72 "description": "string",
73 "unitOfMeasure": {
74 "id": 0,
75 "displayId": "string",
76 "status": "CREATED",
77 "name": "string",
78 "erpSystemId": 0
79 },
80 "quantity": 0,
81 "unitPrice": 0,
82 "taxJurisdiction": {
83 "id": 0,
84 "displayId": "string",
85 "status": "CREATED",
86 "name": "string",
87 "erpSystemId": 0,
88 "schema": "string",
89 "countryDisplayId": "string"
90 },
91 "taxCode": {
92 "id": 0,
93 "displayId": "string",
94 "status": "CREATED",
95 "name": "string",
96 "erpSystemId": 0
97 },
98 "taxExpenseAccount": {
99 "id": 0,
100 "displayId": "string",
101 "generalLedgerAccountName": "string",
102 "generalLedgerAccountCode": "string",
103 "openItemManagement": true,
104 "accountCategory": "BALANCESHEET",
105 "shortName": "string",
106 "longName": "string"
107 },
108 "taxLineItems": [
109 {
110 "id": 0,
111 "taxRate": 0.1,
112 "taxAmount": 0,
113 "taxType": "string",
114 "invoiceLineItemId": 0
115 }
116 ],
117 "workBreakdownStructure": {
118 "id": 0,
119 "displayId": "string",
120 "status": "CREATED",
121 "name": "string",
122 "erpSystemId": 0
123 },
124 "costCenter": {
125 "id": 0,
126 "displayId": "string",
127 "status": "CREATED",
128 "name": "string",
129 "erpSystemId": 0
130 },
131 "profitCenter": {
132 "id": 0,
133 "displayId": "string",
134 "status": "CREATED",
135 "name": "string",
136 "validTo": "2019-08-24",
137 "erpSystemId": 0,
138 "erpSystemDisplayId": "string"
139 },
140 "functionalArea": {
141 "id": 0,
142 "displayId": "string",
143 "status": "CREATED",
144 "name": "string",
145 "erpSystemId": 0
146 },
147 "businessArea": {
148 "id": 0,
149 "displayId": "string",
150 "status": "CREATED",
151 "name": "string",
152 "erpSystemId": 0
153 },
154 "segment": {
155 "id": 0,
156 "displayId": "string",
157 "status": "CREATED",
158 "name": "string",
159 "erpSystemId": 0
160 },
161 "network": {
162 "id": 0,
163 "displayId": "string",
164 "status": "CREATED",
165 "name": "string",
166 "erpSystemId": 0
167 },
168 "internalOrderType": {
169 "id": 0,
170 "displayId": "string",
171 "status": "CREATED",
172 "name": "string",
173 "erpSystemId": 0
174 },
175 "internalOrder": {
176 "id": 0,
177 "displayId": "string",
178 "status": "CREATED",
179 "name": "string",
180 "erpSystemId": 0,
181 "internalOrderTypeId": 0
182 },
183 "additionalCurrencies": [
184 {
185 "id": 0,
186 "amount": 0,
187 "currency": {
188 "id": 0,
189 "displayId": "string",
190 "status": "CREATED",
191 "name": "string",
192 "decimalPoints": 0
193 },
194 "conversionRate": 0,
195 "conversionDate": "2019-08-24",
196 "translationDateType": "DOCUMENT_DATE",
197 "amountType": "NET_AMOUNT",
198 "currencyDefinitionType": "CONTRACT_CURRENCY",
199 "invoiceEntryId": 0,
200 "invoiceEntryDisplayId": "string"
201 }
202 ],
203 "scheduledPaymentMatches": [
204 {
205 "id": 0,
206 "fromId": 0,
207 "toId": 0,
208 "amount": 0
209 }
210 ],
211 "goodsReceiptLineItemLinks": [
212 {
213 "id": 0,
214 "fromId": 0,
215 "toId": 0,
216 "linkedQuantity": 0
217 }
218 ],
219 "invoiceId": 0,
220 "invoiceDisplayId": "string",
221 "invoiceState": "INV_DRAFT",
222 "vendorPaymentId": 0,
223 "purchaseOrderLineItemId": 0,
224 "netAmount": 0,
225 "allowsSystemGenerateNewId": true,
226 "numberRangeIdentifierValue": "string",
227 "numberRangeIdentifierType": {
228 "name": "string"
229 },
230 "numberRangeType": {
231 "name": "string"
232 }
233 }
234 ],
235 "goodsReceiptLineItems": [
236 {
237 "id": 0,
238 "displayId": "string",
239 "quantity": 0,
240 "invoicedQuantity": 0,
241 "description": "string",
242 "expenseCategory": {
243 "id": 0,
244 "displayId": "string",
245 "status": "CREATED",
246 "name": "string",
247 "expenseCategoryType": "PAYMENT"
248 },
249 "goodsReceiptId": 0,
250 "goodsReceiptDisplayId": "string",
251 "goodsReceiptState": "INV_DRAFT",
252 "purchaseOrderLineItemId": 0,
253 "invoiceLineItemLinks": [
254 {
255 "id": 0,
256 "fromId": 0,
257 "toId": 0,
258 "linkedQuantity": 0
259 }
260 ],
261 "availableQuantity": 0,
262 "allowsSystemGenerateNewId": true,
263 "numberRangeIdentifierValue": "string",
264 "numberRangeIdentifierType": {
265 "name": "string"
266 },
267 "numberRangeType": {
268 "name": "string"
269 }
270 }
271 ],
272 "vendorPaymentId": 0,
273 "purchaseRequisitionLineItemId": 0,
274 "purchaseRequisitionDisplayId": "string",
275 "purchaseRequisitionLineItemAvailableQuantity": 0,
276 "remainingQuantity": 0,
277 "availableQuantity": 0,
278 "allowsSystemGenerateNewId": true,
279 "numberRangeIdentifierValue": "string",
280 "numberRangeIdentifierType": {
281 "name": "string"
282 },
283 "numberRangeType": {
284 "name": "string"
285 }
286 }
287]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a line item within a purchase order, detailing product specifications, quantities, and pricing to facilitate accurate procurement and inventory management.] |
|
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» displayId |
string |
false |
none |
Unique identifier for the display |
» quantity |
integer(int64) |
false |
none |
Quantity value |
» allocatedQuantity |
integer(int64) |
false |
none |
Quantity of allocated quantity |
» receivedQuantity |
integer(int64) |
false |
none |
Quantity of received quantity |
» unitPrice |
number |
false |
none |
The unitPrice field represents the cost per individual item within a purchase order line item, essential for accurate financial reporting and inventory management. |
» description |
string |
false |
none |
Description of the resource |
» 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 |
» 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 |
» 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 |
» taxLineItems |
false |
none |
An array of tax line items associated with the purchase order, detailing the applicable taxes for each line item. |
|
»» 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 |
»» purchaseOrderLineItemId |
integer(int64) |
false |
none |
Unique identifier for the purchase order line item |
» purchaseOrderId |
integer(int64) |
true |
none |
Unique identifier for the purchase order |
» purchaseOrderDisplayId |
string |
false |
none |
Unique identifier for the purchase order display |
» purchaseOrderState |
string |
false |
none |
Indicates the current status of the purchase order, reflecting its progress through the procurement process. |
» invoiceLineItems |
false |
none |
An array of line items associated with the invoice, detailing each product or service included in the purchase order. |
|
»» 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. |
|
»» 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. |
|
»» taxCode |
false |
none |
Data transfer object representing a simplified tax code, designed to facilitate efficient tax calculations and compliance within financial applications. |
|
»» 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. |
|
»» 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. |
|
»» 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 |
» goodsReceiptLineItems |
false |
none |
An array of line items associated with the goods receipt, detailing each purchased order’s specifics for accurate inventory and financial tracking. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» quantity |
integer(int64) |
false |
none |
Quantity value |
»» invoicedQuantity |
integer(int64) |
false |
none |
Quantity of invoiced quantity |
»» description |
string |
false |
none |
Description of the resource |
»» expenseCategory |
false |
none |
Data transfer object representing a simplified categorization of expenses, enabling efficient tracking and reporting of financial allocations within the organization. |
|
»» goodsReceiptId |
integer(int64) |
true |
none |
Unique identifier for the goods receipt |
»» goodsReceiptDisplayId |
string |
false |
none |
Unique identifier for the goods receipt display |
»» goodsReceiptState |
string |
false |
none |
Indicates the current status of the goods receipt, reflecting its processing stage within the supply chain management system. |
»» purchaseOrderLineItemId |
integer(int64) |
false |
none |
Unique identifier for the purchase order line item |
»» invoiceLineItemLinks |
false |
none |
Array of links to associated invoice line items, facilitating the tracking and management of goods receipt transactions. |
|
»» availableQuantity |
integer(int64) |
false |
read-only |
Quantity of available quantity |
»» allowsSystemGenerateNewId |
boolean |
false |
none |
Unique identifier for the allows system generate new |
»» numberRangeIdentifierValue |
string |
false |
none |
Represents a unique identifier for the range of numbers associated with a specific goods receipt line item, facilitating accurate tracking and management of inventory. |
»» 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. |
|
»» 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. |
|
» vendorPaymentId |
integer(int64) |
false |
none |
Unique identifier for the vendor payment |
» purchaseRequisitionLineItemId |
integer(int64) |
false |
none |
Unique identifier for the purchase requisition line item |
» purchaseRequisitionDisplayId |
string |
false |
none |
Unique identifier for the purchase requisition display |
» purchaseRequisitionLineItemAvailableQuantity |
integer(int64) |
false |
none |
Quantity of purchase requisition line item available quantity |
» remainingQuantity |
integer(int64) |
false |
read-only |
Quantity of remaining quantity |
» availableQuantity |
integer(int64) |
false |
read-only |
Quantity of available quantity |
» allowsSystemGenerateNewId |
boolean |
false |
none |
Unique identifier for the allows system generate new |
» numberRangeIdentifierValue |
string |
false |
none |
Represents the specific range identifier for the purchase order line item, facilitating accurate tracking and management of inventory levels. |
» 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. |
|
» 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. |
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 |
goodsReceiptState |
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 |
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 |
purchaseOrderState |
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 Purchase Order Line Item Search¶
HTTP Request
POST /api/v1/purchase-order-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 purchase order line items, including filters such as item details, quantities, and status to facilitate targeted 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 "quantity": 0,
7 "allocatedQuantity": 0,
8 "receivedQuantity": 0,
9 "unitPrice": 0,
10 "description": "string",
11 "expenseCategory": {
12 "id": 0,
13 "displayId": "string",
14 "status": "CREATED",
15 "name": "string",
16 "expenseCategoryType": "PAYMENT"
17 },
18 "costCenter": {
19 "id": 0,
20 "displayId": "string",
21 "status": "CREATED",
22 "name": "string",
23 "erpSystemId": 0
24 },
25 "profitCenter": {
26 "id": 0,
27 "displayId": "string",
28 "status": "CREATED",
29 "name": "string",
30 "validTo": "2019-08-24",
31 "erpSystemId": 0,
32 "erpSystemDisplayId": "string"
33 },
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 "taxLineItems": [
51 {
52 "id": 0,
53 "taxRate": 0.1,
54 "taxAmount": 0,
55 "taxType": "string",
56 "purchaseOrderLineItemId": 0
57 }
58 ],
59 "purchaseOrderId": 0,
60 "purchaseOrderDisplayId": "string",
61 "purchaseOrderState": "INV_DRAFT",
62 "invoiceLineItems": [
63 {
64 "id": 0,
65 "displayId": "string",
66 "expenseCategory": {
67 "id": 0,
68 "displayId": "string",
69 "status": "CREATED",
70 "name": "string",
71 "expenseCategoryType": "PAYMENT"
72 },
73 "description": "string",
74 "unitOfMeasure": {
75 "id": 0,
76 "displayId": "string",
77 "status": "CREATED",
78 "name": "string",
79 "erpSystemId": 0
80 },
81 "quantity": 0,
82 "unitPrice": 0,
83 "taxJurisdiction": {
84 "id": 0,
85 "displayId": "string",
86 "status": "CREATED",
87 "name": "string",
88 "erpSystemId": 0,
89 "schema": "string",
90 "countryDisplayId": "string"
91 },
92 "taxCode": {
93 "id": 0,
94 "displayId": "string",
95 "status": "CREATED",
96 "name": "string",
97 "erpSystemId": 0
98 },
99 "taxExpenseAccount": {
100 "id": 0,
101 "displayId": "string",
102 "generalLedgerAccountName": "string",
103 "generalLedgerAccountCode": "string",
104 "openItemManagement": true,
105 "accountCategory": "BALANCESHEET",
106 "shortName": "string",
107 "longName": "string"
108 },
109 "taxLineItems": [
110 {
111 "id": 0,
112 "taxRate": 0.1,
113 "taxAmount": 0,
114 "taxType": "string",
115 "invoiceLineItemId": 0
116 }
117 ],
118 "workBreakdownStructure": {
119 "id": 0,
120 "displayId": "string",
121 "status": "CREATED",
122 "name": "string",
123 "erpSystemId": 0
124 },
125 "costCenter": {
126 "id": 0,
127 "displayId": "string",
128 "status": "CREATED",
129 "name": "string",
130 "erpSystemId": 0
131 },
132 "profitCenter": {
133 "id": 0,
134 "displayId": "string",
135 "status": "CREATED",
136 "name": "string",
137 "validTo": "2019-08-24",
138 "erpSystemId": 0,
139 "erpSystemDisplayId": "string"
140 },
141 "functionalArea": {
142 "id": 0,
143 "displayId": "string",
144 "status": "CREATED",
145 "name": "string",
146 "erpSystemId": 0
147 },
148 "businessArea": {
149 "id": 0,
150 "displayId": "string",
151 "status": "CREATED",
152 "name": "string",
153 "erpSystemId": 0
154 },
155 "segment": {
156 "id": 0,
157 "displayId": "string",
158 "status": "CREATED",
159 "name": "string",
160 "erpSystemId": 0
161 },
162 "network": {
163 "id": 0,
164 "displayId": "string",
165 "status": "CREATED",
166 "name": "string",
167 "erpSystemId": 0
168 },
169 "internalOrderType": {
170 "id": 0,
171 "displayId": "string",
172 "status": "CREATED",
173 "name": "string",
174 "erpSystemId": 0
175 },
176 "internalOrder": {
177 "id": 0,
178 "displayId": "string",
179 "status": "CREATED",
180 "name": "string",
181 "erpSystemId": 0,
182 "internalOrderTypeId": 0
183 },
184 "additionalCurrencies": [
185 {
186 "id": 0,
187 "amount": 0,
188 "currency": {
189 "id": 0,
190 "displayId": "string",
191 "status": "CREATED",
192 "name": "string",
193 "decimalPoints": 0
194 },
195 "conversionRate": 0,
196 "conversionDate": "2019-08-24",
197 "translationDateType": "DOCUMENT_DATE",
198 "amountType": "NET_AMOUNT",
199 "currencyDefinitionType": "CONTRACT_CURRENCY",
200 "invoiceEntryId": 0,
201 "invoiceEntryDisplayId": "string"
202 }
203 ],
204 "scheduledPaymentMatches": [
205 {
206 "id": 0,
207 "fromId": 0,
208 "toId": 0,
209 "amount": 0
210 }
211 ],
212 "goodsReceiptLineItemLinks": [
213 {
214 "id": 0,
215 "fromId": 0,
216 "toId": 0,
217 "linkedQuantity": 0
218 }
219 ],
220 "invoiceId": 0,
221 "invoiceDisplayId": "string",
222 "invoiceState": "INV_DRAFT",
223 "vendorPaymentId": 0,
224 "purchaseOrderLineItemId": 0,
225 "netAmount": 0,
226 "allowsSystemGenerateNewId": true,
227 "numberRangeIdentifierValue": "string",
228 "numberRangeIdentifierType": {
229 "name": "string"
230 },
231 "numberRangeType": {
232 "name": "string"
233 }
234 }
235 ],
236 "goodsReceiptLineItems": [
237 {
238 "id": 0,
239 "displayId": "string",
240 "quantity": 0,
241 "invoicedQuantity": 0,
242 "description": "string",
243 "expenseCategory": {
244 "id": 0,
245 "displayId": "string",
246 "status": "CREATED",
247 "name": "string",
248 "expenseCategoryType": "PAYMENT"
249 },
250 "goodsReceiptId": 0,
251 "goodsReceiptDisplayId": "string",
252 "goodsReceiptState": "INV_DRAFT",
253 "purchaseOrderLineItemId": 0,
254 "invoiceLineItemLinks": [
255 {
256 "id": 0,
257 "fromId": 0,
258 "toId": 0,
259 "linkedQuantity": 0
260 }
261 ],
262 "availableQuantity": 0,
263 "allowsSystemGenerateNewId": true,
264 "numberRangeIdentifierValue": "string",
265 "numberRangeIdentifierType": {
266 "name": "string"
267 },
268 "numberRangeType": {
269 "name": "string"
270 }
271 }
272 ],
273 "vendorPaymentId": 0,
274 "purchaseRequisitionLineItemId": 0,
275 "purchaseRequisitionDisplayId": "string",
276 "purchaseRequisitionLineItemAvailableQuantity": 0,
277 "remainingQuantity": 0,
278 "availableQuantity": 0,
279 "allowsSystemGenerateNewId": true,
280 "numberRangeIdentifierValue": "string",
281 "numberRangeIdentifierType": {
282 "name": "string"
283 },
284 "numberRangeType": {
285 "name": "string"
286 }
287 }
288 ],
289 "facets": {
290 "property1": {},
291 "property2": {}
292 },
293 "aggregations": {
294 "property1": {},
295 "property2": {}
296 },
297 "pagination": {
298 "number": 0,
299 "size": 0,
300 "totalElements": 0,
301 "totalPages": 0,
302 "first": true,
303 "last": true,
304 "empty": true,
305 "numberOfElements": 0
306 }
307}
List All Resources¶
HTTP Request
GET /api/v1/purchase-order-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 of the purchase order line items should be returned in a paginated format, facilitating efficient data retrieval. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
||
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
Example Responses
1{
2 "totalPages": 0,
3 "totalElements": 0,
4 "pageable": {
5 "pageNumber": 0,
6 "unpaged": true,
7 "paged": true,
8 "pageSize": 0,
9 "offset": 0,
10 "sort": {
11 "unsorted": true,
12 "sorted": true,
13 "empty": true
14 }
15 },
16 "numberOfElements": 0,
17 "size": 0,
18 "content": [
19 {
20 "id": 0,
21 "displayId": "string",
22 "quantity": 0,
23 "allocatedQuantity": 0,
24 "receivedQuantity": 0,
25 "unitPrice": 0,
26 "description": "string",
27 "expenseCategory": {
28 "id": 0,
29 "displayId": "string",
30 "status": "CREATED",
31 "name": "string",
32 "expenseCategoryType": "PAYMENT"
33 },
34 "costCenter": {
35 "id": 0,
36 "displayId": "string",
37 "status": "CREATED",
38 "name": "string",
39 "erpSystemId": 0
40 },
41 "profitCenter": {
42 "id": 0,
43 "displayId": "string",
44 "status": "CREATED",
45 "name": "string",
46 "validTo": "2019-08-24",
47 "erpSystemId": 0,
48 "erpSystemDisplayId": "string"
49 },
50 "taxJurisdiction": {
51 "id": 0,
52 "displayId": "string",
53 "status": "CREATED",
54 "name": "string",
55 "erpSystemId": 0,
56 "schema": "string",
57 "countryDisplayId": "string"
58 },
59 "taxCode": {
60 "id": 0,
61 "displayId": "string",
62 "status": "CREATED",
63 "name": "string",
64 "erpSystemId": 0
65 },
66 "taxLineItems": [
67 {
68 "id": 0,
69 "taxRate": 0.1,
70 "taxAmount": 0,
71 "taxType": "string",
72 "purchaseOrderLineItemId": 0
73 }
74 ],
75 "purchaseOrderId": 0,
76 "purchaseOrderDisplayId": "string",
77 "purchaseOrderState": "INV_DRAFT",
78 "invoiceLineItems": [
79 {
80 "id": 0,
81 "displayId": "string",
82 "expenseCategory": {
83 "id": 0,
84 "displayId": "string",
85 "status": "CREATED",
86 "name": "string",
87 "expenseCategoryType": "PAYMENT"
88 },
89 "description": "string",
90 "unitOfMeasure": {
91 "id": 0,
92 "displayId": "string",
93 "status": "CREATED",
94 "name": "string",
95 "erpSystemId": 0
96 },
97 "quantity": 0,
98 "unitPrice": 0,
99 "taxJurisdiction": {
100 "id": 0,
101 "displayId": "string",
102 "status": "CREATED",
103 "name": "string",
104 "erpSystemId": 0,
105 "schema": "string",
106 "countryDisplayId": "string"
107 },
108 "taxCode": {
109 "id": 0,
110 "displayId": "string",
111 "status": "CREATED",
112 "name": "string",
113 "erpSystemId": 0
114 },
115 "taxExpenseAccount": {
116 "id": 0,
117 "displayId": "string",
118 "generalLedgerAccountName": "string",
119 "generalLedgerAccountCode": "string",
120 "openItemManagement": true,
121 "accountCategory": "BALANCESHEET",
122 "shortName": "string",
123 "longName": "string"
124 },
125 "taxLineItems": [
126 {
127 "id": 0,
128 "taxRate": 0.1,
129 "taxAmount": 0,
130 "taxType": "string",
131 "invoiceLineItemId": 0
132 }
133 ],
134 "workBreakdownStructure": {
135 "id": 0,
136 "displayId": "string",
137 "status": "CREATED",
138 "name": "string",
139 "erpSystemId": 0
140 },
141 "costCenter": {
142 "id": 0,
143 "displayId": "string",
144 "status": "CREATED",
145 "name": "string",
146 "erpSystemId": 0
147 },
148 "profitCenter": {
149 "id": 0,
150 "displayId": "string",
151 "status": "CREATED",
152 "name": "string",
153 "validTo": "2019-08-24",
154 "erpSystemId": 0,
155 "erpSystemDisplayId": "string"
156 },
157 "functionalArea": {
158 "id": 0,
159 "displayId": "string",
160 "status": "CREATED",
161 "name": "string",
162 "erpSystemId": 0
163 },
164 "businessArea": {
165 "id": 0,
166 "displayId": "string",
167 "status": "CREATED",
168 "name": "string",
169 "erpSystemId": 0
170 },
171 "segment": {
172 "id": 0,
173 "displayId": "string",
174 "status": "CREATED",
175 "name": "string",
176 "erpSystemId": 0
177 },
178 "network": {
179 "id": 0,
180 "displayId": "string",
181 "status": "CREATED",
182 "name": "string",
183 "erpSystemId": 0
184 },
185 "internalOrderType": {
186 "id": 0,
187 "displayId": "string",
188 "status": "CREATED",
189 "name": "string",
190 "erpSystemId": 0
191 },
192 "internalOrder": {
193 "id": 0,
194 "displayId": "string",
195 "status": "CREATED",
196 "name": "string",
197 "erpSystemId": 0,
198 "internalOrderTypeId": 0
199 },
200 "additionalCurrencies": [
201 {
202 "id": 0,
203 "amount": 0,
204 "currency": {
205 "id": 0,
206 "displayId": "string",
207 "status": "CREATED",
208 "name": "string",
209 "decimalPoints": 0
210 },
211 "conversionRate": 0,
212 "conversionDate": "2019-08-24",
213 "translationDateType": "DOCUMENT_DATE",
214 "amountType": "NET_AMOUNT",
215 "currencyDefinitionType": "CONTRACT_CURRENCY",
216 "invoiceEntryId": 0,
217 "invoiceEntryDisplayId": "string"
218 }
219 ],
220 "scheduledPaymentMatches": [
221 {
222 "id": 0,
223 "fromId": 0,
224 "toId": 0,
225 "amount": 0
226 }
227 ],
228 "goodsReceiptLineItemLinks": [
229 {
230 "id": 0,
231 "fromId": 0,
232 "toId": 0,
233 "linkedQuantity": 0
234 }
235 ],
236 "invoiceId": 0,
237 "invoiceDisplayId": "string",
238 "invoiceState": "INV_DRAFT",
239 "vendorPaymentId": 0,
240 "purchaseOrderLineItemId": 0,
241 "netAmount": 0,
242 "allowsSystemGenerateNewId": true,
243 "numberRangeIdentifierValue": "string",
244 "numberRangeIdentifierType": {
245 "name": "string"
246 },
247 "numberRangeType": {
248 "name": "string"
249 }
250 }
251 ],
252 "goodsReceiptLineItems": [
253 {
254 "id": 0,
255 "displayId": "string",
256 "quantity": 0,
257 "invoicedQuantity": 0,
258 "description": "string",
259 "expenseCategory": {
260 "id": 0,
261 "displayId": "string",
262 "status": "CREATED",
263 "name": "string",
264 "expenseCategoryType": "PAYMENT"
265 },
266 "goodsReceiptId": 0,
267 "goodsReceiptDisplayId": "string",
268 "goodsReceiptState": "INV_DRAFT",
269 "purchaseOrderLineItemId": 0,
270 "invoiceLineItemLinks": [
271 {
272 "id": 0,
273 "fromId": 0,
274 "toId": 0,
275 "linkedQuantity": 0
276 }
277 ],
278 "availableQuantity": 0,
279 "allowsSystemGenerateNewId": true,
280 "numberRangeIdentifierValue": "string",
281 "numberRangeIdentifierType": {
282 "name": "string"
283 },
284 "numberRangeType": {
285 "name": "string"
286 }
287 }
288 ],
289 "vendorPaymentId": 0,
290 "purchaseRequisitionLineItemId": 0,
291 "purchaseRequisitionDisplayId": "string",
292 "purchaseRequisitionLineItemAvailableQuantity": 0,
293 "remainingQuantity": 0,
294 "availableQuantity": 0,
295 "allowsSystemGenerateNewId": true,
296 "numberRangeIdentifierValue": "string",
297 "numberRangeIdentifierType": {
298 "name": "string"
299 },
300 "numberRangeType": {
301 "name": "string"
302 }
303 }
304 ],
305 "number": 0,
306 "sort": {
307 "unsorted": true,
308 "sorted": true,
309 "empty": true
310 },
311 "first": true,
312 "last": true,
313 "empty": true
314}
Create A Resource¶
HTTP Request
POST /api/v1/purchase-order-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 purchase order line item, including item specifications, quantities, and pricing information essential for processing the order. |
Body Parameters
1{
2 "id": 0,
3 "displayId": "string",
4 "quantity": 0,
5 "allocatedQuantity": 0,
6 "receivedQuantity": 0,
7 "unitPrice": 0,
8 "description": "string",
9 "expenseCategory": {
10 "id": 0,
11 "displayId": "string",
12 "status": "CREATED",
13 "name": "string",
14 "expenseCategoryType": "PAYMENT"
15 },
16 "costCenter": {
17 "id": 0,
18 "displayId": "string",
19 "status": "CREATED",
20 "name": "string",
21 "erpSystemId": 0
22 },
23 "profitCenter": {
24 "id": 0,
25 "displayId": "string",
26 "status": "CREATED",
27 "name": "string",
28 "validTo": "2019-08-24",
29 "erpSystemId": 0,
30 "erpSystemDisplayId": "string"
31 },
32 "taxJurisdiction": {
33 "id": 0,
34 "displayId": "string",
35 "status": "CREATED",
36 "name": "string",
37 "erpSystemId": 0,
38 "schema": "string",
39 "countryDisplayId": "string"
40 },
41 "taxCode": {
42 "id": 0,
43 "displayId": "string",
44 "status": "CREATED",
45 "name": "string",
46 "erpSystemId": 0
47 },
48 "taxLineItems": [
49 {
50 "id": 0,
51 "taxRate": 0.1,
52 "taxAmount": 0,
53 "taxType": "string",
54 "purchaseOrderLineItemId": 0
55 }
56 ],
57 "purchaseOrderId": 0,
58 "purchaseOrderDisplayId": "string",
59 "purchaseOrderState": "INV_DRAFT",
60 "invoiceLineItems": [
61 {
62 "id": 0,
63 "displayId": "string",
64 "expenseCategory": {
65 "id": 0,
66 "displayId": "string",
67 "status": "CREATED",
68 "name": "string",
69 "expenseCategoryType": "PAYMENT"
70 },
71 "description": "string",
72 "unitOfMeasure": {
73 "id": 0,
74 "displayId": "string",
75 "status": "CREATED",
76 "name": "string",
77 "erpSystemId": 0
78 },
79 "quantity": 0,
80 "unitPrice": 0,
81 "taxJurisdiction": {
82 "id": 0,
83 "displayId": "string",
84 "status": "CREATED",
85 "name": "string",
86 "erpSystemId": 0,
87 "schema": "string",
88 "countryDisplayId": "string"
89 },
90 "taxCode": {
91 "id": 0,
92 "displayId": "string",
93 "status": "CREATED",
94 "name": "string",
95 "erpSystemId": 0
96 },
97 "taxExpenseAccount": {
98 "id": 0,
99 "displayId": "string",
100 "generalLedgerAccountName": "string",
101 "generalLedgerAccountCode": "string",
102 "openItemManagement": true,
103 "accountCategory": "BALANCESHEET",
104 "shortName": "string",
105 "longName": "string"
106 },
107 "taxLineItems": [
108 {
109 "id": 0,
110 "taxRate": 0.1,
111 "taxAmount": 0,
112 "taxType": "string",
113 "invoiceLineItemId": 0
114 }
115 ],
116 "workBreakdownStructure": {
117 "id": 0,
118 "displayId": "string",
119 "status": "CREATED",
120 "name": "string",
121 "erpSystemId": 0
122 },
123 "costCenter": {
124 "id": 0,
125 "displayId": "string",
126 "status": "CREATED",
127 "name": "string",
128 "erpSystemId": 0
129 },
130 "profitCenter": {
131 "id": 0,
132 "displayId": "string",
133 "status": "CREATED",
134 "name": "string",
135 "validTo": "2019-08-24",
136 "erpSystemId": 0,
137 "erpSystemDisplayId": "string"
138 },
139 "functionalArea": {
140 "id": 0,
141 "displayId": "string",
142 "status": "CREATED",
143 "name": "string",
144 "erpSystemId": 0
145 },
146 "businessArea": {
147 "id": 0,
148 "displayId": "string",
149 "status": "CREATED",
150 "name": "string",
151 "erpSystemId": 0
152 },
153 "segment": {
154 "id": 0,
155 "displayId": "string",
156 "status": "CREATED",
157 "name": "string",
158 "erpSystemId": 0
159 },
160 "network": {
161 "id": 0,
162 "displayId": "string",
163 "status": "CREATED",
164 "name": "string",
165 "erpSystemId": 0
166 },
167 "internalOrderType": {
168 "id": 0,
169 "displayId": "string",
170 "status": "CREATED",
171 "name": "string",
172 "erpSystemId": 0
173 },
174 "internalOrder": {
175 "id": 0,
176 "displayId": "string",
177 "status": "CREATED",
178 "name": "string",
179 "erpSystemId": 0,
180 "internalOrderTypeId": 0
181 },
182 "additionalCurrencies": [
183 {
184 "id": 0,
185 "amount": 0,
186 "currency": {
187 "id": 0,
188 "displayId": "string",
189 "status": "CREATED",
190 "name": "string",
191 "decimalPoints": 0
192 },
193 "conversionRate": 0,
194 "conversionDate": "2019-08-24",
195 "translationDateType": "DOCUMENT_DATE",
196 "amountType": "NET_AMOUNT",
197 "currencyDefinitionType": "CONTRACT_CURRENCY",
198 "invoiceEntryId": 0,
199 "invoiceEntryDisplayId": "string"
200 }
201 ],
202 "scheduledPaymentMatches": [
203 {
204 "id": 0,
205 "fromId": 0,
206 "toId": 0,
207 "amount": 0
208 }
209 ],
210 "goodsReceiptLineItemLinks": [
211 {
212 "id": 0,
213 "fromId": 0,
214 "toId": 0,
215 "linkedQuantity": 0
216 }
217 ],
218 "invoiceId": 0,
219 "invoiceDisplayId": "string",
220 "invoiceState": "INV_DRAFT",
221 "vendorPaymentId": 0,
222 "purchaseOrderLineItemId": 0,
223 "netAmount": 0,
224 "allowsSystemGenerateNewId": true,
225 "numberRangeIdentifierValue": "string",
226 "numberRangeIdentifierType": {
227 "name": "string"
228 },
229 "numberRangeType": {
230 "name": "string"
231 }
232 }
233 ],
234 "goodsReceiptLineItems": [
235 {
236 "id": 0,
237 "displayId": "string",
238 "quantity": 0,
239 "invoicedQuantity": 0,
240 "description": "string",
241 "expenseCategory": {
242 "id": 0,
243 "displayId": "string",
244 "status": "CREATED",
245 "name": "string",
246 "expenseCategoryType": "PAYMENT"
247 },
248 "goodsReceiptId": 0,
249 "goodsReceiptDisplayId": "string",
250 "goodsReceiptState": "INV_DRAFT",
251 "purchaseOrderLineItemId": 0,
252 "invoiceLineItemLinks": [
253 {
254 "id": 0,
255 "fromId": 0,
256 "toId": 0,
257 "linkedQuantity": 0
258 }
259 ],
260 "allowsSystemGenerateNewId": true,
261 "numberRangeIdentifierValue": "string",
262 "numberRangeIdentifierType": {
263 "name": "string"
264 },
265 "numberRangeType": {
266 "name": "string"
267 }
268 }
269 ],
270 "vendorPaymentId": 0,
271 "purchaseRequisitionLineItemId": 0,
272 "purchaseRequisitionDisplayId": "string",
273 "purchaseRequisitionLineItemAvailableQuantity": 0,
274 "allowsSystemGenerateNewId": true,
275 "numberRangeIdentifierValue": "string",
276 "numberRangeIdentifierType": {
277 "name": "string"
278 },
279 "numberRangeType": {
280 "name": "string"
281 }
282}
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 "quantity": 0,
18 "allocatedQuantity": 0,
19 "receivedQuantity": 0,
20 "unitPrice": 0,
21 "description": "string",
22 "expenseCategory": {
23 "id": 0,
24 "displayId": "string",
25 "status": "CREATED",
26 "name": "string",
27 "expenseCategoryType": "PAYMENT"
28 },
29 "costCenter": {
30 "id": 0,
31 "displayId": "string",
32 "status": "CREATED",
33 "name": "string",
34 "erpSystemId": 0
35 },
36 "profitCenter": {
37 "id": 0,
38 "displayId": "string",
39 "status": "CREATED",
40 "name": "string",
41 "validTo": "2019-08-24",
42 "erpSystemId": 0,
43 "erpSystemDisplayId": "string"
44 },
45 "taxJurisdiction": {
46 "id": 0,
47 "displayId": "string",
48 "status": "CREATED",
49 "name": "string",
50 "erpSystemId": 0,
51 "schema": "string",
52 "countryDisplayId": "string"
53 },
54 "taxCode": {
55 "id": 0,
56 "displayId": "string",
57 "status": "CREATED",
58 "name": "string",
59 "erpSystemId": 0
60 },
61 "taxLineItems": [
62 {
63 "id": 0,
64 "taxRate": 0.1,
65 "taxAmount": 0,
66 "taxType": "string",
67 "purchaseOrderLineItemId": 0
68 }
69 ],
70 "purchaseOrderId": 0,
71 "purchaseOrderDisplayId": "string",
72 "purchaseOrderState": "INV_DRAFT",
73 "invoiceLineItems": [
74 {
75 "id": 0,
76 "displayId": "string",
77 "expenseCategory": {
78 "id": 0,
79 "displayId": "string",
80 "status": "CREATED",
81 "name": "string",
82 "expenseCategoryType": "PAYMENT"
83 },
84 "description": "string",
85 "unitOfMeasure": {
86 "id": 0,
87 "displayId": "string",
88 "status": "CREATED",
89 "name": "string",
90 "erpSystemId": 0
91 },
92 "quantity": 0,
93 "unitPrice": 0,
94 "taxJurisdiction": {
95 "id": 0,
96 "displayId": "string",
97 "status": "CREATED",
98 "name": "string",
99 "erpSystemId": 0,
100 "schema": "string",
101 "countryDisplayId": "string"
102 },
103 "taxCode": {
104 "id": 0,
105 "displayId": "string",
106 "status": "CREATED",
107 "name": "string",
108 "erpSystemId": 0
109 },
110 "taxExpenseAccount": {
111 "id": 0,
112 "displayId": "string",
113 "generalLedgerAccountName": "string",
114 "generalLedgerAccountCode": "string",
115 "openItemManagement": true,
116 "accountCategory": "BALANCESHEET",
117 "shortName": "string",
118 "longName": "string"
119 },
120 "taxLineItems": [
121 {
122 "id": 0,
123 "taxRate": 0.1,
124 "taxAmount": 0,
125 "taxType": "string",
126 "invoiceLineItemId": 0
127 }
128 ],
129 "workBreakdownStructure": {
130 "id": 0,
131 "displayId": "string",
132 "status": "CREATED",
133 "name": "string",
134 "erpSystemId": 0
135 },
136 "costCenter": {
137 "id": 0,
138 "displayId": "string",
139 "status": "CREATED",
140 "name": "string",
141 "erpSystemId": 0
142 },
143 "profitCenter": {
144 "id": 0,
145 "displayId": "string",
146 "status": "CREATED",
147 "name": "string",
148 "validTo": "2019-08-24",
149 "erpSystemId": 0,
150 "erpSystemDisplayId": "string"
151 },
152 "functionalArea": {
153 "id": 0,
154 "displayId": "string",
155 "status": "CREATED",
156 "name": "string",
157 "erpSystemId": 0
158 },
159 "businessArea": {
160 "id": 0,
161 "displayId": "string",
162 "status": "CREATED",
163 "name": "string",
164 "erpSystemId": 0
165 },
166 "segment": {
167 "id": 0,
168 "displayId": "string",
169 "status": "CREATED",
170 "name": "string",
171 "erpSystemId": 0
172 },
173 "network": {
174 "id": 0,
175 "displayId": "string",
176 "status": "CREATED",
177 "name": "string",
178 "erpSystemId": 0
179 },
180 "internalOrderType": {
181 "id": 0,
182 "displayId": "string",
183 "status": "CREATED",
184 "name": "string",
185 "erpSystemId": 0
186 },
187 "internalOrder": {
188 "id": 0,
189 "displayId": "string",
190 "status": "CREATED",
191 "name": "string",
192 "erpSystemId": 0,
193 "internalOrderTypeId": 0
194 },
195 "additionalCurrencies": [
196 {
197 "id": 0,
198 "amount": 0,
199 "currency": {
200 "id": 0,
201 "displayId": "string",
202 "status": "CREATED",
203 "name": "string",
204 "decimalPoints": 0
205 },
206 "conversionRate": 0,
207 "conversionDate": "2019-08-24",
208 "translationDateType": "DOCUMENT_DATE",
209 "amountType": "NET_AMOUNT",
210 "currencyDefinitionType": "CONTRACT_CURRENCY",
211 "invoiceEntryId": 0,
212 "invoiceEntryDisplayId": "string"
213 }
214 ],
215 "scheduledPaymentMatches": [
216 {
217 "id": 0,
218 "fromId": 0,
219 "toId": 0,
220 "amount": 0
221 }
222 ],
223 "goodsReceiptLineItemLinks": [
224 {
225 "id": 0,
226 "fromId": 0,
227 "toId": 0,
228 "linkedQuantity": 0
229 }
230 ],
231 "invoiceId": 0,
232 "invoiceDisplayId": "string",
233 "invoiceState": "INV_DRAFT",
234 "vendorPaymentId": 0,
235 "purchaseOrderLineItemId": 0,
236 "netAmount": 0,
237 "allowsSystemGenerateNewId": true,
238 "numberRangeIdentifierValue": "string",
239 "numberRangeIdentifierType": {
240 "name": "string"
241 },
242 "numberRangeType": {
243 "name": "string"
244 }
245 }
246 ],
247 "goodsReceiptLineItems": [
248 {
249 "id": 0,
250 "displayId": "string",
251 "quantity": 0,
252 "invoicedQuantity": 0,
253 "description": "string",
254 "expenseCategory": {
255 "id": 0,
256 "displayId": "string",
257 "status": "CREATED",
258 "name": "string",
259 "expenseCategoryType": "PAYMENT"
260 },
261 "goodsReceiptId": 0,
262 "goodsReceiptDisplayId": "string",
263 "goodsReceiptState": "INV_DRAFT",
264 "purchaseOrderLineItemId": 0,
265 "invoiceLineItemLinks": [
266 {
267 "id": 0,
268 "fromId": 0,
269 "toId": 0,
270 "linkedQuantity": 0
271 }
272 ],
273 "availableQuantity": 0,
274 "allowsSystemGenerateNewId": true,
275 "numberRangeIdentifierValue": "string",
276 "numberRangeIdentifierType": {
277 "name": "string"
278 },
279 "numberRangeType": {
280 "name": "string"
281 }
282 }
283 ],
284 "vendorPaymentId": 0,
285 "purchaseRequisitionLineItemId": 0,
286 "purchaseRequisitionDisplayId": "string",
287 "purchaseRequisitionLineItemAvailableQuantity": 0,
288 "remainingQuantity": 0,
289 "availableQuantity": 0,
290 "allowsSystemGenerateNewId": true,
291 "numberRangeIdentifierValue": "string",
292 "numberRangeIdentifierType": {
293 "name": "string"
294 },
295 "numberRangeType": {
296 "name": "string"
297 }
298 }
299}