Reconciliation Report¶
Get Reconciliation Reports For Scheduled Payments¶
HTTP Request
POST /api/v1/reconciliation-report/scheduled-payment/query
📋 Description: Returns reconciliation details for each clearing ledger entry ID supplied. Each report shows how the scheduled payment relates to its corresponding invoice line items.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the criteria for querying scheduled payments, including parameters such as date range, payment status, and associated metadata. |
Body Parameters
1{
2 "clearingLedgerEntryIds": [
3 0
4 ]
5}
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 "clearingLedgerEntryId": 0,
17 "clearingLedgerTransactionId": 0,
18 "scheduledPaymentId": 0,
19 "scheduledPaymentDisplayId": "string",
20 "currency": {
21 "id": 0,
22 "displayId": "string"
23 },
24 "amount": {
25 "netAmount": 0,
26 "taxAmount": 0,
27 "totalAmount": 0
28 },
29 "matchedAmount": {
30 "netAmount": 0,
31 "taxAmount": 0,
32 "totalAmount": 0
33 },
34 "paidAmount": {
35 "netAmount": 0,
36 "taxAmount": 0,
37 "totalAmount": 0
38 },
39 "remainingAmount": {
40 "netAmount": 0,
41 "taxAmount": 0,
42 "totalAmount": 0
43 },
44 "lineItems": [
45 {
46 "invoiceId": 0,
47 "invoiceDisplayId": "string",
48 "invoiceLineItemId": 0,
49 "invoiceLineItemDisplayId": "string",
50 "expenseCategory": {
51 "id": 0,
52 "displayId": "string"
53 },
54 "lineItemAmount": {
55 "netAmount": 0,
56 "taxAmount": 0,
57 "totalAmount": 0
58 },
59 "matchedAmount": {
60 "netAmount": 0,
61 "taxAmount": 0,
62 "totalAmount": 0
63 }
64 }
65 ],
66 "payments": [
67 {
68 "paymentId": 0,
69 "paymentDisplayId": "string",
70 "invoiceId": 0,
71 "invoiceDisplayId": "string",
72 "paymentStatus": "INV_DRAFT",
73 "postingDate": "2019-08-24",
74 "invoiceLineItemId": 0,
75 "invoiceLineItemDisplayId": "string",
76 "paymentAmount": {
77 "netAmount": 0,
78 "taxAmount": 0,
79 "totalAmount": 0
80 },
81 "matchedAmountConsumed": {
82 "netAmount": 0,
83 "taxAmount": 0,
84 "totalAmount": 0
85 }
86 }
87 ]
88 }
89 ]
90}
Get Reconciliation Reports For All Line Items Of An Invoice¶
HTTP Request
POST /api/v1/reconciliation-report/invoice/{invoiceId}
📋 Description: Convenience endpoint — equivalent to calling the invoice-line-item query with all line item IDs of the given invoice.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
invoiceId |
path |
integer(int64) |
true |
Invoice 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 {
16 "invoiceLineItemId": 0,
17 "invoiceLineItemDisplayId": "string",
18 "invoiceId": 0,
19 "invoiceDisplayId": "string",
20 "expenseCategory": {
21 "id": 0,
22 "displayId": "string"
23 },
24 "currency": {
25 "id": 0,
26 "displayId": "string"
27 },
28 "amount": {
29 "netAmount": 0,
30 "taxAmount": 0,
31 "totalAmount": 0
32 },
33 "matchedAmount": {
34 "netAmount": 0,
35 "taxAmount": 0,
36 "totalAmount": 0
37 },
38 "paidAmount": {
39 "netAmount": 0,
40 "taxAmount": 0,
41 "totalAmount": 0
42 },
43 "expensedAmount": {
44 "netAmount": 0,
45 "taxAmount": 0,
46 "totalAmount": 0
47 },
48 "remainingAmount": {
49 "netAmount": 0,
50 "taxAmount": 0,
51 "totalAmount": 0
52 },
53 "payments": [
54 {
55 "paymentId": 0,
56 "paymentDisplayId": "string",
57 "invoiceId": 0,
58 "invoiceDisplayId": "string",
59 "paymentStatus": "INV_DRAFT",
60 "postingDate": "2019-08-24",
61 "paymentAmount": {
62 "netAmount": 0,
63 "taxAmount": 0,
64 "totalAmount": 0
65 },
66 "paymentMatchedAmount": {
67 "netAmount": 0,
68 "taxAmount": 0,
69 "totalAmount": 0
70 },
71 "expensedAmount": {
72 "netAmount": 0,
73 "taxAmount": 0,
74 "totalAmount": 0
75 }
76 }
77 ],
78 "matchings": [
79 {
80 "scheduledPaymentId": 0,
81 "clearingLedgerEntryId": 0,
82 "clearingLedgerTransactionId": 0,
83 "scheduledPaymentAmount": {
84 "netAmount": 0,
85 "taxAmount": 0,
86 "totalAmount": 0
87 },
88 "matchedAmount": {
89 "netAmount": 0,
90 "taxAmount": 0,
91 "totalAmount": 0
92 },
93 "paidAmount": {
94 "netAmount": 0,
95 "taxAmount": 0,
96 "totalAmount": 0
97 }
98 }
99 ]
100 }
101 ]
102}
Get Reconciliation Reports For Invoice Payments¶
HTTP Request
POST /api/v1/reconciliation-report/invoice-payment/query
📋 Description: Returns reconciliation details for each invoice payment ID supplied.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the invoice payment query parameters, including relevant identifiers and filters to facilitate the reconciliation report process. |
Body Parameters
1{
2 "invoicePaymentIds": [
3 0
4 ]
5}
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 "invoicePaymentId": 0,
17 "invoicePaymentDisplayId": "string",
18 "paymentStatus": "INV_DRAFT",
19 "postingDate": "2019-08-24",
20 "invoiceId": 0,
21 "invoiceDisplayId": "string",
22 "currency": {
23 "id": 0,
24 "displayId": "string"
25 },
26 "totalAmount": {
27 "netAmount": 0,
28 "taxAmount": 0,
29 "totalAmount": 0
30 },
31 "totalMatchedAmount": {
32 "netAmount": 0,
33 "taxAmount": 0,
34 "totalAmount": 0
35 },
36 "totalConsumedMatchedAmount": {
37 "netAmount": 0,
38 "taxAmount": 0,
39 "totalAmount": 0
40 },
41 "lineItems": [
42 {
43 "invoiceLineItemId": 0,
44 "invoiceLineItemDisplayId": "string",
45 "invoiceId": 0,
46 "invoiceDisplayId": "string",
47 "expenseCategory": {
48 "id": 0,
49 "displayId": "string"
50 },
51 "paymentAmount": {
52 "netAmount": 0,
53 "taxAmount": 0,
54 "totalAmount": 0
55 },
56 "lineItemTotalAmount": {
57 "netAmount": 0,
58 "taxAmount": 0,
59 "totalAmount": 0
60 },
61 "totalMatchedAmount": {
62 "netAmount": 0,
63 "taxAmount": 0,
64 "totalAmount": 0
65 },
66 "totalConsumedMatchedAmount": {
67 "netAmount": 0,
68 "taxAmount": 0,
69 "totalAmount": 0
70 },
71 "matchings": [
72 {
73 "scheduledPaymentId": 0,
74 "clearingLedgerEntryId": 0,
75 "clearingLedgerTransactionId": 0,
76 "scheduledPaymentAmount": {
77 "netAmount": 0,
78 "taxAmount": 0,
79 "totalAmount": 0
80 },
81 "matchedAmount": {
82 "netAmount": 0,
83 "taxAmount": 0,
84 "totalAmount": 0
85 },
86 "paidAmount": {
87 "netAmount": 0,
88 "taxAmount": 0,
89 "totalAmount": 0
90 }
91 }
92 ]
93 }
94 ]
95 }
96 ]
97}
Get Reconciliation Reports For Invoice Line Items¶
HTTP Request
POST /api/v1/reconciliation-report/invoice-line-item/query
📋 Description: Returns reconciliation details for each invoice line item ID supplied. Each report shows matched payments and remaining balances.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the invoice line item details necessary for generating a reconciliation report, including relevant identifiers and financial data. |
Body Parameters
1{
2 "invoiceLineItemIds": [
3 0
4 ]
5}
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 "invoiceLineItemId": 0,
17 "invoiceLineItemDisplayId": "string",
18 "invoiceId": 0,
19 "invoiceDisplayId": "string",
20 "expenseCategory": {
21 "id": 0,
22 "displayId": "string"
23 },
24 "currency": {
25 "id": 0,
26 "displayId": "string"
27 },
28 "amount": {
29 "netAmount": 0,
30 "taxAmount": 0,
31 "totalAmount": 0
32 },
33 "matchedAmount": {
34 "netAmount": 0,
35 "taxAmount": 0,
36 "totalAmount": 0
37 },
38 "paidAmount": {
39 "netAmount": 0,
40 "taxAmount": 0,
41 "totalAmount": 0
42 },
43 "expensedAmount": {
44 "netAmount": 0,
45 "taxAmount": 0,
46 "totalAmount": 0
47 },
48 "remainingAmount": {
49 "netAmount": 0,
50 "taxAmount": 0,
51 "totalAmount": 0
52 },
53 "payments": [
54 {
55 "paymentId": 0,
56 "paymentDisplayId": "string",
57 "invoiceId": 0,
58 "invoiceDisplayId": "string",
59 "paymentStatus": "INV_DRAFT",
60 "postingDate": "2019-08-24",
61 "paymentAmount": {
62 "netAmount": 0,
63 "taxAmount": 0,
64 "totalAmount": 0
65 },
66 "paymentMatchedAmount": {
67 "netAmount": 0,
68 "taxAmount": 0,
69 "totalAmount": 0
70 },
71 "expensedAmount": {
72 "netAmount": 0,
73 "taxAmount": 0,
74 "totalAmount": 0
75 }
76 }
77 ],
78 "matchings": [
79 {
80 "scheduledPaymentId": 0,
81 "clearingLedgerEntryId": 0,
82 "clearingLedgerTransactionId": 0,
83 "scheduledPaymentAmount": {
84 "netAmount": 0,
85 "taxAmount": 0,
86 "totalAmount": 0
87 },
88 "matchedAmount": {
89 "netAmount": 0,
90 "taxAmount": 0,
91 "totalAmount": 0
92 },
93 "paidAmount": {
94 "netAmount": 0,
95 "taxAmount": 0,
96 "totalAmount": 0
97 }
98 }
99 ]
100 }
101 ]
102}