Matching¶
Find Matching Invoices For A Purchase Order¶
HTTP Request
POST /api/v1/matching/purchase-order/{purchaseOrderId}/with-invoices
📋 Description: Returns a paginated list of invoices that are candidates for matching with the specified purchase order. The optional filter body can narrow results by invoice fields. Each result includes a match-score/status indicator.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
purchaseOrderId |
path |
integer(int64) |
true |
Purchase order ID to find matching invoices for |
body |
body |
object |
true |
Request body containing the invoice details associated with the specified purchase order, including amounts, dates, and relevant identifiers for accurate processing and reconciliation. |
» filter |
body |
false |
Data transfer object representing the criteria for filtering invoices, enabling users to efficiently retrieve and manage invoice data based on specific parameters. |
|
»» idIn |
body |
[integer] |
false |
Filter by multiple values of id |
»» idEqual |
body |
integer(int64) |
false |
Filter by exact match of id |
»» idLike |
body |
string |
false |
Filter by partial match of id |
»» createdAtGreaterThanOrEqual |
body |
string(date-time) |
false |
Filter where created at is greater than or equal to specified value |
»» createdAtLessThanOrEqual |
body |
string(date-time) |
false |
Filter where created at is less than or equal to specified value |
»» createdByLike |
body |
string |
false |
Filter by partial match of created by |
»» createdByEqual |
body |
string |
false |
Filter by exact match of created by |
»» modifiedAtGreaterThanOrEqual |
body |
string(date-time) |
false |
Filter where modified at is greater than or equal to specified value |
»» modifiedAtLessThanOrEqual |
body |
string(date-time) |
false |
Filter where modified at is less than or equal to specified value |
»» modifiedByLike |
body |
string |
false |
Filter by partial match of modified by |
»» modifiedByEqual |
body |
string |
false |
Filter by exact match of modified by |
»» displayIdIn |
body |
[string] |
false |
Filter by multiple values of display id |
»» displayIdLike |
body |
string |
false |
Filter by partial match of display id |
»» uiSelector |
body |
string |
false |
String used to specify the user interface element selector for filtering invoices within the Invoice Data Transfer Object. |
»» nameLike |
body |
string |
false |
Filter by partial match of name |
»» stateEqual |
body |
string |
false |
Filter by exact match of state |
»» stateIn |
body |
[string] |
false |
Filter by multiple values of state |
»» externalDocumentNumberLike |
body |
string |
false |
Filter by partial match of external document number |
»» invoiceDateGreaterThanOrEqual |
body |
string(date) |
false |
Filter where invoice date is greater than or equal to specified value |
»» invoiceDateLessThanOrEqual |
body |
string(date) |
false |
Filter where invoice date is less than or equal to specified value |
»» vendorIdEqual |
body |
integer(int64) |
false |
Filter by exact match of vendor id |
»» vendorIdIn |
body |
[integer] |
false |
Filter by multiple values of vendor id |
»» companyIdEqual |
body |
integer(int64) |
false |
Filter by exact match of company id |
»» companyIdIn |
body |
[integer] |
false |
Filter by multiple values of company id |
» pageable |
body |
false |
Data transfer object representing a paginated collection of results, enabling efficient navigation and retrieval of large datasets within the API. This schema supports enhanced user experience by facilitating organized data presentation and management. |
|
»» page |
body |
integer(int32) |
false |
Page number for pagination |
»» size |
body |
integer(int32) |
false |
Number of items per page |
»» sort |
body |
[string] |
false |
Sort order specification |
Enumerated Values
Attribute |
Value |
|---|---|
»» stateEqual |
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 |
»» stateIn |
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 |
Parameter Constraints¶
Parameter |
Constraints |
|---|---|
»» page |
Min: 0 |
»» size |
Min: 1 |
Body Parameters
1{
2 "filter": {
3 "idIn": [
4 0
5 ],
6 "idEqual": 0,
7 "idLike": "string",
8 "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
9 "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
10 "createdByLike": "string",
11 "createdByEqual": "string",
12 "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
13 "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
14 "modifiedByLike": "string",
15 "modifiedByEqual": "string",
16 "displayIdIn": [
17 "string"
18 ],
19 "displayIdLike": "string",
20 "uiSelector": "string",
21 "nameLike": "string",
22 "stateEqual": "INV_DRAFT",
23 "stateIn": [
24 "INV_DRAFT"
25 ],
26 "externalDocumentNumberLike": "string",
27 "invoiceDateGreaterThanOrEqual": "2019-08-24",
28 "invoiceDateLessThanOrEqual": "2019-08-24",
29 "vendorIdEqual": 0,
30 "vendorIdIn": [
31 0
32 ],
33 "companyIdEqual": 0,
34 "companyIdIn": [
35 0
36 ]
37 },
38 "pageable": {
39 "page": 0,
40 "size": 1,
41 "sort": [
42 "string"
43 ]
44 }
45}
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 "matchedItem": {
21 "id": 0,
22 "displayId": "string",
23 "name": "string",
24 "invoiceType": "VENDOR_INV",
25 "state": "INV_DRAFT",
26 "externalDocumentNumber": "string",
27 "purchaseOrderReference": "string",
28 "invoiceDate": "2019-08-24",
29 "dueDate": "2019-08-24",
30 "notes": "string",
31 "billingPeriodFromDate": "2019-08-24",
32 "billingPeriodToDate": "2019-08-24",
33 "currency": {
34 "id": 0,
35 "displayId": "string",
36 "status": "CREATED",
37 "name": "string",
38 "decimalPoints": 0
39 },
40 "vendor": {
41 "id": 0,
42 "displayId": "string",
43 "status": "CREATED",
44 "name": "string",
45 "erpSystemDisplayId": "string"
46 },
47 "company": {
48 "id": 0,
49 "displayId": "string",
50 "status": "CREATED",
51 "erpSystemId": 0,
52 "erpSystemDisplayId": "string",
53 "countryId": 0,
54 "countryDisplayId": "string",
55 "name": "string",
56 "postingPeriodVariantId": 0,
57 "fiscalVariantId": 0
58 },
59 "netAmount": 0,
60 "taxAmount": 0,
61 "totalAmount": 0,
62 "netAmountBalance": 0,
63 "taxAmountBalance": 0,
64 "paymentTerm": {
65 "id": 0,
66 "displayId": "string",
67 "status": "CREATED",
68 "name": "string"
69 },
70 "paymentMethod": {
71 "id": 0,
72 "displayId": "string",
73 "status": "CREATED",
74 "name": "string",
75 "type": "string"
76 },
77 "paymentBlock": {
78 "id": 0,
79 "displayId": "string",
80 "status": "CREATED",
81 "name": "string"
82 },
83 "defaultCostCenter": {
84 "id": 0,
85 "displayId": "string",
86 "status": "CREATED",
87 "name": "string",
88 "erpSystemId": 0
89 },
90 "defaultProfitCenter": {
91 "id": 0,
92 "displayId": "string",
93 "status": "CREATED",
94 "name": "string",
95 "validTo": "2019-08-24",
96 "erpSystemId": 0,
97 "erpSystemDisplayId": "string"
98 },
99 "invoiceLineItems": [
100 {
101 "id": 0,
102 "displayId": "string",
103 "expenseCategory": {
104 "id": 0,
105 "displayId": "string",
106 "status": "CREATED",
107 "name": "string",
108 "expenseCategoryType": "PAYMENT"
109 },
110 "description": "string",
111 "unitOfMeasure": {
112 "id": 0,
113 "displayId": "string",
114 "status": "CREATED",
115 "name": "string",
116 "erpSystemId": 0
117 },
118 "quantity": 0,
119 "unitPrice": 0,
120 "taxJurisdiction": {
121 "id": 0,
122 "displayId": "string",
123 "status": "CREATED",
124 "name": "string",
125 "erpSystemId": 0,
126 "schema": "string",
127 "countryDisplayId": "string"
128 },
129 "taxCode": {
130 "id": 0,
131 "displayId": "string",
132 "status": "CREATED",
133 "name": "string",
134 "erpSystemId": 0
135 },
136 "taxExpenseAccount": {
137 "id": 0,
138 "displayId": "string",
139 "generalLedgerAccountName": "string",
140 "generalLedgerAccountCode": "string",
141 "openItemManagement": true,
142 "accountCategory": "BALANCESHEET",
143 "shortName": "string",
144 "longName": "string"
145 },
146 "taxLineItems": [
147 {
148 "id": 0,
149 "taxRate": 0.1,
150 "taxAmount": 0,
151 "taxType": "string",
152 "invoiceLineItemId": 0
153 }
154 ],
155 "workBreakdownStructure": {
156 "id": 0,
157 "displayId": "string",
158 "status": "CREATED",
159 "name": "string",
160 "erpSystemId": 0
161 },
162 "costCenter": {
163 "id": 0,
164 "displayId": "string",
165 "status": "CREATED",
166 "name": "string",
167 "erpSystemId": 0
168 },
169 "profitCenter": {
170 "id": 0,
171 "displayId": "string",
172 "status": "CREATED",
173 "name": "string",
174 "validTo": "2019-08-24",
175 "erpSystemId": 0,
176 "erpSystemDisplayId": "string"
177 },
178 "functionalArea": {
179 "id": 0,
180 "displayId": "string",
181 "status": "CREATED",
182 "name": "string",
183 "erpSystemId": 0
184 },
185 "businessArea": {
186 "id": 0,
187 "displayId": "string",
188 "status": "CREATED",
189 "name": "string",
190 "erpSystemId": 0
191 },
192 "segment": {
193 "id": 0,
194 "displayId": "string",
195 "status": "CREATED",
196 "name": "string",
197 "erpSystemId": 0
198 },
199 "network": {
200 "id": 0,
201 "displayId": "string",
202 "status": "CREATED",
203 "name": "string",
204 "erpSystemId": 0
205 },
206 "internalOrderType": {
207 "id": 0,
208 "displayId": "string",
209 "status": "CREATED",
210 "name": "string",
211 "erpSystemId": 0
212 },
213 "internalOrder": {
214 "id": 0,
215 "displayId": "string",
216 "status": "CREATED",
217 "name": "string",
218 "erpSystemId": 0,
219 "internalOrderTypeId": 0
220 },
221 "additionalCurrencies": [
222 {
223 "id": 0,
224 "amount": 0,
225 "currency": {
226 "id": 0,
227 "displayId": "string",
228 "status": "CREATED",
229 "name": "string",
230 "decimalPoints": 0
231 },
232 "conversionRate": 0,
233 "conversionDate": "2019-08-24",
234 "translationDateType": "DOCUMENT_DATE",
235 "amountType": "NET_AMOUNT",
236 "currencyDefinitionType": "CONTRACT_CURRENCY",
237 "invoiceEntryId": 0,
238 "invoiceEntryDisplayId": "string"
239 }
240 ],
241 "scheduledPaymentMatches": [
242 {
243 "id": 0,
244 "fromId": 0,
245 "toId": 0,
246 "amount": 0
247 }
248 ],
249 "goodsReceiptLineItemLinks": [
250 {
251 "id": 0,
252 "fromId": 0,
253 "toId": 0,
254 "linkedQuantity": 0
255 }
256 ],
257 "invoiceId": 0,
258 "invoiceDisplayId": "string",
259 "invoiceState": "INV_DRAFT",
260 "vendorPaymentId": 0,
261 "purchaseOrderLineItemId": 0,
262 "netAmount": 0,
263 "allowsSystemGenerateNewId": true,
264 "numberRangeIdentifierValue": "string",
265 "numberRangeIdentifierType": {
266 "name": "string"
267 },
268 "numberRangeType": {
269 "name": "string"
270 }
271 }
272 ],
273 "workspaceId": 0,
274 "workspaceDisplayId": "string",
275 "workspaceName": "string",
276 "workspaceState": "INV_DRAFT",
277 "remainingNetAmount": 0,
278 "remainingTaxAmount": 0,
279 "remainingTotalAmount": 0,
280 "pendingPaymentCount": 0,
281 "allPaymentsPosted": true,
282 "approvalInfo": {
283 "approverUsername": "string",
284 "approvedAt": "2019-08-24T14:15:22Z"
285 },
286 "rejectionReason": "string",
287 "allowsSystemGenerateNewId": true,
288 "numberRangeIdentifierValue": "string",
289 "numberRangeIdentifierType": {
290 "name": "string"
291 },
292 "numberRangeType": {
293 "name": "string"
294 }
295 },
296 "totalScore": 0,
297 "matchDetails": [
298 {
299 "payableMatchingType": "VENDOR",
300 "score": 0
301 }
302 ],
303 "confidenceScore": 0.1
304 }
305 ],
306 "number": 0,
307 "sort": {
308 "unsorted": true,
309 "sorted": true,
310 "empty": true
311 },
312 "first": true,
313 "last": true,
314 "empty": true
315}
Unmatch Purchase Orders From An Invoice¶
HTTP Request
POST /api/v1/matching/invoice/{invoiceId}/with-purchase-orders/unmatch
📋 Description: Removes the match associations between the given invoice and the specified purchase orders. Idempotent: purchase orders that were not matched are silently ignored.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
invoiceId |
path |
integer(int64) |
true |
Invoice ID |
body |
body |
array[integer] |
true |
Request body containing the details of the unmatching operation, including the invoice ID and associated purchase order identifiers, to facilitate the disassociation of invoices from their corresponding purchase orders. |
Body Parameters
1[
2 0
3]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
||
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "errorMessage": "string",
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {}
15}
Match Purchase Orders To An Invoice¶
HTTP Request
POST /api/v1/matching/invoice/{invoiceId}/with-purchase-orders/match
📋 Description: Creates persistent match associations between the given invoice and one or more purchase orders. Idempotent: already-matched purchase orders are silently ignored.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
invoiceId |
path |
integer(int64) |
true |
Invoice ID |
body |
body |
array[integer] |
true |
Request body containing the matching criteria and parameters necessary to align the specified invoice with relevant purchase orders for accurate reconciliation. |
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}
Find Matching Purchase Orders For An Invoice¶
HTTP Request
POST /api/v1/matching/invoice/{invoiceId}/with-purchase-orders
📋 Description: Returns a paginated list of purchase orders that are candidates for matching with the specified invoice. The optional filter body can narrow results by PO fields. Each result includes a match-score/status indicator.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
invoiceId |
path |
integer(int64) |
true |
Invoice ID to find matching purchase orders for |
body |
body |
object |
true |
Request body containing the purchase order details associated with the specified invoice, facilitating the matching process for enhanced financial reconciliation. |
» filter |
body |
false |
Data transfer object representing a filter for extended purchase order queries, enabling users to refine search criteria based on specific attributes and business requirements. |
|
»» idIn |
body |
[integer] |
false |
Filter by multiple values of id |
»» idEqual |
body |
integer(int64) |
false |
Filter by exact match of id |
»» idLike |
body |
string |
false |
Filter by partial match of id |
»» createdAtGreaterThanOrEqual |
body |
string(date-time) |
false |
Filter where created at is greater than or equal to specified value |
»» createdAtLessThanOrEqual |
body |
string(date-time) |
false |
Filter where created at is less than or equal to specified value |
»» createdByLike |
body |
string |
false |
Filter by partial match of created by |
»» createdByEqual |
body |
string |
false |
Filter by exact match of created by |
»» modifiedAtGreaterThanOrEqual |
body |
string(date-time) |
false |
Filter where modified at is greater than or equal to specified value |
»» modifiedAtLessThanOrEqual |
body |
string(date-time) |
false |
Filter where modified at is less than or equal to specified value |
»» modifiedByLike |
body |
string |
false |
Filter by partial match of modified by |
»» modifiedByEqual |
body |
string |
false |
Filter by exact match of modified by |
»» displayIdIn |
body |
[string] |
false |
Filter by multiple values of display id |
»» displayIdLike |
body |
string |
false |
Filter by partial match of display id |
»» stateEqual |
body |
string |
false |
Filter by exact match of state |
»» stateIn |
body |
[string] |
false |
Filter by multiple values of state |
»» issueDateEqual |
body |
string(date) |
false |
Filter by exact match of issue date |
»» expectedDeliveryDateEqual |
body |
string(date) |
false |
Filter by exact match of expected delivery date |
»» nameLike |
body |
string |
false |
Filter by partial match of name |
»» shippingAddressLike |
body |
string |
false |
Filter by partial match of shipping address |
»» notesLike |
body |
string |
false |
Filter by partial match of notes |
»» externalPurchaseOrderDisplayIdLike |
body |
string |
false |
Filter by partial match of external purchase order display id |
»» vendorIdEqual |
body |
integer(int64) |
false |
Filter by exact match of vendor id |
»» vendorIdIn |
body |
[integer] |
false |
Filter by multiple values of vendor id |
»» vendorDisplayIdLike |
body |
string |
false |
Filter by partial match of vendor display id |
»» currencyIdEqual |
body |
integer(int64) |
false |
Filter by exact match of currency id |
»» companyIdEqual |
body |
integer(int64) |
false |
Filter by exact match of company id |
»» companyIdIn |
body |
[integer] |
false |
Filter by multiple values of company id |
»» workspaceFilterMode |
body |
string |
false |
Specifies the mode of filtering applied to workspaces within the purchase order context, allowing for tailored data retrieval based on user-defined criteria. |
»» workspaceId |
body |
integer(int64) |
false |
Unique identifier for the workspace |
»» matchFilterMode |
body |
string |
false |
Specifies the criteria used to filter purchase orders, enabling targeted retrieval of relevant data for efficient order management. |
» pageable |
body |
false |
Data transfer object representing a paginated collection of results, enabling efficient navigation and retrieval of large datasets within the API. This schema supports enhanced user experience by facilitating organized data presentation and management. |
|
»» page |
body |
integer(int32) |
false |
Page number for pagination |
»» size |
body |
integer(int32) |
false |
Number of items per page |
»» sort |
body |
[string] |
false |
Sort order specification |
Enumerated Values
Attribute |
Value |
|---|---|
»» matchFilterMode |
ALL, IN_MATCH, NOT_IN_MATCH |
»» stateEqual |
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 |
»» stateIn |
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 |
»» workspaceFilterMode |
ALL, IN_SPECIFIC_WORKSPACE, IN_WORKSPACE, NOT_IN_WORKSPACE |
Parameter Constraints¶
Parameter |
Constraints |
|---|---|
»» page |
Min: 0 |
»» size |
Min: 1 |
Body Parameters
1{
2 "filter": {
3 "idIn": [
4 0
5 ],
6 "idEqual": 0,
7 "idLike": "string",
8 "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
9 "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
10 "createdByLike": "string",
11 "createdByEqual": "string",
12 "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
13 "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
14 "modifiedByLike": "string",
15 "modifiedByEqual": "string",
16 "displayIdIn": [
17 "string"
18 ],
19 "displayIdLike": "string",
20 "stateEqual": "INV_DRAFT",
21 "stateIn": [
22 "INV_DRAFT"
23 ],
24 "issueDateEqual": "2019-08-24",
25 "expectedDeliveryDateEqual": "2019-08-24",
26 "nameLike": "string",
27 "shippingAddressLike": "string",
28 "notesLike": "string",
29 "externalPurchaseOrderDisplayIdLike": "string",
30 "vendorIdEqual": 0,
31 "vendorIdIn": [
32 0
33 ],
34 "vendorDisplayIdLike": "string",
35 "currencyIdEqual": 0,
36 "companyIdEqual": 0,
37 "companyIdIn": [
38 0
39 ],
40 "workspaceFilterMode": "ALL",
41 "workspaceId": 0,
42 "matchFilterMode": "ALL"
43 },
44 "pageable": {
45 "page": 0,
46 "size": 1,
47 "sort": [
48 "string"
49 ]
50 }
51}
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 "matchedItem": {
21 "id": 0,
22 "displayId": "string",
23 "state": "INV_DRAFT",
24 "issueDate": "2019-08-24",
25 "expectedDeliveryDate": "2019-08-24",
26 "name": "string",
27 "shippingAddress": "string",
28 "notes": "string",
29 "netAmount": 0,
30 "taxAmount": 0,
31 "externalPurchaseOrderDisplayId": "string",
32 "vendor": {
33 "id": 0,
34 "displayId": "string",
35 "status": "CREATED",
36 "name": "string",
37 "erpSystemDisplayId": "string"
38 },
39 "currency": {
40 "id": 0,
41 "displayId": "string",
42 "status": "CREATED",
43 "name": "string",
44 "decimalPoints": 0
45 },
46 "company": {
47 "id": 0,
48 "displayId": "string",
49 "status": "CREATED",
50 "erpSystemId": 0,
51 "erpSystemDisplayId": "string",
52 "countryId": 0,
53 "countryDisplayId": "string",
54 "name": "string",
55 "postingPeriodVariantId": 0,
56 "fiscalVariantId": 0
57 },
58 "purchaseOrderLineItems": [
59 {
60 "id": 0,
61 "displayId": "string",
62 "quantity": 0,
63 "allocatedQuantity": 0,
64 "receivedQuantity": 0,
65 "unitPrice": 0,
66 "description": "string",
67 "expenseCategory": {
68 "id": 0,
69 "displayId": "string",
70 "status": "CREATED",
71 "name": "string",
72 "expenseCategoryType": "PAYMENT"
73 },
74 "costCenter": {
75 "id": 0,
76 "displayId": "string",
77 "status": "CREATED",
78 "name": "string",
79 "erpSystemId": 0
80 },
81 "profitCenter": {
82 "id": 0,
83 "displayId": "string",
84 "status": "CREATED",
85 "name": "string",
86 "validTo": "2019-08-24",
87 "erpSystemId": 0,
88 "erpSystemDisplayId": "string"
89 },
90 "taxJurisdiction": {
91 "id": 0,
92 "displayId": "string",
93 "status": "CREATED",
94 "name": "string",
95 "erpSystemId": 0,
96 "schema": "string",
97 "countryDisplayId": "string"
98 },
99 "taxCode": {
100 "id": 0,
101 "displayId": "string",
102 "status": "CREATED",
103 "name": "string",
104 "erpSystemId": 0
105 },
106 "taxLineItems": [
107 {
108 "id": 0,
109 "taxRate": 0.1,
110 "taxAmount": 0,
111 "taxType": "string",
112 "purchaseOrderLineItemId": 0
113 }
114 ],
115 "purchaseOrderId": 0,
116 "purchaseOrderDisplayId": "string",
117 "purchaseOrderState": "INV_DRAFT",
118 "invoiceLineItems": [
119 {
120 "id": 0,
121 "displayId": "string",
122 "expenseCategory": {
123 "id": 0,
124 "displayId": "string",
125 "status": "CREATED",
126 "name": "string",
127 "expenseCategoryType": "PAYMENT"
128 },
129 "description": "string",
130 "unitOfMeasure": {
131 "id": 0,
132 "displayId": "string",
133 "status": "CREATED",
134 "name": "string",
135 "erpSystemId": 0
136 },
137 "quantity": 0,
138 "unitPrice": 0,
139 "taxJurisdiction": {
140 "id": 0,
141 "displayId": "string",
142 "status": "CREATED",
143 "name": "string",
144 "erpSystemId": 0,
145 "schema": "string",
146 "countryDisplayId": "string"
147 },
148 "taxCode": {
149 "id": 0,
150 "displayId": "string",
151 "status": "CREATED",
152 "name": "string",
153 "erpSystemId": 0
154 },
155 "taxExpenseAccount": {
156 "id": 0,
157 "displayId": "string",
158 "generalLedgerAccountName": "string",
159 "generalLedgerAccountCode": "string",
160 "openItemManagement": true,
161 "accountCategory": "BALANCESHEET",
162 "shortName": "string",
163 "longName": "string"
164 },
165 "taxLineItems": [
166 {
167 "id": 0,
168 "taxRate": 0.1,
169 "taxAmount": 0,
170 "taxType": "string",
171 "invoiceLineItemId": 0
172 }
173 ],
174 "workBreakdownStructure": {
175 "id": 0,
176 "displayId": "string",
177 "status": "CREATED",
178 "name": "string",
179 "erpSystemId": 0
180 },
181 "costCenter": {
182 "id": 0,
183 "displayId": "string",
184 "status": "CREATED",
185 "name": "string",
186 "erpSystemId": 0
187 },
188 "profitCenter": {
189 "id": 0,
190 "displayId": "string",
191 "status": "CREATED",
192 "name": "string",
193 "validTo": "2019-08-24",
194 "erpSystemId": 0,
195 "erpSystemDisplayId": "string"
196 },
197 "functionalArea": {
198 "id": 0,
199 "displayId": "string",
200 "status": "CREATED",
201 "name": "string",
202 "erpSystemId": 0
203 },
204 "businessArea": {
205 "id": 0,
206 "displayId": "string",
207 "status": "CREATED",
208 "name": "string",
209 "erpSystemId": 0
210 },
211 "segment": {
212 "id": 0,
213 "displayId": "string",
214 "status": "CREATED",
215 "name": "string",
216 "erpSystemId": 0
217 },
218 "network": {
219 "id": 0,
220 "displayId": "string",
221 "status": "CREATED",
222 "name": "string",
223 "erpSystemId": 0
224 },
225 "internalOrderType": {
226 "id": 0,
227 "displayId": "string",
228 "status": "CREATED",
229 "name": "string",
230 "erpSystemId": 0
231 },
232 "internalOrder": {
233 "id": 0,
234 "displayId": "string",
235 "status": "CREATED",
236 "name": "string",
237 "erpSystemId": 0,
238 "internalOrderTypeId": 0
239 },
240 "additionalCurrencies": [
241 {
242 "id": 0,
243 "amount": 0,
244 "currency": {},
245 "conversionRate": 0,
246 "conversionDate": "2019-08-24",
247 "translationDateType": "DOCUMENT_DATE",
248 "amountType": "NET_AMOUNT",
249 "currencyDefinitionType": "CONTRACT_CURRENCY",
250 "invoiceEntryId": 0,
251 "invoiceEntryDisplayId": "string"
252 }
253 ],
254 "scheduledPaymentMatches": [
255 {
256 "id": 0,
257 "fromId": 0,
258 "toId": 0,
259 "amount": 0
260 }
261 ],
262 "goodsReceiptLineItemLinks": [
263 {
264 "id": 0,
265 "fromId": 0,
266 "toId": 0,
267 "linkedQuantity": 0
268 }
269 ],
270 "invoiceId": 0,
271 "invoiceDisplayId": "string",
272 "invoiceState": "INV_DRAFT",
273 "vendorPaymentId": 0,
274 "purchaseOrderLineItemId": 0,
275 "netAmount": 0,
276 "allowsSystemGenerateNewId": true,
277 "numberRangeIdentifierValue": "string",
278 "numberRangeIdentifierType": {
279 "name": "string"
280 },
281 "numberRangeType": {
282 "name": "string"
283 }
284 }
285 ],
286 "goodsReceiptLineItems": [
287 {
288 "id": 0,
289 "displayId": "string",
290 "quantity": 0,
291 "invoicedQuantity": 0,
292 "description": "string",
293 "expenseCategory": {
294 "id": 0,
295 "displayId": "string",
296 "status": "CREATED",
297 "name": "string",
298 "expenseCategoryType": "PAYMENT"
299 },
300 "goodsReceiptId": 0,
301 "goodsReceiptDisplayId": "string",
302 "goodsReceiptState": "INV_DRAFT",
303 "purchaseOrderLineItemId": 0,
304 "invoiceLineItemLinks": [
305 {
306 "id": 0,
307 "fromId": 0,
308 "toId": 0,
309 "linkedQuantity": 0
310 }
311 ],
312 "availableQuantity": 0,
313 "allowsSystemGenerateNewId": true,
314 "numberRangeIdentifierValue": "string",
315 "numberRangeIdentifierType": {
316 "name": "string"
317 },
318 "numberRangeType": {
319 "name": "string"
320 }
321 }
322 ],
323 "vendorPaymentId": 0,
324 "purchaseRequisitionLineItemId": 0,
325 "purchaseRequisitionDisplayId": "string",
326 "purchaseRequisitionLineItemAvailableQuantity": 0,
327 "remainingQuantity": 0,
328 "availableQuantity": 0,
329 "allowsSystemGenerateNewId": true,
330 "numberRangeIdentifierValue": "string",
331 "numberRangeIdentifierType": {
332 "name": "string"
333 },
334 "numberRangeType": {
335 "name": "string"
336 }
337 }
338 ],
339 "purchaseRequisitionIds": [
340 0
341 ],
342 "purchaseRequisitionDisplayIds": [
343 "string"
344 ],
345 "invoices": [
346 {
347 "id": 0,
348 "displayId": "string",
349 "name": "string",
350 "invoiceType": "VENDOR_INV",
351 "state": "INV_DRAFT",
352 "externalDocumentNumber": "string",
353 "purchaseOrderReference": "string",
354 "invoiceDate": "2019-08-24",
355 "dueDate": "2019-08-24",
356 "notes": "string",
357 "billingPeriodFromDate": "2019-08-24",
358 "billingPeriodToDate": "2019-08-24",
359 "currency": {
360 "id": 0,
361 "displayId": "string",
362 "status": "CREATED",
363 "name": "string",
364 "decimalPoints": 0
365 },
366 "vendor": {
367 "id": 0,
368 "displayId": "string",
369 "status": "CREATED",
370 "name": "string",
371 "erpSystemDisplayId": "string"
372 },
373 "company": {
374 "id": 0,
375 "displayId": "string",
376 "status": "CREATED",
377 "erpSystemId": 0,
378 "erpSystemDisplayId": "string",
379 "countryId": 0,
380 "countryDisplayId": "string",
381 "name": "string",
382 "postingPeriodVariantId": 0,
383 "fiscalVariantId": 0
384 },
385 "netAmount": 0,
386 "taxAmount": 0,
387 "totalAmount": 0,
388 "netAmountBalance": 0,
389 "taxAmountBalance": 0,
390 "paymentTerm": {
391 "id": 0,
392 "displayId": "string",
393 "status": "CREATED",
394 "name": "string"
395 },
396 "paymentMethod": {
397 "id": 0,
398 "displayId": "string",
399 "status": "CREATED",
400 "name": "string",
401 "type": "string"
402 },
403 "paymentBlock": {
404 "id": 0,
405 "displayId": "string",
406 "status": "CREATED",
407 "name": "string"
408 },
409 "defaultCostCenter": {
410 "id": 0,
411 "displayId": "string",
412 "status": "CREATED",
413 "name": "string",
414 "erpSystemId": 0
415 },
416 "defaultProfitCenter": {
417 "id": 0,
418 "displayId": "string",
419 "status": "CREATED",
420 "name": "string",
421 "validTo": "2019-08-24",
422 "erpSystemId": 0,
423 "erpSystemDisplayId": "string"
424 },
425 "invoiceLineItems": [
426 {
427 "id": 0,
428 "displayId": "string",
429 "expenseCategory": {
430 "id": 0,
431 "displayId": "string",
432 "status": "CREATED",
433 "name": "string",
434 "expenseCategoryType": "PAYMENT"
435 },
436 "description": "string",
437 "unitOfMeasure": {
438 "id": 0,
439 "displayId": "string",
440 "status": "CREATED",
441 "name": "string",
442 "erpSystemId": 0
443 },
444 "quantity": 0,
445 "unitPrice": 0,
446 "taxJurisdiction": {
447 "id": 0,
448 "displayId": "string",
449 "status": "CREATED",
450 "name": "string",
451 "erpSystemId": 0,
452 "schema": "string",
453 "countryDisplayId": "string"
454 },
455 "taxCode": {
456 "id": 0,
457 "displayId": "string",
458 "status": "CREATED",
459 "name": "string",
460 "erpSystemId": 0
461 },
462 "taxExpenseAccount": {
463 "id": 0,
464 "displayId": "string",
465 "generalLedgerAccountName": "string",
466 "generalLedgerAccountCode": "string",
467 "openItemManagement": true,
468 "accountCategory": "BALANCESHEET",
469 "shortName": "string",
470 "longName": "string"
471 },
472 "taxLineItems": [
473 {
474 "id": 0,
475 "taxRate": 0.1,
476 "taxAmount": 0,
477 "taxType": "string",
478 "invoiceLineItemId": 0
479 }
480 ],
481 "workBreakdownStructure": {
482 "id": 0,
483 "displayId": "string",
484 "status": "CREATED",
485 "name": "string",
486 "erpSystemId": 0
487 },
488 "costCenter": {
489 "id": 0,
490 "displayId": "string",
491 "status": "CREATED",
492 "name": "string",
493 "erpSystemId": 0
494 },
495 "profitCenter": {
496 "id": 0,
497 "displayId": "string",
498 "status": "CREATED",
499 "name": "string",
500 "validTo": "2019-08-24",
501 "erpSystemId": 0,
502 "erpSystemDisplayId": "string"
503 },
504 "functionalArea": {
505 "id": 0,
506 "displayId": "string",
507 "status": "CREATED",
508 "name": "string",
509 "erpSystemId": 0
510 },
511 "businessArea": {
512 "id": 0,
513 "displayId": "string",
514 "status": "CREATED",
515 "name": "string",
516 "erpSystemId": 0
517 },
518 "segment": {
519 "id": 0,
520 "displayId": "string",
521 "status": "CREATED",
522 "name": "string",
523 "erpSystemId": 0
524 },
525 "network": {
526 "id": 0,
527 "displayId": "string",
528 "status": "CREATED",
529 "name": "string",
530 "erpSystemId": 0
531 },
532 "internalOrderType": {
533 "id": 0,
534 "displayId": "string",
535 "status": "CREATED",
536 "name": "string",
537 "erpSystemId": 0
538 },
539 "internalOrder": {
540 "id": 0,
541 "displayId": "string",
542 "status": "CREATED",
543 "name": "string",
544 "erpSystemId": 0,
545 "internalOrderTypeId": 0
546 },
547 "additionalCurrencies": [
548 {
549 "id": 0,
550 "amount": 0,
551 "currency": {},
552 "conversionRate": 0,
553 "conversionDate": "2019-08-24",
554 "translationDateType": "DOCUMENT_DATE",
555 "amountType": "NET_AMOUNT",
556 "currencyDefinitionType": "CONTRACT_CURRENCY",
557 "invoiceEntryId": 0,
558 "invoiceEntryDisplayId": "string"
559 }
560 ],
561 "scheduledPaymentMatches": [
562 {
563 "id": 0,
564 "fromId": 0,
565 "toId": 0,
566 "amount": 0
567 }
568 ],
569 "goodsReceiptLineItemLinks": [
570 {
571 "id": 0,
572 "fromId": 0,
573 "toId": 0,
574 "linkedQuantity": 0
575 }
576 ],
577 "invoiceId": 0,
578 "invoiceDisplayId": "string",
579 "invoiceState": "INV_DRAFT",
580 "vendorPaymentId": 0,
581 "purchaseOrderLineItemId": 0,
582 "netAmount": 0,
583 "allowsSystemGenerateNewId": true,
584 "numberRangeIdentifierValue": "string",
585 "numberRangeIdentifierType": {
586 "name": "string"
587 },
588 "numberRangeType": {
589 "name": "string"
590 }
591 }
592 ],
593 "workspaceId": 0,
594 "workspaceDisplayId": "string",
595 "workspaceName": "string",
596 "workspaceState": "INV_DRAFT",
597 "remainingNetAmount": 0,
598 "remainingTaxAmount": 0,
599 "remainingTotalAmount": 0,
600 "pendingPaymentCount": 0,
601 "allPaymentsPosted": true,
602 "approvalInfo": {
603 "approverUsername": "string",
604 "approvedAt": "2019-08-24T14:15:22Z"
605 },
606 "rejectionReason": "string",
607 "allowsSystemGenerateNewId": true,
608 "numberRangeIdentifierValue": "string",
609 "numberRangeIdentifierType": {
610 "name": "string"
611 },
612 "numberRangeType": {
613 "name": "string"
614 }
615 }
616 ],
617 "rejectionReason": "string",
618 "allowsSystemGenerateNewId": true,
619 "numberRangeIdentifierValue": "string",
620 "numberRangeIdentifierType": {
621 "name": "string"
622 },
623 "numberRangeType": {
624 "name": "string"
625 }
626 },
627 "totalScore": 0,
628 "matchDetails": [
629 {
630 "payableMatchingType": "VENDOR",
631 "score": 0
632 }
633 ],
634 "confidenceScore": 0.1
635 }
636 ],
637 "number": 0,
638 "sort": {
639 "unsorted": true,
640 "sorted": true,
641 "empty": true
642 },
643 "first": true,
644 "last": true,
645 "empty": true
646}