Scheduled Payment¶
Get A Resource By ID¶
HTTP Request
GET /api/v1/scheduled-payment/{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 "clearingLedgerTransactionId": 0,
18 "clearingLedgerEntryId": 0,
19 "roundedAmount": 0,
20 "unroundedAmount": 0,
21 "deltaAdjustment": 0,
22 "availableNetAmount": 0,
23 "availableTaxAmount": 0,
24 "fiscalYear": 0,
25 "fiscalPeriod": 0,
26 "currency": {
27 "id": 0,
28 "displayId": "string",
29 "status": "CREATED",
30 "name": "string",
31 "decimalPoints": 0
32 },
33 "company": {
34 "id": 0,
35 "displayId": "string",
36 "status": "CREATED",
37 "erpSystemId": 0,
38 "erpSystemDisplayId": "string",
39 "countryId": 0,
40 "countryDisplayId": "string",
41 "name": "string",
42 "postingPeriodVariantId": 0,
43 "fiscalVariantId": 0
44 },
45 "vendor": {
46 "id": 0,
47 "displayId": "string",
48 "status": "CREATED",
49 "name": "string",
50 "erpSystemDisplayId": "string"
51 },
52 "expenseCategory": {
53 "id": 0,
54 "displayId": "string",
55 "status": "CREATED",
56 "name": "string",
57 "expenseCategoryType": "PAYMENT"
58 },
59 "paymentMethod": {
60 "id": 0,
61 "displayId": "string",
62 "status": "CREATED",
63 "name": "string",
64 "type": "string"
65 },
66 "tag": "string",
67 "contract": {
68 "id": 0,
69 "displayId": "string"
70 },
71 "postingDate": "2019-08-24",
72 "taxes": [
73 {
74 "id": 0,
75 "displayId": "string",
76 "baseAmount": 0,
77 "roundedAmount": 0,
78 "unroundedAmount": 0,
79 "deltaAdjustment": 0,
80 "totalTaxDocumentAmount": 0,
81 "taxExempt": 0,
82 "taxAffected": 0,
83 "taxRate": 0.1,
84 "taxCode": {
85 "id": 0,
86 "displayId": "string"
87 },
88 "taxJurisdiction": {
89 "id": 0,
90 "displayId": "string"
91 },
92 "accountingKey": "string",
93 "conditionKey": "string",
94 "taxAccount": "string",
95 "scheduledPaymentId": 0,
96 "allowsSystemGenerateNewId": true,
97 "numberRangeIdentifierValue": "string",
98 "numberRangeIdentifierType": {
99 "name": "string"
100 },
101 "numberRangeType": {
102 "name": "string"
103 }
104 }
105 ],
106 "allowsSystemGenerateNewId": true,
107 "numberRangeIdentifierValue": "string",
108 "numberRangeIdentifierType": {
109 "name": "string"
110 },
111 "numberRangeType": {
112 "name": "string"
113 }
114 }
115}
Update A Resource¶
HTTP Request
PUT /api/v1/scheduled-payment/{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 scheduled payment details, including the payment amount, due date, and any relevant metadata for processing. |
Body Parameters
1{
2 "id": 0,
3 "displayId": "string",
4 "clearingLedgerTransactionId": 0,
5 "clearingLedgerEntryId": 0,
6 "roundedAmount": 0,
7 "unroundedAmount": 0,
8 "deltaAdjustment": 0,
9 "availableNetAmount": 0,
10 "availableTaxAmount": 0,
11 "fiscalYear": 0,
12 "fiscalPeriod": 0,
13 "currency": {
14 "id": 0,
15 "displayId": "string",
16 "status": "CREATED",
17 "name": "string",
18 "decimalPoints": 0
19 },
20 "company": {
21 "id": 0,
22 "displayId": "string",
23 "status": "CREATED",
24 "erpSystemId": 0,
25 "erpSystemDisplayId": "string",
26 "countryId": 0,
27 "countryDisplayId": "string",
28 "name": "string",
29 "postingPeriodVariantId": 0,
30 "fiscalVariantId": 0
31 },
32 "vendor": {
33 "id": 0,
34 "displayId": "string",
35 "status": "CREATED",
36 "name": "string",
37 "erpSystemDisplayId": "string"
38 },
39 "expenseCategory": {
40 "id": 0,
41 "displayId": "string",
42 "status": "CREATED",
43 "name": "string",
44 "expenseCategoryType": "PAYMENT"
45 },
46 "paymentMethod": {
47 "id": 0,
48 "displayId": "string",
49 "status": "CREATED",
50 "name": "string",
51 "type": "string"
52 },
53 "tag": "string",
54 "contract": {
55 "id": 0,
56 "displayId": "string"
57 },
58 "postingDate": "2019-08-24",
59 "taxes": [
60 {
61 "id": 0,
62 "displayId": "string",
63 "baseAmount": 0,
64 "roundedAmount": 0,
65 "unroundedAmount": 0,
66 "deltaAdjustment": 0,
67 "totalTaxDocumentAmount": 0,
68 "taxExempt": 0,
69 "taxAffected": 0,
70 "taxRate": 0.1,
71 "taxCode": {
72 "id": 0,
73 "displayId": "string"
74 },
75 "taxJurisdiction": {
76 "id": 0,
77 "displayId": "string"
78 },
79 "accountingKey": "string",
80 "conditionKey": "string",
81 "taxAccount": "string",
82 "scheduledPaymentId": 0,
83 "allowsSystemGenerateNewId": true,
84 "numberRangeIdentifierValue": "string",
85 "numberRangeIdentifierType": {
86 "name": "string"
87 },
88 "numberRangeType": {
89 "name": "string"
90 }
91 }
92 ],
93 "allowsSystemGenerateNewId": true,
94 "numberRangeIdentifierValue": "string",
95 "numberRangeIdentifierType": {
96 "name": "string"
97 },
98 "numberRangeType": {
99 "name": "string"
100 }
101}
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 "clearingLedgerTransactionId": 0,
18 "clearingLedgerEntryId": 0,
19 "roundedAmount": 0,
20 "unroundedAmount": 0,
21 "deltaAdjustment": 0,
22 "availableNetAmount": 0,
23 "availableTaxAmount": 0,
24 "fiscalYear": 0,
25 "fiscalPeriod": 0,
26 "currency": {
27 "id": 0,
28 "displayId": "string",
29 "status": "CREATED",
30 "name": "string",
31 "decimalPoints": 0
32 },
33 "company": {
34 "id": 0,
35 "displayId": "string",
36 "status": "CREATED",
37 "erpSystemId": 0,
38 "erpSystemDisplayId": "string",
39 "countryId": 0,
40 "countryDisplayId": "string",
41 "name": "string",
42 "postingPeriodVariantId": 0,
43 "fiscalVariantId": 0
44 },
45 "vendor": {
46 "id": 0,
47 "displayId": "string",
48 "status": "CREATED",
49 "name": "string",
50 "erpSystemDisplayId": "string"
51 },
52 "expenseCategory": {
53 "id": 0,
54 "displayId": "string",
55 "status": "CREATED",
56 "name": "string",
57 "expenseCategoryType": "PAYMENT"
58 },
59 "paymentMethod": {
60 "id": 0,
61 "displayId": "string",
62 "status": "CREATED",
63 "name": "string",
64 "type": "string"
65 },
66 "tag": "string",
67 "contract": {
68 "id": 0,
69 "displayId": "string"
70 },
71 "postingDate": "2019-08-24",
72 "taxes": [
73 {
74 "id": 0,
75 "displayId": "string",
76 "baseAmount": 0,
77 "roundedAmount": 0,
78 "unroundedAmount": 0,
79 "deltaAdjustment": 0,
80 "totalTaxDocumentAmount": 0,
81 "taxExempt": 0,
82 "taxAffected": 0,
83 "taxRate": 0.1,
84 "taxCode": {
85 "id": 0,
86 "displayId": "string"
87 },
88 "taxJurisdiction": {
89 "id": 0,
90 "displayId": "string"
91 },
92 "accountingKey": "string",
93 "conditionKey": "string",
94 "taxAccount": "string",
95 "scheduledPaymentId": 0,
96 "allowsSystemGenerateNewId": true,
97 "numberRangeIdentifierValue": "string",
98 "numberRangeIdentifierType": {
99 "name": "string"
100 },
101 "numberRangeType": {
102 "name": "string"
103 }
104 }
105 ],
106 "allowsSystemGenerateNewId": true,
107 "numberRangeIdentifierValue": "string",
108 "numberRangeIdentifierType": {
109 "name": "string"
110 },
111 "numberRangeType": {
112 "name": "string"
113 }
114 }
115}
Delete A Single Resource¶
HTTP Request
DELETE /api/v1/scheduled-payment/{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/scheduled-payment/{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 scheduled payment details, including payment amount, due date, and any relevant metadata for processing. |
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 "clearingLedgerTransactionId": 0,
18 "clearingLedgerEntryId": 0,
19 "roundedAmount": 0,
20 "unroundedAmount": 0,
21 "deltaAdjustment": 0,
22 "availableNetAmount": 0,
23 "availableTaxAmount": 0,
24 "fiscalYear": 0,
25 "fiscalPeriod": 0,
26 "currency": {
27 "id": 0,
28 "displayId": "string",
29 "status": "CREATED",
30 "name": "string",
31 "decimalPoints": 0
32 },
33 "company": {
34 "id": 0,
35 "displayId": "string",
36 "status": "CREATED",
37 "erpSystemId": 0,
38 "erpSystemDisplayId": "string",
39 "countryId": 0,
40 "countryDisplayId": "string",
41 "name": "string",
42 "postingPeriodVariantId": 0,
43 "fiscalVariantId": 0
44 },
45 "vendor": {
46 "id": 0,
47 "displayId": "string",
48 "status": "CREATED",
49 "name": "string",
50 "erpSystemDisplayId": "string"
51 },
52 "expenseCategory": {
53 "id": 0,
54 "displayId": "string",
55 "status": "CREATED",
56 "name": "string",
57 "expenseCategoryType": "PAYMENT"
58 },
59 "paymentMethod": {
60 "id": 0,
61 "displayId": "string",
62 "status": "CREATED",
63 "name": "string",
64 "type": "string"
65 },
66 "tag": "string",
67 "contract": {
68 "id": 0,
69 "displayId": "string"
70 },
71 "postingDate": "2019-08-24",
72 "taxes": [
73 {
74 "id": 0,
75 "displayId": "string",
76 "baseAmount": 0,
77 "roundedAmount": 0,
78 "unroundedAmount": 0,
79 "deltaAdjustment": 0,
80 "totalTaxDocumentAmount": 0,
81 "taxExempt": 0,
82 "taxAffected": 0,
83 "taxRate": 0.1,
84 "taxCode": {
85 "id": 0,
86 "displayId": "string"
87 },
88 "taxJurisdiction": {
89 "id": 0,
90 "displayId": "string"
91 },
92 "accountingKey": "string",
93 "conditionKey": "string",
94 "taxAccount": "string",
95 "scheduledPaymentId": 0,
96 "allowsSystemGenerateNewId": true,
97 "numberRangeIdentifierValue": "string",
98 "numberRangeIdentifierType": {
99 "name": "string"
100 },
101 "numberRangeType": {
102 "name": "string"
103 }
104 }
105 ],
106 "allowsSystemGenerateNewId": true,
107 "numberRangeIdentifierValue": "string",
108 "numberRangeIdentifierType": {
109 "name": "string"
110 },
111 "numberRangeType": {
112 "name": "string"
113 }
114 }
115}
Create Or Update A Resource¶
HTTP Request
PUT /api/v1/scheduled-payment/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 scheduled payment details, including payment amount, frequency, and associated account information for creation or update purposes. |
Body Parameters
1{
2 "id": 0,
3 "displayId": "string",
4 "clearingLedgerTransactionId": 0,
5 "clearingLedgerEntryId": 0,
6 "roundedAmount": 0,
7 "unroundedAmount": 0,
8 "deltaAdjustment": 0,
9 "availableNetAmount": 0,
10 "availableTaxAmount": 0,
11 "fiscalYear": 0,
12 "fiscalPeriod": 0,
13 "currency": {
14 "id": 0,
15 "displayId": "string",
16 "status": "CREATED",
17 "name": "string",
18 "decimalPoints": 0
19 },
20 "company": {
21 "id": 0,
22 "displayId": "string",
23 "status": "CREATED",
24 "erpSystemId": 0,
25 "erpSystemDisplayId": "string",
26 "countryId": 0,
27 "countryDisplayId": "string",
28 "name": "string",
29 "postingPeriodVariantId": 0,
30 "fiscalVariantId": 0
31 },
32 "vendor": {
33 "id": 0,
34 "displayId": "string",
35 "status": "CREATED",
36 "name": "string",
37 "erpSystemDisplayId": "string"
38 },
39 "expenseCategory": {
40 "id": 0,
41 "displayId": "string",
42 "status": "CREATED",
43 "name": "string",
44 "expenseCategoryType": "PAYMENT"
45 },
46 "paymentMethod": {
47 "id": 0,
48 "displayId": "string",
49 "status": "CREATED",
50 "name": "string",
51 "type": "string"
52 },
53 "tag": "string",
54 "contract": {
55 "id": 0,
56 "displayId": "string"
57 },
58 "postingDate": "2019-08-24",
59 "taxes": [
60 {
61 "id": 0,
62 "displayId": "string",
63 "baseAmount": 0,
64 "roundedAmount": 0,
65 "unroundedAmount": 0,
66 "deltaAdjustment": 0,
67 "totalTaxDocumentAmount": 0,
68 "taxExempt": 0,
69 "taxAffected": 0,
70 "taxRate": 0.1,
71 "taxCode": {
72 "id": 0,
73 "displayId": "string"
74 },
75 "taxJurisdiction": {
76 "id": 0,
77 "displayId": "string"
78 },
79 "accountingKey": "string",
80 "conditionKey": "string",
81 "taxAccount": "string",
82 "scheduledPaymentId": 0,
83 "allowsSystemGenerateNewId": true,
84 "numberRangeIdentifierValue": "string",
85 "numberRangeIdentifierType": {
86 "name": "string"
87 },
88 "numberRangeType": {
89 "name": "string"
90 }
91 }
92 ],
93 "allowsSystemGenerateNewId": true,
94 "numberRangeIdentifierValue": "string",
95 "numberRangeIdentifierType": {
96 "name": "string"
97 },
98 "numberRangeType": {
99 "name": "string"
100 }
101}
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 "clearingLedgerTransactionId": 0,
18 "clearingLedgerEntryId": 0,
19 "roundedAmount": 0,
20 "unroundedAmount": 0,
21 "deltaAdjustment": 0,
22 "availableNetAmount": 0,
23 "availableTaxAmount": 0,
24 "fiscalYear": 0,
25 "fiscalPeriod": 0,
26 "currency": {
27 "id": 0,
28 "displayId": "string",
29 "status": "CREATED",
30 "name": "string",
31 "decimalPoints": 0
32 },
33 "company": {
34 "id": 0,
35 "displayId": "string",
36 "status": "CREATED",
37 "erpSystemId": 0,
38 "erpSystemDisplayId": "string",
39 "countryId": 0,
40 "countryDisplayId": "string",
41 "name": "string",
42 "postingPeriodVariantId": 0,
43 "fiscalVariantId": 0
44 },
45 "vendor": {
46 "id": 0,
47 "displayId": "string",
48 "status": "CREATED",
49 "name": "string",
50 "erpSystemDisplayId": "string"
51 },
52 "expenseCategory": {
53 "id": 0,
54 "displayId": "string",
55 "status": "CREATED",
56 "name": "string",
57 "expenseCategoryType": "PAYMENT"
58 },
59 "paymentMethod": {
60 "id": 0,
61 "displayId": "string",
62 "status": "CREATED",
63 "name": "string",
64 "type": "string"
65 },
66 "tag": "string",
67 "contract": {
68 "id": 0,
69 "displayId": "string"
70 },
71 "postingDate": "2019-08-24",
72 "taxes": [
73 {
74 "id": 0,
75 "displayId": "string",
76 "baseAmount": 0,
77 "roundedAmount": 0,
78 "unroundedAmount": 0,
79 "deltaAdjustment": 0,
80 "totalTaxDocumentAmount": 0,
81 "taxExempt": 0,
82 "taxAffected": 0,
83 "taxRate": 0.1,
84 "taxCode": {
85 "id": 0,
86 "displayId": "string"
87 },
88 "taxJurisdiction": {
89 "id": 0,
90 "displayId": "string"
91 },
92 "accountingKey": "string",
93 "conditionKey": "string",
94 "taxAccount": "string",
95 "scheduledPaymentId": 0,
96 "allowsSystemGenerateNewId": true,
97 "numberRangeIdentifierValue": "string",
98 "numberRangeIdentifierType": {
99 "name": "string"
100 },
101 "numberRangeType": {
102 "name": "string"
103 }
104 }
105 ],
106 "allowsSystemGenerateNewId": true,
107 "numberRangeIdentifierValue": "string",
108 "numberRangeIdentifierType": {
109 "name": "string"
110 },
111 "numberRangeType": {
112 "name": "string"
113 }
114 }
115}
Bulk Create-Or-Update Resources¶
HTTP Request
PUT /api/v1/scheduled-payment/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 scheduled payment records for bulk creation or update, including payment details and associated metadata. |
Body Parameters
1[
2 {
3 "id": 0,
4 "displayId": "string",
5 "clearingLedgerTransactionId": 0,
6 "clearingLedgerEntryId": 0,
7 "roundedAmount": 0,
8 "unroundedAmount": 0,
9 "deltaAdjustment": 0,
10 "availableNetAmount": 0,
11 "availableTaxAmount": 0,
12 "fiscalYear": 0,
13 "fiscalPeriod": 0,
14 "currency": {
15 "id": 0,
16 "displayId": "string",
17 "status": "CREATED",
18 "name": "string",
19 "decimalPoints": 0
20 },
21 "company": {
22 "id": 0,
23 "displayId": "string",
24 "status": "CREATED",
25 "erpSystemId": 0,
26 "erpSystemDisplayId": "string",
27 "countryId": 0,
28 "countryDisplayId": "string",
29 "name": "string",
30 "postingPeriodVariantId": 0,
31 "fiscalVariantId": 0
32 },
33 "vendor": {
34 "id": 0,
35 "displayId": "string",
36 "status": "CREATED",
37 "name": "string",
38 "erpSystemDisplayId": "string"
39 },
40 "expenseCategory": {
41 "id": 0,
42 "displayId": "string",
43 "status": "CREATED",
44 "name": "string",
45 "expenseCategoryType": "PAYMENT"
46 },
47 "paymentMethod": {
48 "id": 0,
49 "displayId": "string",
50 "status": "CREATED",
51 "name": "string",
52 "type": "string"
53 },
54 "tag": "string",
55 "contract": {
56 "id": 0,
57 "displayId": "string"
58 },
59 "postingDate": "2019-08-24",
60 "taxes": [
61 {
62 "id": 0,
63 "displayId": "string",
64 "baseAmount": 0,
65 "roundedAmount": 0,
66 "unroundedAmount": 0,
67 "deltaAdjustment": 0,
68 "totalTaxDocumentAmount": 0,
69 "taxExempt": 0,
70 "taxAffected": 0,
71 "taxRate": 0.1,
72 "taxCode": {
73 "id": 0,
74 "displayId": "string"
75 },
76 "taxJurisdiction": {
77 "id": 0,
78 "displayId": "string"
79 },
80 "accountingKey": "string",
81 "conditionKey": "string",
82 "taxAccount": "string",
83 "scheduledPaymentId": 0,
84 "allowsSystemGenerateNewId": true,
85 "numberRangeIdentifierValue": "string",
86 "numberRangeIdentifierType": {
87 "name": "string"
88 },
89 "numberRangeType": {
90 "name": "string"
91 }
92 }
93 ],
94 "allowsSystemGenerateNewId": true,
95 "numberRangeIdentifierValue": "string",
96 "numberRangeIdentifierType": {
97 "name": "string"
98 },
99 "numberRangeType": {
100 "name": "string"
101 }
102 }
103]
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 "clearingLedgerTransactionId": 0,
19 "clearingLedgerEntryId": 0,
20 "roundedAmount": 0,
21 "unroundedAmount": 0,
22 "deltaAdjustment": 0,
23 "availableNetAmount": 0,
24 "availableTaxAmount": 0,
25 "fiscalYear": 0,
26 "fiscalPeriod": 0,
27 "currency": {
28 "id": 0,
29 "displayId": "string",
30 "status": "CREATED",
31 "name": "string",
32 "decimalPoints": 0
33 },
34 "company": {
35 "id": 0,
36 "displayId": "string",
37 "status": "CREATED",
38 "erpSystemId": 0,
39 "erpSystemDisplayId": "string",
40 "countryId": 0,
41 "countryDisplayId": "string",
42 "name": "string",
43 "postingPeriodVariantId": 0,
44 "fiscalVariantId": 0
45 },
46 "vendor": {
47 "id": 0,
48 "displayId": "string",
49 "status": "CREATED",
50 "name": "string",
51 "erpSystemDisplayId": "string"
52 },
53 "expenseCategory": {
54 "id": 0,
55 "displayId": "string",
56 "status": "CREATED",
57 "name": "string",
58 "expenseCategoryType": "PAYMENT"
59 },
60 "paymentMethod": {
61 "id": 0,
62 "displayId": "string",
63 "status": "CREATED",
64 "name": "string",
65 "type": "string"
66 },
67 "tag": "string",
68 "contract": {
69 "id": 0,
70 "displayId": "string"
71 },
72 "postingDate": "2019-08-24",
73 "taxes": [
74 {
75 "id": 0,
76 "displayId": "string",
77 "baseAmount": 0,
78 "roundedAmount": 0,
79 "unroundedAmount": 0,
80 "deltaAdjustment": 0,
81 "totalTaxDocumentAmount": 0,
82 "taxExempt": 0,
83 "taxAffected": 0,
84 "taxRate": 0.1,
85 "taxCode": {
86 "id": 0,
87 "displayId": "string"
88 },
89 "taxJurisdiction": {
90 "id": 0,
91 "displayId": "string"
92 },
93 "accountingKey": "string",
94 "conditionKey": "string",
95 "taxAccount": "string",
96 "scheduledPaymentId": 0,
97 "allowsSystemGenerateNewId": true,
98 "numberRangeIdentifierValue": "string",
99 "numberRangeIdentifierType": {
100 "name": "string"
101 },
102 "numberRangeType": {
103 "name": "string"
104 }
105 }
106 ],
107 "allowsSystemGenerateNewId": true,
108 "numberRangeIdentifierValue": "string",
109 "numberRangeIdentifierType": {
110 "name": "string"
111 },
112 "numberRangeType": {
113 "name": "string"
114 }
115 }
116 ]
117}
Bulk-Update Resources¶
HTTP Request
PUT /api/v1/scheduled-payment/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 scheduled payment details, including payment amounts, dates, and recipient information for bulk processing. |
Body Parameters
1[
2 {
3 "id": 0,
4 "displayId": "string",
5 "clearingLedgerTransactionId": 0,
6 "clearingLedgerEntryId": 0,
7 "roundedAmount": 0,
8 "unroundedAmount": 0,
9 "deltaAdjustment": 0,
10 "availableNetAmount": 0,
11 "availableTaxAmount": 0,
12 "fiscalYear": 0,
13 "fiscalPeriod": 0,
14 "currency": {
15 "id": 0,
16 "displayId": "string",
17 "status": "CREATED",
18 "name": "string",
19 "decimalPoints": 0
20 },
21 "company": {
22 "id": 0,
23 "displayId": "string",
24 "status": "CREATED",
25 "erpSystemId": 0,
26 "erpSystemDisplayId": "string",
27 "countryId": 0,
28 "countryDisplayId": "string",
29 "name": "string",
30 "postingPeriodVariantId": 0,
31 "fiscalVariantId": 0
32 },
33 "vendor": {
34 "id": 0,
35 "displayId": "string",
36 "status": "CREATED",
37 "name": "string",
38 "erpSystemDisplayId": "string"
39 },
40 "expenseCategory": {
41 "id": 0,
42 "displayId": "string",
43 "status": "CREATED",
44 "name": "string",
45 "expenseCategoryType": "PAYMENT"
46 },
47 "paymentMethod": {
48 "id": 0,
49 "displayId": "string",
50 "status": "CREATED",
51 "name": "string",
52 "type": "string"
53 },
54 "tag": "string",
55 "contract": {
56 "id": 0,
57 "displayId": "string"
58 },
59 "postingDate": "2019-08-24",
60 "taxes": [
61 {
62 "id": 0,
63 "displayId": "string",
64 "baseAmount": 0,
65 "roundedAmount": 0,
66 "unroundedAmount": 0,
67 "deltaAdjustment": 0,
68 "totalTaxDocumentAmount": 0,
69 "taxExempt": 0,
70 "taxAffected": 0,
71 "taxRate": 0.1,
72 "taxCode": {
73 "id": 0,
74 "displayId": "string"
75 },
76 "taxJurisdiction": {
77 "id": 0,
78 "displayId": "string"
79 },
80 "accountingKey": "string",
81 "conditionKey": "string",
82 "taxAccount": "string",
83 "scheduledPaymentId": 0,
84 "allowsSystemGenerateNewId": true,
85 "numberRangeIdentifierValue": "string",
86 "numberRangeIdentifierType": {
87 "name": "string"
88 },
89 "numberRangeType": {
90 "name": "string"
91 }
92 }
93 ],
94 "allowsSystemGenerateNewId": true,
95 "numberRangeIdentifierValue": "string",
96 "numberRangeIdentifierType": {
97 "name": "string"
98 },
99 "numberRangeType": {
100 "name": "string"
101 }
102 }
103]
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 "clearingLedgerTransactionId": 0,
19 "clearingLedgerEntryId": 0,
20 "roundedAmount": 0,
21 "unroundedAmount": 0,
22 "deltaAdjustment": 0,
23 "availableNetAmount": 0,
24 "availableTaxAmount": 0,
25 "fiscalYear": 0,
26 "fiscalPeriod": 0,
27 "currency": {
28 "id": 0,
29 "displayId": "string",
30 "status": "CREATED",
31 "name": "string",
32 "decimalPoints": 0
33 },
34 "company": {
35 "id": 0,
36 "displayId": "string",
37 "status": "CREATED",
38 "erpSystemId": 0,
39 "erpSystemDisplayId": "string",
40 "countryId": 0,
41 "countryDisplayId": "string",
42 "name": "string",
43 "postingPeriodVariantId": 0,
44 "fiscalVariantId": 0
45 },
46 "vendor": {
47 "id": 0,
48 "displayId": "string",
49 "status": "CREATED",
50 "name": "string",
51 "erpSystemDisplayId": "string"
52 },
53 "expenseCategory": {
54 "id": 0,
55 "displayId": "string",
56 "status": "CREATED",
57 "name": "string",
58 "expenseCategoryType": "PAYMENT"
59 },
60 "paymentMethod": {
61 "id": 0,
62 "displayId": "string",
63 "status": "CREATED",
64 "name": "string",
65 "type": "string"
66 },
67 "tag": "string",
68 "contract": {
69 "id": 0,
70 "displayId": "string"
71 },
72 "postingDate": "2019-08-24",
73 "taxes": [
74 {
75 "id": 0,
76 "displayId": "string",
77 "baseAmount": 0,
78 "roundedAmount": 0,
79 "unroundedAmount": 0,
80 "deltaAdjustment": 0,
81 "totalTaxDocumentAmount": 0,
82 "taxExempt": 0,
83 "taxAffected": 0,
84 "taxRate": 0.1,
85 "taxCode": {
86 "id": 0,
87 "displayId": "string"
88 },
89 "taxJurisdiction": {
90 "id": 0,
91 "displayId": "string"
92 },
93 "accountingKey": "string",
94 "conditionKey": "string",
95 "taxAccount": "string",
96 "scheduledPaymentId": 0,
97 "allowsSystemGenerateNewId": true,
98 "numberRangeIdentifierValue": "string",
99 "numberRangeIdentifierType": {
100 "name": "string"
101 },
102 "numberRangeType": {
103 "name": "string"
104 }
105 }
106 ],
107 "allowsSystemGenerateNewId": true,
108 "numberRangeIdentifierValue": "string",
109 "numberRangeIdentifierType": {
110 "name": "string"
111 },
112 "numberRangeType": {
113 "name": "string"
114 }
115 }
116 ]
117}
Bulk-Create Resources¶
HTTP Request
POST /api/v1/scheduled-payment/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 scheduled payment details, including payment amounts, recipient information, and scheduled dates for bulk processing. |
Body Parameters
1[
2 {
3 "id": 0,
4 "displayId": "string",
5 "clearingLedgerTransactionId": 0,
6 "clearingLedgerEntryId": 0,
7 "roundedAmount": 0,
8 "unroundedAmount": 0,
9 "deltaAdjustment": 0,
10 "availableNetAmount": 0,
11 "availableTaxAmount": 0,
12 "fiscalYear": 0,
13 "fiscalPeriod": 0,
14 "currency": {
15 "id": 0,
16 "displayId": "string",
17 "status": "CREATED",
18 "name": "string",
19 "decimalPoints": 0
20 },
21 "company": {
22 "id": 0,
23 "displayId": "string",
24 "status": "CREATED",
25 "erpSystemId": 0,
26 "erpSystemDisplayId": "string",
27 "countryId": 0,
28 "countryDisplayId": "string",
29 "name": "string",
30 "postingPeriodVariantId": 0,
31 "fiscalVariantId": 0
32 },
33 "vendor": {
34 "id": 0,
35 "displayId": "string",
36 "status": "CREATED",
37 "name": "string",
38 "erpSystemDisplayId": "string"
39 },
40 "expenseCategory": {
41 "id": 0,
42 "displayId": "string",
43 "status": "CREATED",
44 "name": "string",
45 "expenseCategoryType": "PAYMENT"
46 },
47 "paymentMethod": {
48 "id": 0,
49 "displayId": "string",
50 "status": "CREATED",
51 "name": "string",
52 "type": "string"
53 },
54 "tag": "string",
55 "contract": {
56 "id": 0,
57 "displayId": "string"
58 },
59 "postingDate": "2019-08-24",
60 "taxes": [
61 {
62 "id": 0,
63 "displayId": "string",
64 "baseAmount": 0,
65 "roundedAmount": 0,
66 "unroundedAmount": 0,
67 "deltaAdjustment": 0,
68 "totalTaxDocumentAmount": 0,
69 "taxExempt": 0,
70 "taxAffected": 0,
71 "taxRate": 0.1,
72 "taxCode": {
73 "id": 0,
74 "displayId": "string"
75 },
76 "taxJurisdiction": {
77 "id": 0,
78 "displayId": "string"
79 },
80 "accountingKey": "string",
81 "conditionKey": "string",
82 "taxAccount": "string",
83 "scheduledPaymentId": 0,
84 "allowsSystemGenerateNewId": true,
85 "numberRangeIdentifierValue": "string",
86 "numberRangeIdentifierType": {
87 "name": "string"
88 },
89 "numberRangeType": {
90 "name": "string"
91 }
92 }
93 ],
94 "allowsSystemGenerateNewId": true,
95 "numberRangeIdentifierValue": "string",
96 "numberRangeIdentifierType": {
97 "name": "string"
98 },
99 "numberRangeType": {
100 "name": "string"
101 }
102 }
103]
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 "clearingLedgerTransactionId": 0,
19 "clearingLedgerEntryId": 0,
20 "roundedAmount": 0,
21 "unroundedAmount": 0,
22 "deltaAdjustment": 0,
23 "availableNetAmount": 0,
24 "availableTaxAmount": 0,
25 "fiscalYear": 0,
26 "fiscalPeriod": 0,
27 "currency": {
28 "id": 0,
29 "displayId": "string",
30 "status": "CREATED",
31 "name": "string",
32 "decimalPoints": 0
33 },
34 "company": {
35 "id": 0,
36 "displayId": "string",
37 "status": "CREATED",
38 "erpSystemId": 0,
39 "erpSystemDisplayId": "string",
40 "countryId": 0,
41 "countryDisplayId": "string",
42 "name": "string",
43 "postingPeriodVariantId": 0,
44 "fiscalVariantId": 0
45 },
46 "vendor": {
47 "id": 0,
48 "displayId": "string",
49 "status": "CREATED",
50 "name": "string",
51 "erpSystemDisplayId": "string"
52 },
53 "expenseCategory": {
54 "id": 0,
55 "displayId": "string",
56 "status": "CREATED",
57 "name": "string",
58 "expenseCategoryType": "PAYMENT"
59 },
60 "paymentMethod": {
61 "id": 0,
62 "displayId": "string",
63 "status": "CREATED",
64 "name": "string",
65 "type": "string"
66 },
67 "tag": "string",
68 "contract": {
69 "id": 0,
70 "displayId": "string"
71 },
72 "postingDate": "2019-08-24",
73 "taxes": [
74 {
75 "id": 0,
76 "displayId": "string",
77 "baseAmount": 0,
78 "roundedAmount": 0,
79 "unroundedAmount": 0,
80 "deltaAdjustment": 0,
81 "totalTaxDocumentAmount": 0,
82 "taxExempt": 0,
83 "taxAffected": 0,
84 "taxRate": 0.1,
85 "taxCode": {
86 "id": 0,
87 "displayId": "string"
88 },
89 "taxJurisdiction": {
90 "id": 0,
91 "displayId": "string"
92 },
93 "accountingKey": "string",
94 "conditionKey": "string",
95 "taxAccount": "string",
96 "scheduledPaymentId": 0,
97 "allowsSystemGenerateNewId": true,
98 "numberRangeIdentifierValue": "string",
99 "numberRangeIdentifierType": {
100 "name": "string"
101 },
102 "numberRangeType": {
103 "name": "string"
104 }
105 }
106 ],
107 "allowsSystemGenerateNewId": true,
108 "numberRangeIdentifierValue": "string",
109 "numberRangeIdentifierType": {
110 "name": "string"
111 },
112 "numberRangeType": {
113 "name": "string"
114 }
115 }
116 ]
117}
Bulk-Delete Resources¶
HTTP Request
DELETE /api/v1/scheduled-payment/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 scheduled payment identifiers to be deleted in bulk. |
Body Parameters
1[
2 0
3]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
||
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "errorMessage": "string",
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {}
15}
List All Resources¶
HTTP Request
GET /api/v1/scheduled-payment
📋 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 scheduled payment retrieval should be paginated, allowing for efficient data management and retrieval. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
||
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
Example Responses
1{
2 "totalPages": 0,
3 "totalElements": 0,
4 "pageable": {
5 "pageNumber": 0,
6 "unpaged": true,
7 "paged": true,
8 "pageSize": 0,
9 "offset": 0,
10 "sort": {
11 "unsorted": true,
12 "sorted": true,
13 "empty": true
14 }
15 },
16 "numberOfElements": 0,
17 "size": 0,
18 "content": [
19 {
20 "id": 0,
21 "displayId": "string",
22 "clearingLedgerTransactionId": 0,
23 "clearingLedgerEntryId": 0,
24 "roundedAmount": 0,
25 "unroundedAmount": 0,
26 "deltaAdjustment": 0,
27 "availableNetAmount": 0,
28 "availableTaxAmount": 0,
29 "fiscalYear": 0,
30 "fiscalPeriod": 0,
31 "currency": {
32 "id": 0,
33 "displayId": "string",
34 "status": "CREATED",
35 "name": "string",
36 "decimalPoints": 0
37 },
38 "company": {
39 "id": 0,
40 "displayId": "string",
41 "status": "CREATED",
42 "erpSystemId": 0,
43 "erpSystemDisplayId": "string",
44 "countryId": 0,
45 "countryDisplayId": "string",
46 "name": "string",
47 "postingPeriodVariantId": 0,
48 "fiscalVariantId": 0
49 },
50 "vendor": {
51 "id": 0,
52 "displayId": "string",
53 "status": "CREATED",
54 "name": "string",
55 "erpSystemDisplayId": "string"
56 },
57 "expenseCategory": {
58 "id": 0,
59 "displayId": "string",
60 "status": "CREATED",
61 "name": "string",
62 "expenseCategoryType": "PAYMENT"
63 },
64 "paymentMethod": {
65 "id": 0,
66 "displayId": "string",
67 "status": "CREATED",
68 "name": "string",
69 "type": "string"
70 },
71 "tag": "string",
72 "contract": {
73 "id": 0,
74 "displayId": "string"
75 },
76 "postingDate": "2019-08-24",
77 "taxes": [
78 {
79 "id": 0,
80 "displayId": "string",
81 "baseAmount": 0,
82 "roundedAmount": 0,
83 "unroundedAmount": 0,
84 "deltaAdjustment": 0,
85 "totalTaxDocumentAmount": 0,
86 "taxExempt": 0,
87 "taxAffected": 0,
88 "taxRate": 0.1,
89 "taxCode": {
90 "id": 0,
91 "displayId": "string"
92 },
93 "taxJurisdiction": {
94 "id": 0,
95 "displayId": "string"
96 },
97 "accountingKey": "string",
98 "conditionKey": "string",
99 "taxAccount": "string",
100 "scheduledPaymentId": 0,
101 "allowsSystemGenerateNewId": true,
102 "numberRangeIdentifierValue": "string",
103 "numberRangeIdentifierType": {
104 "name": "string"
105 },
106 "numberRangeType": {
107 "name": "string"
108 }
109 }
110 ],
111 "allowsSystemGenerateNewId": true,
112 "numberRangeIdentifierValue": "string",
113 "numberRangeIdentifierType": {
114 "name": "string"
115 },
116 "numberRangeType": {
117 "name": "string"
118 }
119 }
120 ],
121 "number": 0,
122 "sort": {
123 "unsorted": true,
124 "sorted": true,
125 "empty": true
126 },
127 "first": true,
128 "last": true,
129 "empty": true
130}
Create A Resource¶
HTTP Request
POST /api/v1/scheduled-payment
📋 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 scheduled payment, including amount, frequency, and payment method, to facilitate automated financial transactions. |
Body Parameters
1{
2 "id": 0,
3 "displayId": "string",
4 "clearingLedgerTransactionId": 0,
5 "clearingLedgerEntryId": 0,
6 "roundedAmount": 0,
7 "unroundedAmount": 0,
8 "deltaAdjustment": 0,
9 "availableNetAmount": 0,
10 "availableTaxAmount": 0,
11 "fiscalYear": 0,
12 "fiscalPeriod": 0,
13 "currency": {
14 "id": 0,
15 "displayId": "string",
16 "status": "CREATED",
17 "name": "string",
18 "decimalPoints": 0
19 },
20 "company": {
21 "id": 0,
22 "displayId": "string",
23 "status": "CREATED",
24 "erpSystemId": 0,
25 "erpSystemDisplayId": "string",
26 "countryId": 0,
27 "countryDisplayId": "string",
28 "name": "string",
29 "postingPeriodVariantId": 0,
30 "fiscalVariantId": 0
31 },
32 "vendor": {
33 "id": 0,
34 "displayId": "string",
35 "status": "CREATED",
36 "name": "string",
37 "erpSystemDisplayId": "string"
38 },
39 "expenseCategory": {
40 "id": 0,
41 "displayId": "string",
42 "status": "CREATED",
43 "name": "string",
44 "expenseCategoryType": "PAYMENT"
45 },
46 "paymentMethod": {
47 "id": 0,
48 "displayId": "string",
49 "status": "CREATED",
50 "name": "string",
51 "type": "string"
52 },
53 "tag": "string",
54 "contract": {
55 "id": 0,
56 "displayId": "string"
57 },
58 "postingDate": "2019-08-24",
59 "taxes": [
60 {
61 "id": 0,
62 "displayId": "string",
63 "baseAmount": 0,
64 "roundedAmount": 0,
65 "unroundedAmount": 0,
66 "deltaAdjustment": 0,
67 "totalTaxDocumentAmount": 0,
68 "taxExempt": 0,
69 "taxAffected": 0,
70 "taxRate": 0.1,
71 "taxCode": {
72 "id": 0,
73 "displayId": "string"
74 },
75 "taxJurisdiction": {
76 "id": 0,
77 "displayId": "string"
78 },
79 "accountingKey": "string",
80 "conditionKey": "string",
81 "taxAccount": "string",
82 "scheduledPaymentId": 0,
83 "allowsSystemGenerateNewId": true,
84 "numberRangeIdentifierValue": "string",
85 "numberRangeIdentifierType": {
86 "name": "string"
87 },
88 "numberRangeType": {
89 "name": "string"
90 }
91 }
92 ],
93 "allowsSystemGenerateNewId": true,
94 "numberRangeIdentifierValue": "string",
95 "numberRangeIdentifierType": {
96 "name": "string"
97 },
98 "numberRangeType": {
99 "name": "string"
100 }
101}
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 "clearingLedgerTransactionId": 0,
18 "clearingLedgerEntryId": 0,
19 "roundedAmount": 0,
20 "unroundedAmount": 0,
21 "deltaAdjustment": 0,
22 "availableNetAmount": 0,
23 "availableTaxAmount": 0,
24 "fiscalYear": 0,
25 "fiscalPeriod": 0,
26 "currency": {
27 "id": 0,
28 "displayId": "string",
29 "status": "CREATED",
30 "name": "string",
31 "decimalPoints": 0
32 },
33 "company": {
34 "id": 0,
35 "displayId": "string",
36 "status": "CREATED",
37 "erpSystemId": 0,
38 "erpSystemDisplayId": "string",
39 "countryId": 0,
40 "countryDisplayId": "string",
41 "name": "string",
42 "postingPeriodVariantId": 0,
43 "fiscalVariantId": 0
44 },
45 "vendor": {
46 "id": 0,
47 "displayId": "string",
48 "status": "CREATED",
49 "name": "string",
50 "erpSystemDisplayId": "string"
51 },
52 "expenseCategory": {
53 "id": 0,
54 "displayId": "string",
55 "status": "CREATED",
56 "name": "string",
57 "expenseCategoryType": "PAYMENT"
58 },
59 "paymentMethod": {
60 "id": 0,
61 "displayId": "string",
62 "status": "CREATED",
63 "name": "string",
64 "type": "string"
65 },
66 "tag": "string",
67 "contract": {
68 "id": 0,
69 "displayId": "string"
70 },
71 "postingDate": "2019-08-24",
72 "taxes": [
73 {
74 "id": 0,
75 "displayId": "string",
76 "baseAmount": 0,
77 "roundedAmount": 0,
78 "unroundedAmount": 0,
79 "deltaAdjustment": 0,
80 "totalTaxDocumentAmount": 0,
81 "taxExempt": 0,
82 "taxAffected": 0,
83 "taxRate": 0.1,
84 "taxCode": {
85 "id": 0,
86 "displayId": "string"
87 },
88 "taxJurisdiction": {
89 "id": 0,
90 "displayId": "string"
91 },
92 "accountingKey": "string",
93 "conditionKey": "string",
94 "taxAccount": "string",
95 "scheduledPaymentId": 0,
96 "allowsSystemGenerateNewId": true,
97 "numberRangeIdentifierValue": "string",
98 "numberRangeIdentifierType": {
99 "name": "string"
100 },
101 "numberRangeType": {
102 "name": "string"
103 }
104 }
105 ],
106 "allowsSystemGenerateNewId": true,
107 "numberRangeIdentifierValue": "string",
108 "numberRangeIdentifierType": {
109 "name": "string"
110 },
111 "numberRangeType": {
112 "name": "string"
113 }
114 }
115}
Search Resources¶
HTTP Request
POST /api/v1/scheduled-payment/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 the search criteria for scheduled payments, including filters such as date range, payment status, and account identifiers. |
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 "clearingLedgerTransactionIdEqual": 0,
20 "clearingLedgerTransactionIdIn": [
21 0
22 ],
23 "clearingLedgerEntryIdEqual": 0,
24 "clearingLedgerEntryIdIn": [
25 0
26 ],
27 "roundedAmountEqual": 0,
28 "roundedAmountGreaterThanOrEqual": 0,
29 "roundedAmountLessThanOrEqual": 0,
30 "unroundedAmountEqual": 0,
31 "unroundedAmountGreaterThanOrEqual": 0,
32 "unroundedAmountLessThanOrEqual": 0,
33 "deltaAdjustmentEqual": 0,
34 "deltaAdjustmentGreaterThanOrEqual": 0,
35 "deltaAdjustmentLessThanOrEqual": 0,
36 "availableNetAmountEqual": 0,
37 "availableNetAmountGreaterThanOrEqual": 0,
38 "availableNetAmountLessThanOrEqual": 0,
39 "availableTaxAmountEqual": 0,
40 "availableTaxAmountGreaterThanOrEqual": 0,
41 "availableTaxAmountLessThanOrEqual": 0,
42 "fiscalYearEqual": 0,
43 "fiscalPeriodEqual": 0,
44 "postingDateEqual": "2019-08-24"
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 "id": 0,
21 "displayId": "string",
22 "clearingLedgerTransactionId": 0,
23 "clearingLedgerEntryId": 0,
24 "roundedAmount": 0,
25 "unroundedAmount": 0,
26 "deltaAdjustment": 0,
27 "availableNetAmount": 0,
28 "availableTaxAmount": 0,
29 "fiscalYear": 0,
30 "fiscalPeriod": 0,
31 "currency": {
32 "id": 0,
33 "displayId": "string",
34 "status": "CREATED",
35 "name": "string",
36 "decimalPoints": 0
37 },
38 "company": {
39 "id": 0,
40 "displayId": "string",
41 "status": "CREATED",
42 "erpSystemId": 0,
43 "erpSystemDisplayId": "string",
44 "countryId": 0,
45 "countryDisplayId": "string",
46 "name": "string",
47 "postingPeriodVariantId": 0,
48 "fiscalVariantId": 0
49 },
50 "vendor": {
51 "id": 0,
52 "displayId": "string",
53 "status": "CREATED",
54 "name": "string",
55 "erpSystemDisplayId": "string"
56 },
57 "expenseCategory": {
58 "id": 0,
59 "displayId": "string",
60 "status": "CREATED",
61 "name": "string",
62 "expenseCategoryType": "PAYMENT"
63 },
64 "paymentMethod": {
65 "id": 0,
66 "displayId": "string",
67 "status": "CREATED",
68 "name": "string",
69 "type": "string"
70 },
71 "tag": "string",
72 "contract": {
73 "id": 0,
74 "displayId": "string"
75 },
76 "postingDate": "2019-08-24",
77 "taxes": [
78 {
79 "id": 0,
80 "displayId": "string",
81 "baseAmount": 0,
82 "roundedAmount": 0,
83 "unroundedAmount": 0,
84 "deltaAdjustment": 0,
85 "totalTaxDocumentAmount": 0,
86 "taxExempt": 0,
87 "taxAffected": 0,
88 "taxRate": 0.1,
89 "taxCode": {
90 "id": 0,
91 "displayId": "string"
92 },
93 "taxJurisdiction": {
94 "id": 0,
95 "displayId": "string"
96 },
97 "accountingKey": "string",
98 "conditionKey": "string",
99 "taxAccount": "string",
100 "scheduledPaymentId": 0,
101 "allowsSystemGenerateNewId": true,
102 "numberRangeIdentifierValue": "string",
103 "numberRangeIdentifierType": {
104 "name": "string"
105 },
106 "numberRangeType": {
107 "name": "string"
108 }
109 }
110 ],
111 "allowsSystemGenerateNewId": true,
112 "numberRangeIdentifierValue": "string",
113 "numberRangeIdentifierType": {
114 "name": "string"
115 },
116 "numberRangeType": {
117 "name": "string"
118 }
119 }
120 ],
121 "number": 0,
122 "sort": {
123 "unsorted": true,
124 "sorted": true,
125 "empty": true
126 },
127 "first": true,
128 "last": true,
129 "empty": true
130}
Advanced Scheduled Payment Search¶
HTTP Request
POST /api/v1/scheduled-payment/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 scheduled payments, including filters for date range, payment status, and transaction type to facilitate precise financial analysis. |
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 "clearingLedgerTransactionId": 0,
7 "clearingLedgerEntryId": 0,
8 "roundedAmount": 0,
9 "unroundedAmount": 0,
10 "deltaAdjustment": 0,
11 "availableNetAmount": 0,
12 "availableTaxAmount": 0,
13 "fiscalYear": 0,
14 "fiscalPeriod": 0,
15 "currency": {
16 "id": 0,
17 "displayId": "string",
18 "status": "CREATED",
19 "name": "string",
20 "decimalPoints": 0
21 },
22 "company": {
23 "id": 0,
24 "displayId": "string",
25 "status": "CREATED",
26 "erpSystemId": 0,
27 "erpSystemDisplayId": "string",
28 "countryId": 0,
29 "countryDisplayId": "string",
30 "name": "string",
31 "postingPeriodVariantId": 0,
32 "fiscalVariantId": 0
33 },
34 "vendor": {
35 "id": 0,
36 "displayId": "string",
37 "status": "CREATED",
38 "name": "string",
39 "erpSystemDisplayId": "string"
40 },
41 "expenseCategory": {
42 "id": 0,
43 "displayId": "string",
44 "status": "CREATED",
45 "name": "string",
46 "expenseCategoryType": "PAYMENT"
47 },
48 "paymentMethod": {
49 "id": 0,
50 "displayId": "string",
51 "status": "CREATED",
52 "name": "string",
53 "type": "string"
54 },
55 "tag": "string",
56 "contract": {
57 "id": 0,
58 "displayId": "string"
59 },
60 "postingDate": "2019-08-24",
61 "taxes": [
62 {
63 "id": 0,
64 "displayId": "string",
65 "baseAmount": 0,
66 "roundedAmount": 0,
67 "unroundedAmount": 0,
68 "deltaAdjustment": 0,
69 "totalTaxDocumentAmount": 0,
70 "taxExempt": 0,
71 "taxAffected": 0,
72 "taxRate": 0.1,
73 "taxCode": {
74 "id": 0,
75 "displayId": "string"
76 },
77 "taxJurisdiction": {
78 "id": 0,
79 "displayId": "string"
80 },
81 "accountingKey": "string",
82 "conditionKey": "string",
83 "taxAccount": "string",
84 "scheduledPaymentId": 0,
85 "allowsSystemGenerateNewId": true,
86 "numberRangeIdentifierValue": "string",
87 "numberRangeIdentifierType": {
88 "name": "string"
89 },
90 "numberRangeType": {
91 "name": "string"
92 }
93 }
94 ],
95 "allowsSystemGenerateNewId": true,
96 "numberRangeIdentifierValue": "string",
97 "numberRangeIdentifierType": {
98 "name": "string"
99 },
100 "numberRangeType": {
101 "name": "string"
102 }
103 }
104 ],
105 "facets": {
106 "property1": {},
107 "property2": {}
108 },
109 "aggregations": {
110 "property1": {},
111 "property2": {}
112 },
113 "pagination": {
114 "number": 0,
115 "size": 0,
116 "totalElements": 0,
117 "totalPages": 0,
118 "first": true,
119 "last": true,
120 "empty": true,
121 "numberOfElements": 0
122 }
123}