Invoice Payment¶
Get A Resource By ID¶
HTTP Request
GET /api/v1/invoice-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 "invoiceId": 0,
18 "invoiceDisplayId": "string",
19 "invoiceName": "string",
20 "ledgerTransactionId": 0,
21 "ledgerWorkspaceId": 0,
22 "state": "INV_DRAFT",
23 "documentDate": "2019-08-24",
24 "postingDate": "2019-08-24",
25 "paymentLines": [
26 {
27 "id": 0,
28 "displayId": "string",
29 "invoicePaymentId": 0,
30 "invoicePaymentDisplayId": "string",
31 "invoiceLineItemId": 0,
32 "invoiceLineItemDisplayId": "string",
33 "invoiceLineItemDescription": "string",
34 "expenseCategoryDisplayId": "string",
35 "expenseCategoryName": "string",
36 "netAmount": 0,
37 "taxAmount": 0,
38 "allocatedNetAmountUsed": 0,
39 "allocatedTaxAmountUsed": 0,
40 "unfundedNetAmount": 0,
41 "unfundedTaxAmount": 0,
42 "totalAmount": 0,
43 "allowsSystemGenerateNewId": true,
44 "numberRangeIdentifierValue": "string",
45 "numberRangeIdentifierType": {
46 "name": "string"
47 },
48 "numberRangeType": {
49 "name": "string"
50 }
51 }
52 ],
53 "generatedInWorkspace": true,
54 "totalAllocatedNetAmount": 0,
55 "totalAmount": 0,
56 "totalNetAmount": 0,
57 "totalTaxAmount": 0,
58 "totalUnfundedNetAmount": 0,
59 "allowsSystemGenerateNewId": true,
60 "numberRangeIdentifierValue": "string",
61 "numberRangeIdentifierType": {
62 "name": "string"
63 },
64 "numberRangeType": {
65 "name": "string"
66 }
67 }
68}
Update A Resource¶
HTTP Request
PUT /api/v1/invoice-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 invoice payment details, including payment amount, method, and any relevant transaction metadata. |
Body Parameters
1{
2 "id": 0,
3 "displayId": "string",
4 "invoiceId": 0,
5 "invoiceDisplayId": "string",
6 "invoiceName": "string",
7 "ledgerTransactionId": 0,
8 "ledgerWorkspaceId": 0,
9 "state": "INV_DRAFT",
10 "documentDate": "2019-08-24",
11 "postingDate": "2019-08-24",
12 "paymentLines": [
13 {
14 "id": 0,
15 "displayId": "string",
16 "invoicePaymentId": 0,
17 "invoicePaymentDisplayId": "string",
18 "invoiceLineItemId": 0,
19 "invoiceLineItemDisplayId": "string",
20 "invoiceLineItemDescription": "string",
21 "expenseCategoryDisplayId": "string",
22 "expenseCategoryName": "string",
23 "netAmount": 0,
24 "taxAmount": 0,
25 "allocatedNetAmountUsed": 0,
26 "allocatedTaxAmountUsed": 0,
27 "unfundedNetAmount": 0,
28 "unfundedTaxAmount": 0,
29 "totalAmount": 0,
30 "allowsSystemGenerateNewId": true,
31 "numberRangeIdentifierValue": "string",
32 "numberRangeIdentifierType": {
33 "name": "string"
34 },
35 "numberRangeType": {
36 "name": "string"
37 }
38 }
39 ],
40 "generatedInWorkspace": true,
41 "totalAllocatedNetAmount": 0,
42 "totalAmount": 0,
43 "totalNetAmount": 0,
44 "totalTaxAmount": 0,
45 "totalUnfundedNetAmount": 0,
46 "allowsSystemGenerateNewId": true,
47 "numberRangeIdentifierValue": "string",
48 "numberRangeIdentifierType": {
49 "name": "string"
50 },
51 "numberRangeType": {
52 "name": "string"
53 }
54}
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 "invoiceId": 0,
18 "invoiceDisplayId": "string",
19 "invoiceName": "string",
20 "ledgerTransactionId": 0,
21 "ledgerWorkspaceId": 0,
22 "state": "INV_DRAFT",
23 "documentDate": "2019-08-24",
24 "postingDate": "2019-08-24",
25 "paymentLines": [
26 {
27 "id": 0,
28 "displayId": "string",
29 "invoicePaymentId": 0,
30 "invoicePaymentDisplayId": "string",
31 "invoiceLineItemId": 0,
32 "invoiceLineItemDisplayId": "string",
33 "invoiceLineItemDescription": "string",
34 "expenseCategoryDisplayId": "string",
35 "expenseCategoryName": "string",
36 "netAmount": 0,
37 "taxAmount": 0,
38 "allocatedNetAmountUsed": 0,
39 "allocatedTaxAmountUsed": 0,
40 "unfundedNetAmount": 0,
41 "unfundedTaxAmount": 0,
42 "totalAmount": 0,
43 "allowsSystemGenerateNewId": true,
44 "numberRangeIdentifierValue": "string",
45 "numberRangeIdentifierType": {
46 "name": "string"
47 },
48 "numberRangeType": {
49 "name": "string"
50 }
51 }
52 ],
53 "generatedInWorkspace": true,
54 "totalAllocatedNetAmount": 0,
55 "totalAmount": 0,
56 "totalNetAmount": 0,
57 "totalTaxAmount": 0,
58 "totalUnfundedNetAmount": 0,
59 "allowsSystemGenerateNewId": true,
60 "numberRangeIdentifierValue": "string",
61 "numberRangeIdentifierType": {
62 "name": "string"
63 },
64 "numberRangeType": {
65 "name": "string"
66 }
67 }
68}
Delete A Single Resource¶
HTTP Request
DELETE /api/v1/invoice-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/invoice-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 payment details for the specified invoice, including payment amount and method. |
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 "invoiceId": 0,
18 "invoiceDisplayId": "string",
19 "invoiceName": "string",
20 "ledgerTransactionId": 0,
21 "ledgerWorkspaceId": 0,
22 "state": "INV_DRAFT",
23 "documentDate": "2019-08-24",
24 "postingDate": "2019-08-24",
25 "paymentLines": [
26 {
27 "id": 0,
28 "displayId": "string",
29 "invoicePaymentId": 0,
30 "invoicePaymentDisplayId": "string",
31 "invoiceLineItemId": 0,
32 "invoiceLineItemDisplayId": "string",
33 "invoiceLineItemDescription": "string",
34 "expenseCategoryDisplayId": "string",
35 "expenseCategoryName": "string",
36 "netAmount": 0,
37 "taxAmount": 0,
38 "allocatedNetAmountUsed": 0,
39 "allocatedTaxAmountUsed": 0,
40 "unfundedNetAmount": 0,
41 "unfundedTaxAmount": 0,
42 "totalAmount": 0,
43 "allowsSystemGenerateNewId": true,
44 "numberRangeIdentifierValue": "string",
45 "numberRangeIdentifierType": {
46 "name": "string"
47 },
48 "numberRangeType": {
49 "name": "string"
50 }
51 }
52 ],
53 "generatedInWorkspace": true,
54 "totalAllocatedNetAmount": 0,
55 "totalAmount": 0,
56 "totalNetAmount": 0,
57 "totalTaxAmount": 0,
58 "totalUnfundedNetAmount": 0,
59 "allowsSystemGenerateNewId": true,
60 "numberRangeIdentifierValue": "string",
61 "numberRangeIdentifierType": {
62 "name": "string"
63 },
64 "numberRangeType": {
65 "name": "string"
66 }
67 }
68}
Create Or Update A Resource¶
HTTP Request
PUT /api/v1/invoice-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 invoice payment details, including payment amount, invoice ID, and customer information for creating or updating payment records. |
Body Parameters
1{
2 "id": 0,
3 "displayId": "string",
4 "invoiceId": 0,
5 "invoiceDisplayId": "string",
6 "invoiceName": "string",
7 "ledgerTransactionId": 0,
8 "ledgerWorkspaceId": 0,
9 "state": "INV_DRAFT",
10 "documentDate": "2019-08-24",
11 "postingDate": "2019-08-24",
12 "paymentLines": [
13 {
14 "id": 0,
15 "displayId": "string",
16 "invoicePaymentId": 0,
17 "invoicePaymentDisplayId": "string",
18 "invoiceLineItemId": 0,
19 "invoiceLineItemDisplayId": "string",
20 "invoiceLineItemDescription": "string",
21 "expenseCategoryDisplayId": "string",
22 "expenseCategoryName": "string",
23 "netAmount": 0,
24 "taxAmount": 0,
25 "allocatedNetAmountUsed": 0,
26 "allocatedTaxAmountUsed": 0,
27 "unfundedNetAmount": 0,
28 "unfundedTaxAmount": 0,
29 "totalAmount": 0,
30 "allowsSystemGenerateNewId": true,
31 "numberRangeIdentifierValue": "string",
32 "numberRangeIdentifierType": {
33 "name": "string"
34 },
35 "numberRangeType": {
36 "name": "string"
37 }
38 }
39 ],
40 "generatedInWorkspace": true,
41 "totalAllocatedNetAmount": 0,
42 "totalAmount": 0,
43 "totalNetAmount": 0,
44 "totalTaxAmount": 0,
45 "totalUnfundedNetAmount": 0,
46 "allowsSystemGenerateNewId": true,
47 "numberRangeIdentifierValue": "string",
48 "numberRangeIdentifierType": {
49 "name": "string"
50 },
51 "numberRangeType": {
52 "name": "string"
53 }
54}
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 "invoiceId": 0,
18 "invoiceDisplayId": "string",
19 "invoiceName": "string",
20 "ledgerTransactionId": 0,
21 "ledgerWorkspaceId": 0,
22 "state": "INV_DRAFT",
23 "documentDate": "2019-08-24",
24 "postingDate": "2019-08-24",
25 "paymentLines": [
26 {
27 "id": 0,
28 "displayId": "string",
29 "invoicePaymentId": 0,
30 "invoicePaymentDisplayId": "string",
31 "invoiceLineItemId": 0,
32 "invoiceLineItemDisplayId": "string",
33 "invoiceLineItemDescription": "string",
34 "expenseCategoryDisplayId": "string",
35 "expenseCategoryName": "string",
36 "netAmount": 0,
37 "taxAmount": 0,
38 "allocatedNetAmountUsed": 0,
39 "allocatedTaxAmountUsed": 0,
40 "unfundedNetAmount": 0,
41 "unfundedTaxAmount": 0,
42 "totalAmount": 0,
43 "allowsSystemGenerateNewId": true,
44 "numberRangeIdentifierValue": "string",
45 "numberRangeIdentifierType": {
46 "name": "string"
47 },
48 "numberRangeType": {
49 "name": "string"
50 }
51 }
52 ],
53 "generatedInWorkspace": true,
54 "totalAllocatedNetAmount": 0,
55 "totalAmount": 0,
56 "totalNetAmount": 0,
57 "totalTaxAmount": 0,
58 "totalUnfundedNetAmount": 0,
59 "allowsSystemGenerateNewId": true,
60 "numberRangeIdentifierValue": "string",
61 "numberRangeIdentifierType": {
62 "name": "string"
63 },
64 "numberRangeType": {
65 "name": "string"
66 }
67 }
68}
Bulk Create-Or-Update Resources¶
HTTP Request
PUT /api/v1/invoice-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 invoice payment records for bulk creation or updates, including relevant payment details and associated metadata. |
Body Parameters
1[
2 {
3 "id": 0,
4 "displayId": "string",
5 "invoiceId": 0,
6 "invoiceDisplayId": "string",
7 "invoiceName": "string",
8 "ledgerTransactionId": 0,
9 "ledgerWorkspaceId": 0,
10 "state": "INV_DRAFT",
11 "documentDate": "2019-08-24",
12 "postingDate": "2019-08-24",
13 "paymentLines": [
14 {
15 "id": 0,
16 "displayId": "string",
17 "invoicePaymentId": 0,
18 "invoicePaymentDisplayId": "string",
19 "invoiceLineItemId": 0,
20 "invoiceLineItemDisplayId": "string",
21 "invoiceLineItemDescription": "string",
22 "expenseCategoryDisplayId": "string",
23 "expenseCategoryName": "string",
24 "netAmount": 0,
25 "taxAmount": 0,
26 "allocatedNetAmountUsed": 0,
27 "allocatedTaxAmountUsed": 0,
28 "unfundedNetAmount": 0,
29 "unfundedTaxAmount": 0,
30 "totalAmount": 0,
31 "allowsSystemGenerateNewId": true,
32 "numberRangeIdentifierValue": "string",
33 "numberRangeIdentifierType": {
34 "name": "string"
35 },
36 "numberRangeType": {
37 "name": "string"
38 }
39 }
40 ],
41 "generatedInWorkspace": true,
42 "totalAllocatedNetAmount": 0,
43 "totalAmount": 0,
44 "totalNetAmount": 0,
45 "totalTaxAmount": 0,
46 "totalUnfundedNetAmount": 0,
47 "allowsSystemGenerateNewId": true,
48 "numberRangeIdentifierValue": "string",
49 "numberRangeIdentifierType": {
50 "name": "string"
51 },
52 "numberRangeType": {
53 "name": "string"
54 }
55 }
56]
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 "invoiceId": 0,
19 "invoiceDisplayId": "string",
20 "invoiceName": "string",
21 "ledgerTransactionId": 0,
22 "ledgerWorkspaceId": 0,
23 "state": "INV_DRAFT",
24 "documentDate": "2019-08-24",
25 "postingDate": "2019-08-24",
26 "paymentLines": [
27 {
28 "id": 0,
29 "displayId": "string",
30 "invoicePaymentId": 0,
31 "invoicePaymentDisplayId": "string",
32 "invoiceLineItemId": 0,
33 "invoiceLineItemDisplayId": "string",
34 "invoiceLineItemDescription": "string",
35 "expenseCategoryDisplayId": "string",
36 "expenseCategoryName": "string",
37 "netAmount": 0,
38 "taxAmount": 0,
39 "allocatedNetAmountUsed": 0,
40 "allocatedTaxAmountUsed": 0,
41 "unfundedNetAmount": 0,
42 "unfundedTaxAmount": 0,
43 "totalAmount": 0,
44 "allowsSystemGenerateNewId": true,
45 "numberRangeIdentifierValue": "string",
46 "numberRangeIdentifierType": {
47 "name": "string"
48 },
49 "numberRangeType": {
50 "name": "string"
51 }
52 }
53 ],
54 "generatedInWorkspace": true,
55 "totalAllocatedNetAmount": 0,
56 "totalAmount": 0,
57 "totalNetAmount": 0,
58 "totalTaxAmount": 0,
59 "totalUnfundedNetAmount": 0,
60 "allowsSystemGenerateNewId": true,
61 "numberRangeIdentifierValue": "string",
62 "numberRangeIdentifierType": {
63 "name": "string"
64 },
65 "numberRangeType": {
66 "name": "string"
67 }
68 }
69 ]
70}
Bulk-Update Resources¶
HTTP Request
PUT /api/v1/invoice-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 invoice payment details, including payment amounts and associated invoice identifiers, to facilitate bulk processing of payments. |
Body Parameters
1[
2 {
3 "id": 0,
4 "displayId": "string",
5 "invoiceId": 0,
6 "invoiceDisplayId": "string",
7 "invoiceName": "string",
8 "ledgerTransactionId": 0,
9 "ledgerWorkspaceId": 0,
10 "state": "INV_DRAFT",
11 "documentDate": "2019-08-24",
12 "postingDate": "2019-08-24",
13 "paymentLines": [
14 {
15 "id": 0,
16 "displayId": "string",
17 "invoicePaymentId": 0,
18 "invoicePaymentDisplayId": "string",
19 "invoiceLineItemId": 0,
20 "invoiceLineItemDisplayId": "string",
21 "invoiceLineItemDescription": "string",
22 "expenseCategoryDisplayId": "string",
23 "expenseCategoryName": "string",
24 "netAmount": 0,
25 "taxAmount": 0,
26 "allocatedNetAmountUsed": 0,
27 "allocatedTaxAmountUsed": 0,
28 "unfundedNetAmount": 0,
29 "unfundedTaxAmount": 0,
30 "totalAmount": 0,
31 "allowsSystemGenerateNewId": true,
32 "numberRangeIdentifierValue": "string",
33 "numberRangeIdentifierType": {
34 "name": "string"
35 },
36 "numberRangeType": {
37 "name": "string"
38 }
39 }
40 ],
41 "generatedInWorkspace": true,
42 "totalAllocatedNetAmount": 0,
43 "totalAmount": 0,
44 "totalNetAmount": 0,
45 "totalTaxAmount": 0,
46 "totalUnfundedNetAmount": 0,
47 "allowsSystemGenerateNewId": true,
48 "numberRangeIdentifierValue": "string",
49 "numberRangeIdentifierType": {
50 "name": "string"
51 },
52 "numberRangeType": {
53 "name": "string"
54 }
55 }
56]
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 "invoiceId": 0,
19 "invoiceDisplayId": "string",
20 "invoiceName": "string",
21 "ledgerTransactionId": 0,
22 "ledgerWorkspaceId": 0,
23 "state": "INV_DRAFT",
24 "documentDate": "2019-08-24",
25 "postingDate": "2019-08-24",
26 "paymentLines": [
27 {
28 "id": 0,
29 "displayId": "string",
30 "invoicePaymentId": 0,
31 "invoicePaymentDisplayId": "string",
32 "invoiceLineItemId": 0,
33 "invoiceLineItemDisplayId": "string",
34 "invoiceLineItemDescription": "string",
35 "expenseCategoryDisplayId": "string",
36 "expenseCategoryName": "string",
37 "netAmount": 0,
38 "taxAmount": 0,
39 "allocatedNetAmountUsed": 0,
40 "allocatedTaxAmountUsed": 0,
41 "unfundedNetAmount": 0,
42 "unfundedTaxAmount": 0,
43 "totalAmount": 0,
44 "allowsSystemGenerateNewId": true,
45 "numberRangeIdentifierValue": "string",
46 "numberRangeIdentifierType": {
47 "name": "string"
48 },
49 "numberRangeType": {
50 "name": "string"
51 }
52 }
53 ],
54 "generatedInWorkspace": true,
55 "totalAllocatedNetAmount": 0,
56 "totalAmount": 0,
57 "totalNetAmount": 0,
58 "totalTaxAmount": 0,
59 "totalUnfundedNetAmount": 0,
60 "allowsSystemGenerateNewId": true,
61 "numberRangeIdentifierValue": "string",
62 "numberRangeIdentifierType": {
63 "name": "string"
64 },
65 "numberRangeType": {
66 "name": "string"
67 }
68 }
69 ]
70}
Bulk-Create Resources¶
HTTP Request
POST /api/v1/invoice-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 invoice payment details, including amounts and associated invoice identifiers, for processing multiple payments in a single transaction. |
Body Parameters
1[
2 {
3 "id": 0,
4 "displayId": "string",
5 "invoiceId": 0,
6 "invoiceDisplayId": "string",
7 "invoiceName": "string",
8 "ledgerTransactionId": 0,
9 "ledgerWorkspaceId": 0,
10 "state": "INV_DRAFT",
11 "documentDate": "2019-08-24",
12 "postingDate": "2019-08-24",
13 "paymentLines": [
14 {
15 "id": 0,
16 "displayId": "string",
17 "invoicePaymentId": 0,
18 "invoicePaymentDisplayId": "string",
19 "invoiceLineItemId": 0,
20 "invoiceLineItemDisplayId": "string",
21 "invoiceLineItemDescription": "string",
22 "expenseCategoryDisplayId": "string",
23 "expenseCategoryName": "string",
24 "netAmount": 0,
25 "taxAmount": 0,
26 "allocatedNetAmountUsed": 0,
27 "allocatedTaxAmountUsed": 0,
28 "unfundedNetAmount": 0,
29 "unfundedTaxAmount": 0,
30 "totalAmount": 0,
31 "allowsSystemGenerateNewId": true,
32 "numberRangeIdentifierValue": "string",
33 "numberRangeIdentifierType": {
34 "name": "string"
35 },
36 "numberRangeType": {
37 "name": "string"
38 }
39 }
40 ],
41 "generatedInWorkspace": true,
42 "totalAllocatedNetAmount": 0,
43 "totalAmount": 0,
44 "totalNetAmount": 0,
45 "totalTaxAmount": 0,
46 "totalUnfundedNetAmount": 0,
47 "allowsSystemGenerateNewId": true,
48 "numberRangeIdentifierValue": "string",
49 "numberRangeIdentifierType": {
50 "name": "string"
51 },
52 "numberRangeType": {
53 "name": "string"
54 }
55 }
56]
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 "invoiceId": 0,
19 "invoiceDisplayId": "string",
20 "invoiceName": "string",
21 "ledgerTransactionId": 0,
22 "ledgerWorkspaceId": 0,
23 "state": "INV_DRAFT",
24 "documentDate": "2019-08-24",
25 "postingDate": "2019-08-24",
26 "paymentLines": [
27 {
28 "id": 0,
29 "displayId": "string",
30 "invoicePaymentId": 0,
31 "invoicePaymentDisplayId": "string",
32 "invoiceLineItemId": 0,
33 "invoiceLineItemDisplayId": "string",
34 "invoiceLineItemDescription": "string",
35 "expenseCategoryDisplayId": "string",
36 "expenseCategoryName": "string",
37 "netAmount": 0,
38 "taxAmount": 0,
39 "allocatedNetAmountUsed": 0,
40 "allocatedTaxAmountUsed": 0,
41 "unfundedNetAmount": 0,
42 "unfundedTaxAmount": 0,
43 "totalAmount": 0,
44 "allowsSystemGenerateNewId": true,
45 "numberRangeIdentifierValue": "string",
46 "numberRangeIdentifierType": {
47 "name": "string"
48 },
49 "numberRangeType": {
50 "name": "string"
51 }
52 }
53 ],
54 "generatedInWorkspace": true,
55 "totalAllocatedNetAmount": 0,
56 "totalAmount": 0,
57 "totalNetAmount": 0,
58 "totalTaxAmount": 0,
59 "totalUnfundedNetAmount": 0,
60 "allowsSystemGenerateNewId": true,
61 "numberRangeIdentifierValue": "string",
62 "numberRangeIdentifierType": {
63 "name": "string"
64 },
65 "numberRangeType": {
66 "name": "string"
67 }
68 }
69 ]
70}
Bulk-Delete Resources¶
HTTP Request
DELETE /api/v1/invoice-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 invoice payment IDs to be deleted in bulk, facilitating streamlined financial management. |
Body Parameters
1[
2 0
3]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
||
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "errorMessage": "string",
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {}
15}
List All Resources¶
HTTP Request
GET /api/v1/invoice-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 invoice payment retrieval should be paginated for improved data management and user experience. |
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 "invoiceId": 0,
23 "invoiceDisplayId": "string",
24 "invoiceName": "string",
25 "ledgerTransactionId": 0,
26 "ledgerWorkspaceId": 0,
27 "state": "INV_DRAFT",
28 "documentDate": "2019-08-24",
29 "postingDate": "2019-08-24",
30 "paymentLines": [
31 {
32 "id": 0,
33 "displayId": "string",
34 "invoicePaymentId": 0,
35 "invoicePaymentDisplayId": "string",
36 "invoiceLineItemId": 0,
37 "invoiceLineItemDisplayId": "string",
38 "invoiceLineItemDescription": "string",
39 "expenseCategoryDisplayId": "string",
40 "expenseCategoryName": "string",
41 "netAmount": 0,
42 "taxAmount": 0,
43 "allocatedNetAmountUsed": 0,
44 "allocatedTaxAmountUsed": 0,
45 "unfundedNetAmount": 0,
46 "unfundedTaxAmount": 0,
47 "totalAmount": 0,
48 "allowsSystemGenerateNewId": true,
49 "numberRangeIdentifierValue": "string",
50 "numberRangeIdentifierType": {
51 "name": "string"
52 },
53 "numberRangeType": {
54 "name": "string"
55 }
56 }
57 ],
58 "generatedInWorkspace": true,
59 "totalAllocatedNetAmount": 0,
60 "totalAmount": 0,
61 "totalNetAmount": 0,
62 "totalTaxAmount": 0,
63 "totalUnfundedNetAmount": 0,
64 "allowsSystemGenerateNewId": true,
65 "numberRangeIdentifierValue": "string",
66 "numberRangeIdentifierType": {
67 "name": "string"
68 },
69 "numberRangeType": {
70 "name": "string"
71 }
72 }
73 ],
74 "number": 0,
75 "sort": {
76 "unsorted": true,
77 "sorted": true,
78 "empty": true
79 },
80 "first": true,
81 "last": true,
82 "empty": true
83}
Create A Resource¶
HTTP Request
POST /api/v1/invoice-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 invoice payment details, including payment amount, invoice ID, and payment method for processing transactions. |
Body Parameters
1{
2 "id": 0,
3 "displayId": "string",
4 "invoiceId": 0,
5 "invoiceDisplayId": "string",
6 "invoiceName": "string",
7 "ledgerTransactionId": 0,
8 "ledgerWorkspaceId": 0,
9 "state": "INV_DRAFT",
10 "documentDate": "2019-08-24",
11 "postingDate": "2019-08-24",
12 "paymentLines": [
13 {
14 "id": 0,
15 "displayId": "string",
16 "invoicePaymentId": 0,
17 "invoicePaymentDisplayId": "string",
18 "invoiceLineItemId": 0,
19 "invoiceLineItemDisplayId": "string",
20 "invoiceLineItemDescription": "string",
21 "expenseCategoryDisplayId": "string",
22 "expenseCategoryName": "string",
23 "netAmount": 0,
24 "taxAmount": 0,
25 "allocatedNetAmountUsed": 0,
26 "allocatedTaxAmountUsed": 0,
27 "unfundedNetAmount": 0,
28 "unfundedTaxAmount": 0,
29 "totalAmount": 0,
30 "allowsSystemGenerateNewId": true,
31 "numberRangeIdentifierValue": "string",
32 "numberRangeIdentifierType": {
33 "name": "string"
34 },
35 "numberRangeType": {
36 "name": "string"
37 }
38 }
39 ],
40 "generatedInWorkspace": true,
41 "totalAllocatedNetAmount": 0,
42 "totalAmount": 0,
43 "totalNetAmount": 0,
44 "totalTaxAmount": 0,
45 "totalUnfundedNetAmount": 0,
46 "allowsSystemGenerateNewId": true,
47 "numberRangeIdentifierValue": "string",
48 "numberRangeIdentifierType": {
49 "name": "string"
50 },
51 "numberRangeType": {
52 "name": "string"
53 }
54}
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 "invoiceId": 0,
18 "invoiceDisplayId": "string",
19 "invoiceName": "string",
20 "ledgerTransactionId": 0,
21 "ledgerWorkspaceId": 0,
22 "state": "INV_DRAFT",
23 "documentDate": "2019-08-24",
24 "postingDate": "2019-08-24",
25 "paymentLines": [
26 {
27 "id": 0,
28 "displayId": "string",
29 "invoicePaymentId": 0,
30 "invoicePaymentDisplayId": "string",
31 "invoiceLineItemId": 0,
32 "invoiceLineItemDisplayId": "string",
33 "invoiceLineItemDescription": "string",
34 "expenseCategoryDisplayId": "string",
35 "expenseCategoryName": "string",
36 "netAmount": 0,
37 "taxAmount": 0,
38 "allocatedNetAmountUsed": 0,
39 "allocatedTaxAmountUsed": 0,
40 "unfundedNetAmount": 0,
41 "unfundedTaxAmount": 0,
42 "totalAmount": 0,
43 "allowsSystemGenerateNewId": true,
44 "numberRangeIdentifierValue": "string",
45 "numberRangeIdentifierType": {
46 "name": "string"
47 },
48 "numberRangeType": {
49 "name": "string"
50 }
51 }
52 ],
53 "generatedInWorkspace": true,
54 "totalAllocatedNetAmount": 0,
55 "totalAmount": 0,
56 "totalNetAmount": 0,
57 "totalTaxAmount": 0,
58 "totalUnfundedNetAmount": 0,
59 "allowsSystemGenerateNewId": true,
60 "numberRangeIdentifierValue": "string",
61 "numberRangeIdentifierType": {
62 "name": "string"
63 },
64 "numberRangeType": {
65 "name": "string"
66 }
67 }
68}
Search Resources¶
HTTP Request
POST /api/v1/invoice-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 invoice payments, including parameters such as invoice number, payment status, and date range. |
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 "invoiceIdEqual": 0,
20 "invoiceIdIn": [
21 0
22 ],
23 "stateEqual": "INV_DRAFT",
24 "stateIn": [
25 "INV_DRAFT"
26 ],
27 "documentDateEqual": "2019-08-24",
28 "documentDateGreaterThanOrEqual": "2019-08-24",
29 "documentDateLessThanOrEqual": "2019-08-24",
30 "postingDateEqual": "2019-08-24",
31 "postingDateGreaterThanOrEqual": "2019-08-24",
32 "postingDateLessThanOrEqual": "2019-08-24"
33}
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 "invoiceId": 0,
23 "invoiceDisplayId": "string",
24 "invoiceName": "string",
25 "ledgerTransactionId": 0,
26 "ledgerWorkspaceId": 0,
27 "state": "INV_DRAFT",
28 "documentDate": "2019-08-24",
29 "postingDate": "2019-08-24",
30 "paymentLines": [
31 {
32 "id": 0,
33 "displayId": "string",
34 "invoicePaymentId": 0,
35 "invoicePaymentDisplayId": "string",
36 "invoiceLineItemId": 0,
37 "invoiceLineItemDisplayId": "string",
38 "invoiceLineItemDescription": "string",
39 "expenseCategoryDisplayId": "string",
40 "expenseCategoryName": "string",
41 "netAmount": 0,
42 "taxAmount": 0,
43 "allocatedNetAmountUsed": 0,
44 "allocatedTaxAmountUsed": 0,
45 "unfundedNetAmount": 0,
46 "unfundedTaxAmount": 0,
47 "totalAmount": 0,
48 "allowsSystemGenerateNewId": true,
49 "numberRangeIdentifierValue": "string",
50 "numberRangeIdentifierType": {
51 "name": "string"
52 },
53 "numberRangeType": {
54 "name": "string"
55 }
56 }
57 ],
58 "generatedInWorkspace": true,
59 "totalAllocatedNetAmount": 0,
60 "totalAmount": 0,
61 "totalNetAmount": 0,
62 "totalTaxAmount": 0,
63 "totalUnfundedNetAmount": 0,
64 "allowsSystemGenerateNewId": true,
65 "numberRangeIdentifierValue": "string",
66 "numberRangeIdentifierType": {
67 "name": "string"
68 },
69 "numberRangeType": {
70 "name": "string"
71 }
72 }
73 ],
74 "number": 0,
75 "sort": {
76 "unsorted": true,
77 "sorted": true,
78 "empty": true
79 },
80 "first": true,
81 "last": true,
82 "empty": true
83}
Advanced Invoice Payment Search¶
HTTP Request
POST /api/v1/invoice-payment/advanced-search
📋 Description: Full-text / multi-field search with faceting support. Returns a SearchResponseDto with total hits.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
page |
query |
integer |
false |
Zero-based page index (0..N) |
size |
query |
integer |
false |
The size of the page to be returned |
sort |
query |
array[string] |
false |
Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. |
body |
body |
true |
Request body containing advanced search criteria for invoice payments, including filters such as date range, payment status, and invoice identifiers 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 "invoiceId": 0,
7 "invoiceDisplayId": "string",
8 "invoiceName": "string",
9 "ledgerTransactionId": 0,
10 "ledgerWorkspaceId": 0,
11 "state": "INV_DRAFT",
12 "documentDate": "2019-08-24",
13 "postingDate": "2019-08-24",
14 "paymentLines": [
15 {
16 "id": 0,
17 "displayId": "string",
18 "invoicePaymentId": 0,
19 "invoicePaymentDisplayId": "string",
20 "invoiceLineItemId": 0,
21 "invoiceLineItemDisplayId": "string",
22 "invoiceLineItemDescription": "string",
23 "expenseCategoryDisplayId": "string",
24 "expenseCategoryName": "string",
25 "netAmount": 0,
26 "taxAmount": 0,
27 "allocatedNetAmountUsed": 0,
28 "allocatedTaxAmountUsed": 0,
29 "unfundedNetAmount": 0,
30 "unfundedTaxAmount": 0,
31 "totalAmount": 0,
32 "allowsSystemGenerateNewId": true,
33 "numberRangeIdentifierValue": "string",
34 "numberRangeIdentifierType": {
35 "name": "string"
36 },
37 "numberRangeType": {
38 "name": "string"
39 }
40 }
41 ],
42 "generatedInWorkspace": true,
43 "totalAllocatedNetAmount": 0,
44 "totalAmount": 0,
45 "totalNetAmount": 0,
46 "totalTaxAmount": 0,
47 "totalUnfundedNetAmount": 0,
48 "allowsSystemGenerateNewId": true,
49 "numberRangeIdentifierValue": "string",
50 "numberRangeIdentifierType": {
51 "name": "string"
52 },
53 "numberRangeType": {
54 "name": "string"
55 }
56 }
57 ],
58 "facets": {
59 "property1": {},
60 "property2": {}
61 },
62 "aggregations": {
63 "property1": {},
64 "property2": {}
65 },
66 "pagination": {
67 "number": 0,
68 "size": 0,
69 "totalElements": 0,
70 "totalPages": 0,
71 "first": true,
72 "last": true,
73 "empty": true,
74 "numberOfElements": 0
75 }
76}
Check Whether Balance Records Exist For An Invoice¶
HTTP Request
GET /api/v1/invoice-payment/invoice/{invoiceId}/has-balances
📋 Description: Returns true if the invoice has been approved and its line-item balances have been initialised. A false result means no payments can be created against this invoice yet.
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 "hasBalances": true
3}
Get Remaining Line-Item Balances For An Invoice¶
HTTP Request
GET /api/v1/invoice-payment/invoice/{invoiceId}/balances
📋 Description: Returns the remaining (unpaid) net and tax amounts per line item for the specified invoice. Balances are initialised when the invoice reaches Approved state. Use this before creating an InvoicePayment to know how much can still be allocated.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
invoiceId |
path |
integer(int64) |
true |
Invoice ID |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
|
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
Example Responses
1[
2 {
3 "id": 0,
4 "displayId": "string",
5 "invoiceId": 0,
6 "invoiceDisplayId": "string",
7 "invoiceLineItemId": 0,
8 "invoiceLineItemDisplayId": "string",
9 "invoiceLineItemDescription": "string",
10 "expenseCategory": {
11 "id": 0,
12 "displayId": "string",
13 "name": "string"
14 },
15 "totalNetAmount": 0,
16 "totalTaxAmount": 0,
17 "reservedNetAmount": 0,
18 "reservedTaxAmount": 0,
19 "remainingTotalAmount": 0,
20 "remainingNetAmount": 0,
21 "remainingTaxAmount": 0,
22 "allowsSystemGenerateNewId": true,
23 "numberRangeIdentifierValue": "string",
24 "numberRangeIdentifierType": {
25 "name": "string"
26 },
27 "numberRangeType": {
28 "name": "string"
29 }
30 }
31]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing the balance details of an invoice line item, including associated financial metrics and status, essential for accurate billing and financial reconciliation.] |
|
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» displayId |
string |
false |
none |
Unique identifier for the display |
» invoiceId |
integer(int64) |
false |
none |
Unique identifier for the invoice |
» invoiceDisplayId |
string |
false |
none |
Unique identifier for the invoice display |
» invoiceLineItemId |
integer(int64) |
false |
none |
Unique identifier for the invoice line item |
» invoiceLineItemDisplayId |
string |
false |
none |
Unique identifier for the invoice line item display |
» invoiceLineItemDescription |
string |
false |
none |
Description of the invoice line item |
» expenseCategory |
false |
none |
Data transfer object representing the foundational identifier for an expense category, facilitating the categorization and management of financial expenditures within the enterprise. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» name |
string |
true |
none |
Name of the resource |
» totalNetAmount |
number |
false |
none |
Amount of total net |
» totalTaxAmount |
number |
false |
none |
Amount of total tax |
» reservedNetAmount |
number |
false |
none |
Amount of reserved net |
» reservedTaxAmount |
number |
false |
none |
Amount of reserved tax |
» remainingTotalAmount |
number |
false |
none |
Amount of remaining total |
» remainingNetAmount |
number |
false |
none |
Amount of remaining net |
» remainingTaxAmount |
number |
false |
none |
Amount of remaining tax |
» allowsSystemGenerateNewId |
boolean |
false |
none |
Unique identifier for the allows system generate new |
» numberRangeIdentifierValue |
string |
false |
none |
Represents a unique value for identifying a range of numbers associated with the invoice line item balance. |
» numberRangeIdentifierType |
false |
none |
Data transfer object representing a numerical range identifier used for categorizing and validating data entries within business processes, ensuring consistency and accuracy in data management. |
|
»» name |
string |
false |
none |
Name of the resource |
» numberRangeType |
false |
none |
Data structure representing a numerical range, utilized for defining limits or thresholds within business processes, ensuring precise data validation and operational efficiency. |
|
»» name |
string |
true |
none |
Name of the resource |