Vendor General Ledger Determination¶
Vendor General Ledger Determination - Get¶
HTTP Request
GET /api/v1/vendor-general-ledger-determinations/{id}
📋 Description: Fetches the general ledger determination for a specified vendor, providing insights into the financial organization structure and hierarchy of the associated financial entity.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "status": "CREATED",
17 "displayId": "string",
18 "erpSystemId": 0,
19 "erpSystemDisplayId": "string",
20 "companyId": 0,
21 "companyDisplayId": "string",
22 "countryDisplayId": "string",
23 "companyName": "string",
24 "partnerId": 0,
25 "partnerDisplayId": "string",
26 "partnerName": "string",
27 "generalLedgerPayableAccountId": 0,
28 "generalLedgerPayableAccountDisplayId": "string",
29 "generalLedgerPayableAccountShortName": "string",
30 "vendorPayableClearingAccountId": 0,
31 "vendorPayableClearingAccountDisplayId": "string",
32 "vendorPayableClearingAccountShortName": "string",
33 "generalLedgerReceivableAccountId": 0,
34 "generalLedgerReceivableAccountDisplayId": "string",
35 "generalLedgerReceivableAccountShortName": "string",
36 "vendorReceivableClearingAccountId": 0,
37 "vendorReceivableClearingAccountDisplayId": "string",
38 "vendorReceivableClearingAccountShortName": "string",
39 "generalLedgerPayableAccountSpreadingId": 0,
40 "generalLedgerPayableAccountSpreadingDisplayId": "string",
41 "generalLedgerPayableAccountSpreadingShortName": "string"
42 }
43}
Vendor General Ledger Determination - Update¶
HTTP Request
PUT /api/v1/vendor-general-ledger-determinations/{id}
📋 Description: Updates the financial determination settings for a specified vendor within the organization’s general ledger structure, ensuring alignment with the financial hierarchy and entity requirements.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the updated financial ledger determination data, including organization hierarchy and structure details for the specified financial entity. |
Body Parameters
1{
2 "id": 0,
3 "status": "CREATED",
4 "displayId": "string",
5 "erpSystemId": 0,
6 "erpSystemDisplayId": "string",
7 "companyId": 0,
8 "companyDisplayId": "string",
9 "countryDisplayId": "string",
10 "companyName": "string",
11 "partnerId": 0,
12 "partnerDisplayId": "string",
13 "partnerName": "string",
14 "generalLedgerPayableAccountId": 0,
15 "generalLedgerPayableAccountDisplayId": "string",
16 "generalLedgerPayableAccountShortName": "string",
17 "vendorPayableClearingAccountId": 0,
18 "vendorPayableClearingAccountDisplayId": "string",
19 "vendorPayableClearingAccountShortName": "string",
20 "generalLedgerReceivableAccountId": 0,
21 "generalLedgerReceivableAccountDisplayId": "string",
22 "generalLedgerReceivableAccountShortName": "string",
23 "vendorReceivableClearingAccountId": 0,
24 "vendorReceivableClearingAccountDisplayId": "string",
25 "vendorReceivableClearingAccountShortName": "string",
26 "generalLedgerPayableAccountSpreadingId": 0,
27 "generalLedgerPayableAccountSpreadingDisplayId": "string",
28 "generalLedgerPayableAccountSpreadingShortName": "string"
29}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "status": "CREATED",
17 "displayId": "string",
18 "erpSystemId": 0,
19 "erpSystemDisplayId": "string",
20 "companyId": 0,
21 "companyDisplayId": "string",
22 "countryDisplayId": "string",
23 "companyName": "string",
24 "partnerId": 0,
25 "partnerDisplayId": "string",
26 "partnerName": "string",
27 "generalLedgerPayableAccountId": 0,
28 "generalLedgerPayableAccountDisplayId": "string",
29 "generalLedgerPayableAccountShortName": "string",
30 "vendorPayableClearingAccountId": 0,
31 "vendorPayableClearingAccountDisplayId": "string",
32 "vendorPayableClearingAccountShortName": "string",
33 "generalLedgerReceivableAccountId": 0,
34 "generalLedgerReceivableAccountDisplayId": "string",
35 "generalLedgerReceivableAccountShortName": "string",
36 "vendorReceivableClearingAccountId": 0,
37 "vendorReceivableClearingAccountDisplayId": "string",
38 "vendorReceivableClearingAccountShortName": "string",
39 "generalLedgerPayableAccountSpreadingId": 0,
40 "generalLedgerPayableAccountSpreadingDisplayId": "string",
41 "generalLedgerPayableAccountSpreadingShortName": "string"
42 }
43}
Vendor General Ledger Determination - Delete¶
HTTP Request
DELETE /api/v1/vendor-general-ledger-determinations/{id}
📋 Description: Deletes a specific vendor general ledger determination identified by the provided ID, thereby maintaining the integrity of the financial organization structure and hierarchy within the financial entity.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {}
15}
Vendor General Ledger Determination - Delete Or Decommission¶
HTTP Request
PUT /api/v1/vendor-general-ledger-determinations/remove/{id}
📋 Description: Removes a specified vendor general ledger determination from the financial organization structure, ensuring the integrity of the hierarchy within the financial entity. This operation is essential for maintaining accurate organizational records and compliance.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {}
15}
Vendor General Ledger Determination - Delete Or Decommission All¶
HTTP Request
PUT /api/v1/vendor-general-ledger-determinations/remove/bulk
📋 Description: Removes multiple vendor general ledger determinations in bulk, streamlining the management of financial entity structures within the organization’s hierarchy.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
array[integer] |
true |
Request body containing a list of financial entity identifiers for bulk removal from the vendor general ledger determinations within the organizational structure. |
Body Parameters
1[
2 0
3]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {}
15}
Vendor General Ledger Determination - Decommission¶
HTTP Request
PUT /api/v1/vendor-general-ledger-determinations/decommission/{id}
📋 Description: Decommissions a specified vendor general ledger determination, effectively removing it from the financial organization structure and hierarchy. This operation ensures that outdated or unnecessary financial entities are no longer active within the system.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "status": "CREATED",
17 "displayId": "string",
18 "erpSystemId": 0,
19 "erpSystemDisplayId": "string",
20 "companyId": 0,
21 "companyDisplayId": "string",
22 "countryDisplayId": "string",
23 "companyName": "string",
24 "partnerId": 0,
25 "partnerDisplayId": "string",
26 "partnerName": "string",
27 "generalLedgerPayableAccountId": 0,
28 "generalLedgerPayableAccountDisplayId": "string",
29 "generalLedgerPayableAccountShortName": "string",
30 "vendorPayableClearingAccountId": 0,
31 "vendorPayableClearingAccountDisplayId": "string",
32 "vendorPayableClearingAccountShortName": "string",
33 "generalLedgerReceivableAccountId": 0,
34 "generalLedgerReceivableAccountDisplayId": "string",
35 "generalLedgerReceivableAccountShortName": "string",
36 "vendorReceivableClearingAccountId": 0,
37 "vendorReceivableClearingAccountDisplayId": "string",
38 "vendorReceivableClearingAccountShortName": "string",
39 "generalLedgerPayableAccountSpreadingId": 0,
40 "generalLedgerPayableAccountSpreadingDisplayId": "string",
41 "generalLedgerPayableAccountSpreadingShortName": "string"
42 }
43}
Vendor General Ledger Determination - Decommission By Modification Date Before¶
HTTP Request
PUT /api/v1/vendor-general-ledger-determinations/decommission/modified-before/{modified_before}
📋 Description: Decommissions financial entity records in the vendor general ledger that were modified before the specified date, ensuring the organization’s financial structure remains current and compliant. This operation supports maintaining an accurate hierarchy within the financial organization structure.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
modified_before |
path |
string(date-time) |
true |
Specifies the cutoff date for decommissioning vendor general ledger determinations, ensuring that only records modified before this date are processed within the financial organization structure. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": [
15 {
16 "id": 0,
17 "status": "CREATED",
18 "displayId": "string",
19 "erpSystemId": 0,
20 "erpSystemDisplayId": "string",
21 "companyId": 0,
22 "companyDisplayId": "string",
23 "countryDisplayId": "string",
24 "companyName": "string",
25 "partnerId": 0,
26 "partnerDisplayId": "string",
27 "partnerName": "string",
28 "generalLedgerPayableAccountId": 0,
29 "generalLedgerPayableAccountDisplayId": "string",
30 "generalLedgerPayableAccountShortName": "string",
31 "vendorPayableClearingAccountId": 0,
32 "vendorPayableClearingAccountDisplayId": "string",
33 "vendorPayableClearingAccountShortName": "string",
34 "generalLedgerReceivableAccountId": 0,
35 "generalLedgerReceivableAccountDisplayId": "string",
36 "generalLedgerReceivableAccountShortName": "string",
37 "vendorReceivableClearingAccountId": 0,
38 "vendorReceivableClearingAccountDisplayId": "string",
39 "vendorReceivableClearingAccountShortName": "string",
40 "generalLedgerPayableAccountSpreadingId": 0,
41 "generalLedgerPayableAccountSpreadingDisplayId": "string",
42 "generalLedgerPayableAccountSpreadingShortName": "string"
43 }
44 ]
45}
Vendor General Ledger Determination - Decommission Before Now¶
HTTP Request
PUT /api/v1/vendor-general-ledger-determinations/decommission/modified-before-now
📋 Description: Decommissions vendor general ledger determinations that were modified before the current timestamp, ensuring the financial organization structure remains accurate and up-to-date. This operation supports the maintenance of a clean and efficient hierarchy within the financial entity.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": [
15 {
16 "id": 0,
17 "status": "CREATED",
18 "displayId": "string",
19 "erpSystemId": 0,
20 "erpSystemDisplayId": "string",
21 "companyId": 0,
22 "companyDisplayId": "string",
23 "countryDisplayId": "string",
24 "companyName": "string",
25 "partnerId": 0,
26 "partnerDisplayId": "string",
27 "partnerName": "string",
28 "generalLedgerPayableAccountId": 0,
29 "generalLedgerPayableAccountDisplayId": "string",
30 "generalLedgerPayableAccountShortName": "string",
31 "vendorPayableClearingAccountId": 0,
32 "vendorPayableClearingAccountDisplayId": "string",
33 "vendorPayableClearingAccountShortName": "string",
34 "generalLedgerReceivableAccountId": 0,
35 "generalLedgerReceivableAccountDisplayId": "string",
36 "generalLedgerReceivableAccountShortName": "string",
37 "vendorReceivableClearingAccountId": 0,
38 "vendorReceivableClearingAccountDisplayId": "string",
39 "vendorReceivableClearingAccountShortName": "string",
40 "generalLedgerPayableAccountSpreadingId": 0,
41 "generalLedgerPayableAccountSpreadingDisplayId": "string",
42 "generalLedgerPayableAccountSpreadingShortName": "string"
43 }
44 ]
45}
Vendor General Ledger Determination - Decommission All¶
HTTP Request
PUT /api/v1/vendor-general-ledger-determinations/decommission/bulk
📋 Description: Decommissions multiple vendor general ledger determinations in bulk, facilitating the management of financial entity structures within the organization’s hierarchy.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
array[integer] |
true |
Request body containing a list of financial entity identifiers and their corresponding decommissioning details for bulk processing within the organizational structure. |
Body Parameters
1[
2 0
3]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": [
15 {
16 "id": 0,
17 "status": "CREATED",
18 "displayId": "string",
19 "erpSystemId": 0,
20 "erpSystemDisplayId": "string",
21 "companyId": 0,
22 "companyDisplayId": "string",
23 "countryDisplayId": "string",
24 "companyName": "string",
25 "partnerId": 0,
26 "partnerDisplayId": "string",
27 "partnerName": "string",
28 "generalLedgerPayableAccountId": 0,
29 "generalLedgerPayableAccountDisplayId": "string",
30 "generalLedgerPayableAccountShortName": "string",
31 "vendorPayableClearingAccountId": 0,
32 "vendorPayableClearingAccountDisplayId": "string",
33 "vendorPayableClearingAccountShortName": "string",
34 "generalLedgerReceivableAccountId": 0,
35 "generalLedgerReceivableAccountDisplayId": "string",
36 "generalLedgerReceivableAccountShortName": "string",
37 "vendorReceivableClearingAccountId": 0,
38 "vendorReceivableClearingAccountDisplayId": "string",
39 "vendorReceivableClearingAccountShortName": "string",
40 "generalLedgerPayableAccountSpreadingId": 0,
41 "generalLedgerPayableAccountSpreadingDisplayId": "string",
42 "generalLedgerPayableAccountSpreadingShortName": "string"
43 }
44 ]
45}
Vendor General Ledger Determination - Create Or Update Bulk¶
HTTP Request
PUT /api/v1/vendor-general-ledger-determinations/createOrUpdate/bulk
📋 Description: Creates or updates multiple vendor general ledger determinations in bulk, facilitating efficient management of financial entities within the organizational structure and hierarchy.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing bulk data for creating or updating financial entity general ledger determinations, including organization hierarchy and structural attributes. |
Body Parameters
1[
2 {
3 "id": 0,
4 "status": "CREATED",
5 "displayId": "string",
6 "erpSystemId": 0,
7 "erpSystemDisplayId": "string",
8 "companyId": 0,
9 "companyDisplayId": "string",
10 "countryDisplayId": "string",
11 "companyName": "string",
12 "partnerId": 0,
13 "partnerDisplayId": "string",
14 "partnerName": "string",
15 "generalLedgerPayableAccountId": 0,
16 "generalLedgerPayableAccountDisplayId": "string",
17 "generalLedgerPayableAccountShortName": "string",
18 "vendorPayableClearingAccountId": 0,
19 "vendorPayableClearingAccountDisplayId": "string",
20 "vendorPayableClearingAccountShortName": "string",
21 "generalLedgerReceivableAccountId": 0,
22 "generalLedgerReceivableAccountDisplayId": "string",
23 "generalLedgerReceivableAccountShortName": "string",
24 "vendorReceivableClearingAccountId": 0,
25 "vendorReceivableClearingAccountDisplayId": "string",
26 "vendorReceivableClearingAccountShortName": "string",
27 "generalLedgerPayableAccountSpreadingId": 0,
28 "generalLedgerPayableAccountSpreadingDisplayId": "string",
29 "generalLedgerPayableAccountSpreadingShortName": "string"
30 }
31]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": [
15 {
16 "id": 0,
17 "status": "CREATED",
18 "displayId": "string",
19 "erpSystemId": 0,
20 "erpSystemDisplayId": "string",
21 "companyId": 0,
22 "companyDisplayId": "string",
23 "countryDisplayId": "string",
24 "companyName": "string",
25 "partnerId": 0,
26 "partnerDisplayId": "string",
27 "partnerName": "string",
28 "generalLedgerPayableAccountId": 0,
29 "generalLedgerPayableAccountDisplayId": "string",
30 "generalLedgerPayableAccountShortName": "string",
31 "vendorPayableClearingAccountId": 0,
32 "vendorPayableClearingAccountDisplayId": "string",
33 "vendorPayableClearingAccountShortName": "string",
34 "generalLedgerReceivableAccountId": 0,
35 "generalLedgerReceivableAccountDisplayId": "string",
36 "generalLedgerReceivableAccountShortName": "string",
37 "vendorReceivableClearingAccountId": 0,
38 "vendorReceivableClearingAccountDisplayId": "string",
39 "vendorReceivableClearingAccountShortName": "string",
40 "generalLedgerPayableAccountSpreadingId": 0,
41 "generalLedgerPayableAccountSpreadingDisplayId": "string",
42 "generalLedgerPayableAccountSpreadingShortName": "string"
43 }
44 ]
45}
Vendor General Ledger Determination - Create Or Update¶
HTTP Request
PUT /api/v1/vendor-general-ledger-determinations/createOrUpdate
📋 Description: Updates or creates vendor general ledger determinations within the financial organization structure, ensuring accurate alignment with the organization’s hierarchy and financial entity requirements.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the financial entity’s general ledger determination data, including organization hierarchy details and relevant attributes for accurate structure management. |
Body Parameters
1{
2 "id": 0,
3 "status": "CREATED",
4 "displayId": "string",
5 "erpSystemId": 0,
6 "erpSystemDisplayId": "string",
7 "companyId": 0,
8 "companyDisplayId": "string",
9 "countryDisplayId": "string",
10 "companyName": "string",
11 "partnerId": 0,
12 "partnerDisplayId": "string",
13 "partnerName": "string",
14 "generalLedgerPayableAccountId": 0,
15 "generalLedgerPayableAccountDisplayId": "string",
16 "generalLedgerPayableAccountShortName": "string",
17 "vendorPayableClearingAccountId": 0,
18 "vendorPayableClearingAccountDisplayId": "string",
19 "vendorPayableClearingAccountShortName": "string",
20 "generalLedgerReceivableAccountId": 0,
21 "generalLedgerReceivableAccountDisplayId": "string",
22 "generalLedgerReceivableAccountShortName": "string",
23 "vendorReceivableClearingAccountId": 0,
24 "vendorReceivableClearingAccountDisplayId": "string",
25 "vendorReceivableClearingAccountShortName": "string",
26 "generalLedgerPayableAccountSpreadingId": 0,
27 "generalLedgerPayableAccountSpreadingDisplayId": "string",
28 "generalLedgerPayableAccountSpreadingShortName": "string"
29}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "status": "CREATED",
17 "displayId": "string",
18 "erpSystemId": 0,
19 "erpSystemDisplayId": "string",
20 "companyId": 0,
21 "companyDisplayId": "string",
22 "countryDisplayId": "string",
23 "companyName": "string",
24 "partnerId": 0,
25 "partnerDisplayId": "string",
26 "partnerName": "string",
27 "generalLedgerPayableAccountId": 0,
28 "generalLedgerPayableAccountDisplayId": "string",
29 "generalLedgerPayableAccountShortName": "string",
30 "vendorPayableClearingAccountId": 0,
31 "vendorPayableClearingAccountDisplayId": "string",
32 "vendorPayableClearingAccountShortName": "string",
33 "generalLedgerReceivableAccountId": 0,
34 "generalLedgerReceivableAccountDisplayId": "string",
35 "generalLedgerReceivableAccountShortName": "string",
36 "vendorReceivableClearingAccountId": 0,
37 "vendorReceivableClearingAccountDisplayId": "string",
38 "vendorReceivableClearingAccountShortName": "string",
39 "generalLedgerPayableAccountSpreadingId": 0,
40 "generalLedgerPayableAccountSpreadingDisplayId": "string",
41 "generalLedgerPayableAccountSpreadingShortName": "string"
42 }
43}
Vendor General Ledger Determination - Bulk Update¶
HTTP Request
PUT /api/v1/vendor-general-ledger-determinations/bulk
📋 Description: Updates multiple vendor general ledger determinations in bulk, enabling efficient management of financial entity structures within the organization’s hierarchy.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing bulk updates for financial entity general ledger determinations, including organizational structure and hierarchy details. |
Body Parameters
1[
2 {
3 "id": 0,
4 "status": "CREATED",
5 "displayId": "string",
6 "erpSystemId": 0,
7 "erpSystemDisplayId": "string",
8 "companyId": 0,
9 "companyDisplayId": "string",
10 "countryDisplayId": "string",
11 "companyName": "string",
12 "partnerId": 0,
13 "partnerDisplayId": "string",
14 "partnerName": "string",
15 "generalLedgerPayableAccountId": 0,
16 "generalLedgerPayableAccountDisplayId": "string",
17 "generalLedgerPayableAccountShortName": "string",
18 "vendorPayableClearingAccountId": 0,
19 "vendorPayableClearingAccountDisplayId": "string",
20 "vendorPayableClearingAccountShortName": "string",
21 "generalLedgerReceivableAccountId": 0,
22 "generalLedgerReceivableAccountDisplayId": "string",
23 "generalLedgerReceivableAccountShortName": "string",
24 "vendorReceivableClearingAccountId": 0,
25 "vendorReceivableClearingAccountDisplayId": "string",
26 "vendorReceivableClearingAccountShortName": "string",
27 "generalLedgerPayableAccountSpreadingId": 0,
28 "generalLedgerPayableAccountSpreadingDisplayId": "string",
29 "generalLedgerPayableAccountSpreadingShortName": "string"
30 }
31]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": [
15 {
16 "id": 0,
17 "status": "CREATED",
18 "displayId": "string",
19 "erpSystemId": 0,
20 "erpSystemDisplayId": "string",
21 "companyId": 0,
22 "companyDisplayId": "string",
23 "countryDisplayId": "string",
24 "companyName": "string",
25 "partnerId": 0,
26 "partnerDisplayId": "string",
27 "partnerName": "string",
28 "generalLedgerPayableAccountId": 0,
29 "generalLedgerPayableAccountDisplayId": "string",
30 "generalLedgerPayableAccountShortName": "string",
31 "vendorPayableClearingAccountId": 0,
32 "vendorPayableClearingAccountDisplayId": "string",
33 "vendorPayableClearingAccountShortName": "string",
34 "generalLedgerReceivableAccountId": 0,
35 "generalLedgerReceivableAccountDisplayId": "string",
36 "generalLedgerReceivableAccountShortName": "string",
37 "vendorReceivableClearingAccountId": 0,
38 "vendorReceivableClearingAccountDisplayId": "string",
39 "vendorReceivableClearingAccountShortName": "string",
40 "generalLedgerPayableAccountSpreadingId": 0,
41 "generalLedgerPayableAccountSpreadingDisplayId": "string",
42 "generalLedgerPayableAccountSpreadingShortName": "string"
43 }
44 ]
45}
Vendor General Ledger Determination - Bulk Create¶
HTTP Request
POST /api/v1/vendor-general-ledger-determinations/bulk
📋 Description: Submits bulk vendor general ledger determinations to establish financial entity hierarchies within the organizational structure, enhancing the accuracy and efficiency of financial reporting.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing a collection of financial entity determination records, structured to support bulk updates within the organization’s financial hierarchy. |
Body Parameters
1[
2 {
3 "id": 0,
4 "status": "CREATED",
5 "displayId": "string",
6 "erpSystemId": 0,
7 "erpSystemDisplayId": "string",
8 "companyId": 0,
9 "companyDisplayId": "string",
10 "countryDisplayId": "string",
11 "companyName": "string",
12 "partnerId": 0,
13 "partnerDisplayId": "string",
14 "partnerName": "string",
15 "generalLedgerPayableAccountId": 0,
16 "generalLedgerPayableAccountDisplayId": "string",
17 "generalLedgerPayableAccountShortName": "string",
18 "vendorPayableClearingAccountId": 0,
19 "vendorPayableClearingAccountDisplayId": "string",
20 "vendorPayableClearingAccountShortName": "string",
21 "generalLedgerReceivableAccountId": 0,
22 "generalLedgerReceivableAccountDisplayId": "string",
23 "generalLedgerReceivableAccountShortName": "string",
24 "vendorReceivableClearingAccountId": 0,
25 "vendorReceivableClearingAccountDisplayId": "string",
26 "vendorReceivableClearingAccountShortName": "string",
27 "generalLedgerPayableAccountSpreadingId": 0,
28 "generalLedgerPayableAccountSpreadingDisplayId": "string",
29 "generalLedgerPayableAccountSpreadingShortName": "string"
30 }
31]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": [
15 {
16 "id": 0,
17 "status": "CREATED",
18 "displayId": "string",
19 "erpSystemId": 0,
20 "erpSystemDisplayId": "string",
21 "companyId": 0,
22 "companyDisplayId": "string",
23 "countryDisplayId": "string",
24 "companyName": "string",
25 "partnerId": 0,
26 "partnerDisplayId": "string",
27 "partnerName": "string",
28 "generalLedgerPayableAccountId": 0,
29 "generalLedgerPayableAccountDisplayId": "string",
30 "generalLedgerPayableAccountShortName": "string",
31 "vendorPayableClearingAccountId": 0,
32 "vendorPayableClearingAccountDisplayId": "string",
33 "vendorPayableClearingAccountShortName": "string",
34 "generalLedgerReceivableAccountId": 0,
35 "generalLedgerReceivableAccountDisplayId": "string",
36 "generalLedgerReceivableAccountShortName": "string",
37 "vendorReceivableClearingAccountId": 0,
38 "vendorReceivableClearingAccountDisplayId": "string",
39 "vendorReceivableClearingAccountShortName": "string",
40 "generalLedgerPayableAccountSpreadingId": 0,
41 "generalLedgerPayableAccountSpreadingDisplayId": "string",
42 "generalLedgerPayableAccountSpreadingShortName": "string"
43 }
44 ]
45}
Vendor General Ledger Determination - Bulk Delete¶
HTTP Request
DELETE /api/v1/vendor-general-ledger-determinations/bulk
📋 Description: Deletes multiple vendor general ledger determinations in bulk, allowing for efficient management of financial entities within the organizational structure and hierarchy.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
array[integer] |
true |
Request body containing a list of financial entity identifiers for bulk deletion of vendor general ledger determinations within the organizational structure. |
Body Parameters
1[
2 0
3]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {}
15}
Vendor General Ledger Determination - Search¶
HTTP Request
POST /api/v1/vendor-general-ledger-determinations/search
📋 Description: Submits a request to search for vendor general ledger determinations within the financial organization structure, allowing users to efficiently navigate and identify relevant financial entities based on organizational hierarchy.
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 financial entity search criteria and hierarchical structure parameters for retrieving vendor general ledger determinations. |
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 "statusEqual": "CREATED",
16 "statusIn": [
17 "CREATED"
18 ],
19 "displayIdIn": [
20 "string"
21 ],
22 "displayIdLike": "string",
23 "erpSystemIdEqual": 0,
24 "erpSystemDisplayIdLike": "string",
25 "companyDisplayIdLike": "string",
26 "partnerDisplayIdLike": "string",
27 "generalLedgerPayableAccountDisplayIdLike": "string",
28 "vendorPayableClearingAccountDisplayIdLike": "string",
29 "generalLedgerReceivableAccountDisplayIdLike": "string",
30 "vendorReceivableClearingAccountDisplayIdLike": "string",
31 "generalLedgerPayableAccountSpreadingDisplayIdLike": "string",
32 "companyIdEqual": 0,
33 "companyIdIn": [
34 0
35 ],
36 "countryDisplayIdLike": "string",
37 "companyNameLike": "string",
38 "partnerIdEqual": 0,
39 "partnerNameLike": "string",
40 "generalLedgerPayableAccountIdEqual": 0,
41 "generalLedgerPayableAccountShortNameLike": "string",
42 "vendorPayableClearingAccountIdEqual": 0,
43 "vendorPayableClearingAccountShortNameLike": "string",
44 "generalLedgerReceivableAccountIdEqual": 0,
45 "generalLedgerReceivableAccountShortNameLike": "string",
46 "vendorReceivableClearingAccountIdEqual": 0,
47 "vendorReceivableClearingAccountShortNameLike": "string",
48 "generalLedgerPayableAccountSpreadingIdEqual": 0,
49 "generalLedgerPayableAccountSpreadingShortNameLike": "string"
50}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalElements": 0,
3 "totalPages": 0,
4 "pageable": {
5 "pageNumber": 0,
6 "paged": true,
7 "pageSize": 0,
8 "unpaged": true,
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 "status": "CREATED",
22 "displayId": "string",
23 "erpSystemId": 0,
24 "erpSystemDisplayId": "string",
25 "companyId": 0,
26 "companyDisplayId": "string",
27 "countryDisplayId": "string",
28 "companyName": "string",
29 "partnerId": 0,
30 "partnerDisplayId": "string",
31 "partnerName": "string",
32 "generalLedgerPayableAccountId": 0,
33 "generalLedgerPayableAccountDisplayId": "string",
34 "generalLedgerPayableAccountShortName": "string",
35 "vendorPayableClearingAccountId": 0,
36 "vendorPayableClearingAccountDisplayId": "string",
37 "vendorPayableClearingAccountShortName": "string",
38 "generalLedgerReceivableAccountId": 0,
39 "generalLedgerReceivableAccountDisplayId": "string",
40 "generalLedgerReceivableAccountShortName": "string",
41 "vendorReceivableClearingAccountId": 0,
42 "vendorReceivableClearingAccountDisplayId": "string",
43 "vendorReceivableClearingAccountShortName": "string",
44 "generalLedgerPayableAccountSpreadingId": 0,
45 "generalLedgerPayableAccountSpreadingDisplayId": "string",
46 "generalLedgerPayableAccountSpreadingShortName": "string"
47 }
48 ],
49 "number": 0,
50 "sort": {
51 "unsorted": true,
52 "sorted": true,
53 "empty": true
54 },
55 "first": true,
56 "last": true,
57 "empty": true
58}
Vendor General Ledger Determination - Find All¶
HTTP Request
GET /api/v1/vendor-general-ledger-determinations
📋 Description: Retrieves vendor general ledger determinations, providing insights into the financial organization structure and hierarchy of financial entities.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the results of the financial entity’s general ledger determinations should be returned in a paginated format, facilitating efficient data retrieval within the organizational structure. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalElements": 0,
3 "totalPages": 0,
4 "pageable": {
5 "pageNumber": 0,
6 "paged": true,
7 "pageSize": 0,
8 "unpaged": true,
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 "status": "CREATED",
22 "displayId": "string",
23 "erpSystemId": 0,
24 "erpSystemDisplayId": "string",
25 "companyId": 0,
26 "companyDisplayId": "string",
27 "countryDisplayId": "string",
28 "companyName": "string",
29 "partnerId": 0,
30 "partnerDisplayId": "string",
31 "partnerName": "string",
32 "generalLedgerPayableAccountId": 0,
33 "generalLedgerPayableAccountDisplayId": "string",
34 "generalLedgerPayableAccountShortName": "string",
35 "vendorPayableClearingAccountId": 0,
36 "vendorPayableClearingAccountDisplayId": "string",
37 "vendorPayableClearingAccountShortName": "string",
38 "generalLedgerReceivableAccountId": 0,
39 "generalLedgerReceivableAccountDisplayId": "string",
40 "generalLedgerReceivableAccountShortName": "string",
41 "vendorReceivableClearingAccountId": 0,
42 "vendorReceivableClearingAccountDisplayId": "string",
43 "vendorReceivableClearingAccountShortName": "string",
44 "generalLedgerPayableAccountSpreadingId": 0,
45 "generalLedgerPayableAccountSpreadingDisplayId": "string",
46 "generalLedgerPayableAccountSpreadingShortName": "string"
47 }
48 ],
49 "number": 0,
50 "sort": {
51 "unsorted": true,
52 "sorted": true,
53 "empty": true
54 },
55 "first": true,
56 "last": true,
57 "empty": true
58}
Vendor General Ledger Determination - Create¶
HTTP Request
POST /api/v1/vendor-general-ledger-determinations
📋 Description: Creates new vendor general ledger determinations within the financial organization structure, enabling the establishment of hierarchical relationships and classifications for financial entities.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the financial entity’s general ledger determination data, including organizational structure and hierarchy details. |
Body Parameters
1{
2 "id": 0,
3 "status": "CREATED",
4 "displayId": "string",
5 "erpSystemId": 0,
6 "erpSystemDisplayId": "string",
7 "companyId": 0,
8 "companyDisplayId": "string",
9 "countryDisplayId": "string",
10 "companyName": "string",
11 "partnerId": 0,
12 "partnerDisplayId": "string",
13 "partnerName": "string",
14 "generalLedgerPayableAccountId": 0,
15 "generalLedgerPayableAccountDisplayId": "string",
16 "generalLedgerPayableAccountShortName": "string",
17 "vendorPayableClearingAccountId": 0,
18 "vendorPayableClearingAccountDisplayId": "string",
19 "vendorPayableClearingAccountShortName": "string",
20 "generalLedgerReceivableAccountId": 0,
21 "generalLedgerReceivableAccountDisplayId": "string",
22 "generalLedgerReceivableAccountShortName": "string",
23 "vendorReceivableClearingAccountId": 0,
24 "vendorReceivableClearingAccountDisplayId": "string",
25 "vendorReceivableClearingAccountShortName": "string",
26 "generalLedgerPayableAccountSpreadingId": 0,
27 "generalLedgerPayableAccountSpreadingDisplayId": "string",
28 "generalLedgerPayableAccountSpreadingShortName": "string"
29}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "status": "CREATED",
17 "displayId": "string",
18 "erpSystemId": 0,
19 "erpSystemDisplayId": "string",
20 "companyId": 0,
21 "companyDisplayId": "string",
22 "countryDisplayId": "string",
23 "companyName": "string",
24 "partnerId": 0,
25 "partnerDisplayId": "string",
26 "partnerName": "string",
27 "generalLedgerPayableAccountId": 0,
28 "generalLedgerPayableAccountDisplayId": "string",
29 "generalLedgerPayableAccountShortName": "string",
30 "vendorPayableClearingAccountId": 0,
31 "vendorPayableClearingAccountDisplayId": "string",
32 "vendorPayableClearingAccountShortName": "string",
33 "generalLedgerReceivableAccountId": 0,
34 "generalLedgerReceivableAccountDisplayId": "string",
35 "generalLedgerReceivableAccountShortName": "string",
36 "vendorReceivableClearingAccountId": 0,
37 "vendorReceivableClearingAccountDisplayId": "string",
38 "vendorReceivableClearingAccountShortName": "string",
39 "generalLedgerPayableAccountSpreadingId": 0,
40 "generalLedgerPayableAccountSpreadingDisplayId": "string",
41 "generalLedgerPayableAccountSpreadingShortName": "string"
42 }
43}
Vendor General Ledger Determination - Get Metadata¶
HTTP Request
GET /api/v1/vendor-general-ledger-determinations/meta
📋 Description: Retrieves metadata related to vendor general ledger determinations within the financial organization structure, providing insights into the hierarchy and organization of financial entities.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 "PARTNER"
3]