Vendor Request¶
Get A Resource By ID¶
HTTP Request
GET /api/v1/vendor-request/{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 "state": "INV_DRAFT",
18 "vendorId": 0,
19 "vendorDisplayId": "string",
20 "vendorName": "string",
21 "vendorPhone": "string",
22 "vendorFax": "string",
23 "erpSystem": {
24 "id": 0,
25 "displayId": "string",
26 "status": "CREATED",
27 "name": "string",
28 "type": "NAKISA",
29 "sapVersion": "ECC_EHP5"
30 },
31 "vendorParent": {
32 "id": 0,
33 "displayId": "string",
34 "status": "CREATED",
35 "name": "string",
36 "erpSystemDisplayId": "string"
37 },
38 "operation": "VENDOR_CREATE",
39 "operationReason": "string",
40 "companies": [
41 {
42 "id": 0,
43 "displayId": "string",
44 "changeType": "ADD",
45 "vendorRequestId": 0,
46 "vendorRequestDisplayId": "string",
47 "company": {
48 "id": 0,
49 "displayId": "string",
50 "status": "CREATED",
51 "erpSystemId": 0,
52 "erpSystemDisplayId": "string",
53 "countryId": 0,
54 "countryDisplayId": "string",
55 "name": "string",
56 "postingPeriodVariantId": 0,
57 "fiscalVariantId": 0
58 },
59 "allowsSystemGenerateNewId": true,
60 "numberRangeIdentifierValue": "string",
61 "numberRangeIdentifierType": {
62 "name": "string"
63 },
64 "numberRangeType": {
65 "name": "string"
66 }
67 }
68 ],
69 "companiesTotal": 0,
70 "partnerRoles": [
71 {
72 "id": 0,
73 "displayId": "string",
74 "changeType": "ADD",
75 "vendorRequestId": 0,
76 "vendorRequestDisplayId": "string",
77 "partnerRole": {
78 "id": 0,
79 "displayId": "string",
80 "status": "CREATED",
81 "name": "string"
82 },
83 "allowsSystemGenerateNewId": true,
84 "numberRangeIdentifierValue": "string",
85 "numberRangeIdentifierType": {
86 "name": "string"
87 },
88 "numberRangeType": {
89 "name": "string"
90 }
91 }
92 ],
93 "partnerRolesTotal": 0,
94 "partnerContacts": [
95 {
96 "id": 0,
97 "displayId": "string",
98 "changeType": "ADD",
99 "vendorRequestId": 0,
100 "vendorRequestDisplayId": "string",
101 "createdPartnerContactDisplayId": "string",
102 "name": "string",
103 "email": "string",
104 "phone": "string",
105 "position": "string",
106 "address": "string",
107 "group": "string",
108 "buildingName": "string",
109 "fax": "string",
110 "erpSystem": {
111 "id": 0,
112 "displayId": "string",
113 "status": "CREATED",
114 "name": "string",
115 "type": "NAKISA",
116 "sapVersion": "ECC_EHP5"
117 },
118 "partnerContact": {
119 "id": 0,
120 "displayId": "string",
121 "status": "CREATED",
122 "name": "string"
123 },
124 "allowsSystemGenerateNewId": true,
125 "numberRangeIdentifierValue": "string",
126 "numberRangeIdentifierType": {
127 "name": "string"
128 },
129 "numberRangeType": {
130 "name": "string"
131 }
132 }
133 ],
134 "partnerContactsTotal": 0,
135 "allowsSystemGenerateNewId": true,
136 "numberRangeIdentifierValue": "string",
137 "numberRangeIdentifierType": {
138 "name": "string"
139 },
140 "numberRangeType": {
141 "name": "string"
142 }
143 }
144}
Update A Resource¶
HTTP Request
PUT /api/v1/vendor-request/{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 vendor request details, including status, contact information, and any relevant documentation. |
Body Parameters
1{
2 "id": 0,
3 "displayId": "string",
4 "state": "INV_DRAFT",
5 "vendorId": 0,
6 "vendorDisplayId": "string",
7 "vendorName": "string",
8 "vendorPhone": "string",
9 "vendorFax": "string",
10 "erpSystem": {
11 "id": 0,
12 "displayId": "string",
13 "status": "CREATED",
14 "name": "string",
15 "type": "NAKISA",
16 "sapVersion": "ECC_EHP5"
17 },
18 "vendorParent": {
19 "id": 0,
20 "displayId": "string",
21 "status": "CREATED",
22 "name": "string",
23 "erpSystemDisplayId": "string"
24 },
25 "operation": "VENDOR_CREATE",
26 "operationReason": "string",
27 "companies": [
28 {
29 "id": 0,
30 "displayId": "string",
31 "changeType": "ADD",
32 "vendorRequestId": 0,
33 "vendorRequestDisplayId": "string",
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 "allowsSystemGenerateNewId": true,
47 "numberRangeIdentifierValue": "string",
48 "numberRangeIdentifierType": {
49 "name": "string"
50 },
51 "numberRangeType": {
52 "name": "string"
53 }
54 }
55 ],
56 "companiesTotal": 0,
57 "partnerRoles": [
58 {
59 "id": 0,
60 "displayId": "string",
61 "changeType": "ADD",
62 "vendorRequestId": 0,
63 "vendorRequestDisplayId": "string",
64 "partnerRole": {
65 "id": 0,
66 "displayId": "string",
67 "status": "CREATED",
68 "name": "string"
69 },
70 "allowsSystemGenerateNewId": true,
71 "numberRangeIdentifierValue": "string",
72 "numberRangeIdentifierType": {
73 "name": "string"
74 },
75 "numberRangeType": {
76 "name": "string"
77 }
78 }
79 ],
80 "partnerRolesTotal": 0,
81 "partnerContacts": [
82 {
83 "id": 0,
84 "displayId": "string",
85 "changeType": "ADD",
86 "vendorRequestId": 0,
87 "vendorRequestDisplayId": "string",
88 "createdPartnerContactDisplayId": "string",
89 "name": "string",
90 "email": "string",
91 "phone": "string",
92 "position": "string",
93 "address": "string",
94 "group": "string",
95 "buildingName": "string",
96 "fax": "string",
97 "erpSystem": {
98 "id": 0,
99 "displayId": "string",
100 "status": "CREATED",
101 "name": "string",
102 "type": "NAKISA",
103 "sapVersion": "ECC_EHP5"
104 },
105 "partnerContact": {
106 "id": 0,
107 "displayId": "string",
108 "status": "CREATED",
109 "name": "string"
110 },
111 "allowsSystemGenerateNewId": true,
112 "numberRangeIdentifierValue": "string",
113 "numberRangeIdentifierType": {
114 "name": "string"
115 },
116 "numberRangeType": {
117 "name": "string"
118 }
119 }
120 ],
121 "partnerContactsTotal": 0,
122 "allowsSystemGenerateNewId": true,
123 "numberRangeIdentifierValue": "string",
124 "numberRangeIdentifierType": {
125 "name": "string"
126 },
127 "numberRangeType": {
128 "name": "string"
129 }
130}
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 "state": "INV_DRAFT",
18 "vendorId": 0,
19 "vendorDisplayId": "string",
20 "vendorName": "string",
21 "vendorPhone": "string",
22 "vendorFax": "string",
23 "erpSystem": {
24 "id": 0,
25 "displayId": "string",
26 "status": "CREATED",
27 "name": "string",
28 "type": "NAKISA",
29 "sapVersion": "ECC_EHP5"
30 },
31 "vendorParent": {
32 "id": 0,
33 "displayId": "string",
34 "status": "CREATED",
35 "name": "string",
36 "erpSystemDisplayId": "string"
37 },
38 "operation": "VENDOR_CREATE",
39 "operationReason": "string",
40 "companies": [
41 {
42 "id": 0,
43 "displayId": "string",
44 "changeType": "ADD",
45 "vendorRequestId": 0,
46 "vendorRequestDisplayId": "string",
47 "company": {
48 "id": 0,
49 "displayId": "string",
50 "status": "CREATED",
51 "erpSystemId": 0,
52 "erpSystemDisplayId": "string",
53 "countryId": 0,
54 "countryDisplayId": "string",
55 "name": "string",
56 "postingPeriodVariantId": 0,
57 "fiscalVariantId": 0
58 },
59 "allowsSystemGenerateNewId": true,
60 "numberRangeIdentifierValue": "string",
61 "numberRangeIdentifierType": {
62 "name": "string"
63 },
64 "numberRangeType": {
65 "name": "string"
66 }
67 }
68 ],
69 "companiesTotal": 0,
70 "partnerRoles": [
71 {
72 "id": 0,
73 "displayId": "string",
74 "changeType": "ADD",
75 "vendorRequestId": 0,
76 "vendorRequestDisplayId": "string",
77 "partnerRole": {
78 "id": 0,
79 "displayId": "string",
80 "status": "CREATED",
81 "name": "string"
82 },
83 "allowsSystemGenerateNewId": true,
84 "numberRangeIdentifierValue": "string",
85 "numberRangeIdentifierType": {
86 "name": "string"
87 },
88 "numberRangeType": {
89 "name": "string"
90 }
91 }
92 ],
93 "partnerRolesTotal": 0,
94 "partnerContacts": [
95 {
96 "id": 0,
97 "displayId": "string",
98 "changeType": "ADD",
99 "vendorRequestId": 0,
100 "vendorRequestDisplayId": "string",
101 "createdPartnerContactDisplayId": "string",
102 "name": "string",
103 "email": "string",
104 "phone": "string",
105 "position": "string",
106 "address": "string",
107 "group": "string",
108 "buildingName": "string",
109 "fax": "string",
110 "erpSystem": {
111 "id": 0,
112 "displayId": "string",
113 "status": "CREATED",
114 "name": "string",
115 "type": "NAKISA",
116 "sapVersion": "ECC_EHP5"
117 },
118 "partnerContact": {
119 "id": 0,
120 "displayId": "string",
121 "status": "CREATED",
122 "name": "string"
123 },
124 "allowsSystemGenerateNewId": true,
125 "numberRangeIdentifierValue": "string",
126 "numberRangeIdentifierType": {
127 "name": "string"
128 },
129 "numberRangeType": {
130 "name": "string"
131 }
132 }
133 ],
134 "partnerContactsTotal": 0,
135 "allowsSystemGenerateNewId": true,
136 "numberRangeIdentifierValue": "string",
137 "numberRangeIdentifierType": {
138 "name": "string"
139 },
140 "numberRangeType": {
141 "name": "string"
142 }
143 }
144}
Delete A Single Resource¶
HTTP Request
DELETE /api/v1/vendor-request/{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/vendor-request/{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 vendor request details, including status, comments, 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 "state": "INV_DRAFT",
18 "vendorId": 0,
19 "vendorDisplayId": "string",
20 "vendorName": "string",
21 "vendorPhone": "string",
22 "vendorFax": "string",
23 "erpSystem": {
24 "id": 0,
25 "displayId": "string",
26 "status": "CREATED",
27 "name": "string",
28 "type": "NAKISA",
29 "sapVersion": "ECC_EHP5"
30 },
31 "vendorParent": {
32 "id": 0,
33 "displayId": "string",
34 "status": "CREATED",
35 "name": "string",
36 "erpSystemDisplayId": "string"
37 },
38 "operation": "VENDOR_CREATE",
39 "operationReason": "string",
40 "companies": [
41 {
42 "id": 0,
43 "displayId": "string",
44 "changeType": "ADD",
45 "vendorRequestId": 0,
46 "vendorRequestDisplayId": "string",
47 "company": {
48 "id": 0,
49 "displayId": "string",
50 "status": "CREATED",
51 "erpSystemId": 0,
52 "erpSystemDisplayId": "string",
53 "countryId": 0,
54 "countryDisplayId": "string",
55 "name": "string",
56 "postingPeriodVariantId": 0,
57 "fiscalVariantId": 0
58 },
59 "allowsSystemGenerateNewId": true,
60 "numberRangeIdentifierValue": "string",
61 "numberRangeIdentifierType": {
62 "name": "string"
63 },
64 "numberRangeType": {
65 "name": "string"
66 }
67 }
68 ],
69 "companiesTotal": 0,
70 "partnerRoles": [
71 {
72 "id": 0,
73 "displayId": "string",
74 "changeType": "ADD",
75 "vendorRequestId": 0,
76 "vendorRequestDisplayId": "string",
77 "partnerRole": {
78 "id": 0,
79 "displayId": "string",
80 "status": "CREATED",
81 "name": "string"
82 },
83 "allowsSystemGenerateNewId": true,
84 "numberRangeIdentifierValue": "string",
85 "numberRangeIdentifierType": {
86 "name": "string"
87 },
88 "numberRangeType": {
89 "name": "string"
90 }
91 }
92 ],
93 "partnerRolesTotal": 0,
94 "partnerContacts": [
95 {
96 "id": 0,
97 "displayId": "string",
98 "changeType": "ADD",
99 "vendorRequestId": 0,
100 "vendorRequestDisplayId": "string",
101 "createdPartnerContactDisplayId": "string",
102 "name": "string",
103 "email": "string",
104 "phone": "string",
105 "position": "string",
106 "address": "string",
107 "group": "string",
108 "buildingName": "string",
109 "fax": "string",
110 "erpSystem": {
111 "id": 0,
112 "displayId": "string",
113 "status": "CREATED",
114 "name": "string",
115 "type": "NAKISA",
116 "sapVersion": "ECC_EHP5"
117 },
118 "partnerContact": {
119 "id": 0,
120 "displayId": "string",
121 "status": "CREATED",
122 "name": "string"
123 },
124 "allowsSystemGenerateNewId": true,
125 "numberRangeIdentifierValue": "string",
126 "numberRangeIdentifierType": {
127 "name": "string"
128 },
129 "numberRangeType": {
130 "name": "string"
131 }
132 }
133 ],
134 "partnerContactsTotal": 0,
135 "allowsSystemGenerateNewId": true,
136 "numberRangeIdentifierValue": "string",
137 "numberRangeIdentifierType": {
138 "name": "string"
139 },
140 "numberRangeType": {
141 "name": "string"
142 }
143 }
144}
Bulk Create-Or-Update Resources¶
HTTP Request
PUT /api/v1/vendor-request/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 a bulk array of vendor request data, including details for creation or updates, to streamline vendor management processes. |
Body Parameters
1[
2 {
3 "id": 0,
4 "displayId": "string",
5 "state": "INV_DRAFT",
6 "vendorId": 0,
7 "vendorDisplayId": "string",
8 "vendorName": "string",
9 "vendorPhone": "string",
10 "vendorFax": "string",
11 "erpSystem": {
12 "id": 0,
13 "displayId": "string",
14 "status": "CREATED",
15 "name": "string",
16 "type": "NAKISA",
17 "sapVersion": "ECC_EHP5"
18 },
19 "vendorParent": {
20 "id": 0,
21 "displayId": "string",
22 "status": "CREATED",
23 "name": "string",
24 "erpSystemDisplayId": "string"
25 },
26 "operation": "VENDOR_CREATE",
27 "operationReason": "string",
28 "companies": [
29 {
30 "id": 0,
31 "displayId": "string",
32 "changeType": "ADD",
33 "vendorRequestId": 0,
34 "vendorRequestDisplayId": "string",
35 "company": {
36 "id": 0,
37 "displayId": "string",
38 "status": "CREATED",
39 "erpSystemId": 0,
40 "erpSystemDisplayId": "string",
41 "countryId": 0,
42 "countryDisplayId": "string",
43 "name": "string",
44 "postingPeriodVariantId": 0,
45 "fiscalVariantId": 0
46 },
47 "allowsSystemGenerateNewId": true,
48 "numberRangeIdentifierValue": "string",
49 "numberRangeIdentifierType": {
50 "name": "string"
51 },
52 "numberRangeType": {
53 "name": "string"
54 }
55 }
56 ],
57 "companiesTotal": 0,
58 "partnerRoles": [
59 {
60 "id": 0,
61 "displayId": "string",
62 "changeType": "ADD",
63 "vendorRequestId": 0,
64 "vendorRequestDisplayId": "string",
65 "partnerRole": {
66 "id": 0,
67 "displayId": "string",
68 "status": "CREATED",
69 "name": "string"
70 },
71 "allowsSystemGenerateNewId": true,
72 "numberRangeIdentifierValue": "string",
73 "numberRangeIdentifierType": {
74 "name": "string"
75 },
76 "numberRangeType": {
77 "name": "string"
78 }
79 }
80 ],
81 "partnerRolesTotal": 0,
82 "partnerContacts": [
83 {
84 "id": 0,
85 "displayId": "string",
86 "changeType": "ADD",
87 "vendorRequestId": 0,
88 "vendorRequestDisplayId": "string",
89 "createdPartnerContactDisplayId": "string",
90 "name": "string",
91 "email": "string",
92 "phone": "string",
93 "position": "string",
94 "address": "string",
95 "group": "string",
96 "buildingName": "string",
97 "fax": "string",
98 "erpSystem": {
99 "id": 0,
100 "displayId": "string",
101 "status": "CREATED",
102 "name": "string",
103 "type": "NAKISA",
104 "sapVersion": "ECC_EHP5"
105 },
106 "partnerContact": {
107 "id": 0,
108 "displayId": "string",
109 "status": "CREATED",
110 "name": "string"
111 },
112 "allowsSystemGenerateNewId": true,
113 "numberRangeIdentifierValue": "string",
114 "numberRangeIdentifierType": {
115 "name": "string"
116 },
117 "numberRangeType": {
118 "name": "string"
119 }
120 }
121 ],
122 "partnerContactsTotal": 0,
123 "allowsSystemGenerateNewId": true,
124 "numberRangeIdentifierValue": "string",
125 "numberRangeIdentifierType": {
126 "name": "string"
127 },
128 "numberRangeType": {
129 "name": "string"
130 }
131 }
132]
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 "state": "INV_DRAFT",
19 "vendorId": 0,
20 "vendorDisplayId": "string",
21 "vendorName": "string",
22 "vendorPhone": "string",
23 "vendorFax": "string",
24 "erpSystem": {
25 "id": 0,
26 "displayId": "string",
27 "status": "CREATED",
28 "name": "string",
29 "type": "NAKISA",
30 "sapVersion": "ECC_EHP5"
31 },
32 "vendorParent": {
33 "id": 0,
34 "displayId": "string",
35 "status": "CREATED",
36 "name": "string",
37 "erpSystemDisplayId": "string"
38 },
39 "operation": "VENDOR_CREATE",
40 "operationReason": "string",
41 "companies": [
42 {
43 "id": 0,
44 "displayId": "string",
45 "changeType": "ADD",
46 "vendorRequestId": 0,
47 "vendorRequestDisplayId": "string",
48 "company": {
49 "id": 0,
50 "displayId": "string",
51 "status": "CREATED",
52 "erpSystemId": 0,
53 "erpSystemDisplayId": "string",
54 "countryId": 0,
55 "countryDisplayId": "string",
56 "name": "string",
57 "postingPeriodVariantId": 0,
58 "fiscalVariantId": 0
59 },
60 "allowsSystemGenerateNewId": true,
61 "numberRangeIdentifierValue": "string",
62 "numberRangeIdentifierType": {
63 "name": "string"
64 },
65 "numberRangeType": {
66 "name": "string"
67 }
68 }
69 ],
70 "companiesTotal": 0,
71 "partnerRoles": [
72 {
73 "id": 0,
74 "displayId": "string",
75 "changeType": "ADD",
76 "vendorRequestId": 0,
77 "vendorRequestDisplayId": "string",
78 "partnerRole": {
79 "id": 0,
80 "displayId": "string",
81 "status": "CREATED",
82 "name": "string"
83 },
84 "allowsSystemGenerateNewId": true,
85 "numberRangeIdentifierValue": "string",
86 "numberRangeIdentifierType": {
87 "name": "string"
88 },
89 "numberRangeType": {
90 "name": "string"
91 }
92 }
93 ],
94 "partnerRolesTotal": 0,
95 "partnerContacts": [
96 {
97 "id": 0,
98 "displayId": "string",
99 "changeType": "ADD",
100 "vendorRequestId": 0,
101 "vendorRequestDisplayId": "string",
102 "createdPartnerContactDisplayId": "string",
103 "name": "string",
104 "email": "string",
105 "phone": "string",
106 "position": "string",
107 "address": "string",
108 "group": "string",
109 "buildingName": "string",
110 "fax": "string",
111 "erpSystem": {
112 "id": 0,
113 "displayId": "string",
114 "status": "CREATED",
115 "name": "string",
116 "type": "NAKISA",
117 "sapVersion": "ECC_EHP5"
118 },
119 "partnerContact": {
120 "id": 0,
121 "displayId": "string",
122 "status": "CREATED",
123 "name": "string"
124 },
125 "allowsSystemGenerateNewId": true,
126 "numberRangeIdentifierValue": "string",
127 "numberRangeIdentifierType": {
128 "name": "string"
129 },
130 "numberRangeType": {
131 "name": "string"
132 }
133 }
134 ],
135 "partnerContactsTotal": 0,
136 "allowsSystemGenerateNewId": true,
137 "numberRangeIdentifierValue": "string",
138 "numberRangeIdentifierType": {
139 "name": "string"
140 },
141 "numberRangeType": {
142 "name": "string"
143 }
144 }
145 ]
146}
Create Or Update A Resource¶
HTTP Request
PUT /api/v1/vendor-request/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 vendor request details, including identification, specifications, and status for creating or updating vendor information. |
Body Parameters
1{
2 "id": 0,
3 "displayId": "string",
4 "state": "INV_DRAFT",
5 "vendorId": 0,
6 "vendorDisplayId": "string",
7 "vendorName": "string",
8 "vendorPhone": "string",
9 "vendorFax": "string",
10 "erpSystem": {
11 "id": 0,
12 "displayId": "string",
13 "status": "CREATED",
14 "name": "string",
15 "type": "NAKISA",
16 "sapVersion": "ECC_EHP5"
17 },
18 "vendorParent": {
19 "id": 0,
20 "displayId": "string",
21 "status": "CREATED",
22 "name": "string",
23 "erpSystemDisplayId": "string"
24 },
25 "operation": "VENDOR_CREATE",
26 "operationReason": "string",
27 "companies": [
28 {
29 "id": 0,
30 "displayId": "string",
31 "changeType": "ADD",
32 "vendorRequestId": 0,
33 "vendorRequestDisplayId": "string",
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 "allowsSystemGenerateNewId": true,
47 "numberRangeIdentifierValue": "string",
48 "numberRangeIdentifierType": {
49 "name": "string"
50 },
51 "numberRangeType": {
52 "name": "string"
53 }
54 }
55 ],
56 "companiesTotal": 0,
57 "partnerRoles": [
58 {
59 "id": 0,
60 "displayId": "string",
61 "changeType": "ADD",
62 "vendorRequestId": 0,
63 "vendorRequestDisplayId": "string",
64 "partnerRole": {
65 "id": 0,
66 "displayId": "string",
67 "status": "CREATED",
68 "name": "string"
69 },
70 "allowsSystemGenerateNewId": true,
71 "numberRangeIdentifierValue": "string",
72 "numberRangeIdentifierType": {
73 "name": "string"
74 },
75 "numberRangeType": {
76 "name": "string"
77 }
78 }
79 ],
80 "partnerRolesTotal": 0,
81 "partnerContacts": [
82 {
83 "id": 0,
84 "displayId": "string",
85 "changeType": "ADD",
86 "vendorRequestId": 0,
87 "vendorRequestDisplayId": "string",
88 "createdPartnerContactDisplayId": "string",
89 "name": "string",
90 "email": "string",
91 "phone": "string",
92 "position": "string",
93 "address": "string",
94 "group": "string",
95 "buildingName": "string",
96 "fax": "string",
97 "erpSystem": {
98 "id": 0,
99 "displayId": "string",
100 "status": "CREATED",
101 "name": "string",
102 "type": "NAKISA",
103 "sapVersion": "ECC_EHP5"
104 },
105 "partnerContact": {
106 "id": 0,
107 "displayId": "string",
108 "status": "CREATED",
109 "name": "string"
110 },
111 "allowsSystemGenerateNewId": true,
112 "numberRangeIdentifierValue": "string",
113 "numberRangeIdentifierType": {
114 "name": "string"
115 },
116 "numberRangeType": {
117 "name": "string"
118 }
119 }
120 ],
121 "partnerContactsTotal": 0,
122 "allowsSystemGenerateNewId": true,
123 "numberRangeIdentifierValue": "string",
124 "numberRangeIdentifierType": {
125 "name": "string"
126 },
127 "numberRangeType": {
128 "name": "string"
129 }
130}
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 "state": "INV_DRAFT",
18 "vendorId": 0,
19 "vendorDisplayId": "string",
20 "vendorName": "string",
21 "vendorPhone": "string",
22 "vendorFax": "string",
23 "erpSystem": {
24 "id": 0,
25 "displayId": "string",
26 "status": "CREATED",
27 "name": "string",
28 "type": "NAKISA",
29 "sapVersion": "ECC_EHP5"
30 },
31 "vendorParent": {
32 "id": 0,
33 "displayId": "string",
34 "status": "CREATED",
35 "name": "string",
36 "erpSystemDisplayId": "string"
37 },
38 "operation": "VENDOR_CREATE",
39 "operationReason": "string",
40 "companies": [
41 {
42 "id": 0,
43 "displayId": "string",
44 "changeType": "ADD",
45 "vendorRequestId": 0,
46 "vendorRequestDisplayId": "string",
47 "company": {
48 "id": 0,
49 "displayId": "string",
50 "status": "CREATED",
51 "erpSystemId": 0,
52 "erpSystemDisplayId": "string",
53 "countryId": 0,
54 "countryDisplayId": "string",
55 "name": "string",
56 "postingPeriodVariantId": 0,
57 "fiscalVariantId": 0
58 },
59 "allowsSystemGenerateNewId": true,
60 "numberRangeIdentifierValue": "string",
61 "numberRangeIdentifierType": {
62 "name": "string"
63 },
64 "numberRangeType": {
65 "name": "string"
66 }
67 }
68 ],
69 "companiesTotal": 0,
70 "partnerRoles": [
71 {
72 "id": 0,
73 "displayId": "string",
74 "changeType": "ADD",
75 "vendorRequestId": 0,
76 "vendorRequestDisplayId": "string",
77 "partnerRole": {
78 "id": 0,
79 "displayId": "string",
80 "status": "CREATED",
81 "name": "string"
82 },
83 "allowsSystemGenerateNewId": true,
84 "numberRangeIdentifierValue": "string",
85 "numberRangeIdentifierType": {
86 "name": "string"
87 },
88 "numberRangeType": {
89 "name": "string"
90 }
91 }
92 ],
93 "partnerRolesTotal": 0,
94 "partnerContacts": [
95 {
96 "id": 0,
97 "displayId": "string",
98 "changeType": "ADD",
99 "vendorRequestId": 0,
100 "vendorRequestDisplayId": "string",
101 "createdPartnerContactDisplayId": "string",
102 "name": "string",
103 "email": "string",
104 "phone": "string",
105 "position": "string",
106 "address": "string",
107 "group": "string",
108 "buildingName": "string",
109 "fax": "string",
110 "erpSystem": {
111 "id": 0,
112 "displayId": "string",
113 "status": "CREATED",
114 "name": "string",
115 "type": "NAKISA",
116 "sapVersion": "ECC_EHP5"
117 },
118 "partnerContact": {
119 "id": 0,
120 "displayId": "string",
121 "status": "CREATED",
122 "name": "string"
123 },
124 "allowsSystemGenerateNewId": true,
125 "numberRangeIdentifierValue": "string",
126 "numberRangeIdentifierType": {
127 "name": "string"
128 },
129 "numberRangeType": {
130 "name": "string"
131 }
132 }
133 ],
134 "partnerContactsTotal": 0,
135 "allowsSystemGenerateNewId": true,
136 "numberRangeIdentifierValue": "string",
137 "numberRangeIdentifierType": {
138 "name": "string"
139 },
140 "numberRangeType": {
141 "name": "string"
142 }
143 }
144}
Bulk-Update Resources¶
HTTP Request
PUT /api/v1/vendor-request/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 vendor request objects, each including relevant details such as vendor information, request status, and associated metadata for bulk processing. |
Body Parameters
1[
2 {
3 "id": 0,
4 "displayId": "string",
5 "state": "INV_DRAFT",
6 "vendorId": 0,
7 "vendorDisplayId": "string",
8 "vendorName": "string",
9 "vendorPhone": "string",
10 "vendorFax": "string",
11 "erpSystem": {
12 "id": 0,
13 "displayId": "string",
14 "status": "CREATED",
15 "name": "string",
16 "type": "NAKISA",
17 "sapVersion": "ECC_EHP5"
18 },
19 "vendorParent": {
20 "id": 0,
21 "displayId": "string",
22 "status": "CREATED",
23 "name": "string",
24 "erpSystemDisplayId": "string"
25 },
26 "operation": "VENDOR_CREATE",
27 "operationReason": "string",
28 "companies": [
29 {
30 "id": 0,
31 "displayId": "string",
32 "changeType": "ADD",
33 "vendorRequestId": 0,
34 "vendorRequestDisplayId": "string",
35 "company": {
36 "id": 0,
37 "displayId": "string",
38 "status": "CREATED",
39 "erpSystemId": 0,
40 "erpSystemDisplayId": "string",
41 "countryId": 0,
42 "countryDisplayId": "string",
43 "name": "string",
44 "postingPeriodVariantId": 0,
45 "fiscalVariantId": 0
46 },
47 "allowsSystemGenerateNewId": true,
48 "numberRangeIdentifierValue": "string",
49 "numberRangeIdentifierType": {
50 "name": "string"
51 },
52 "numberRangeType": {
53 "name": "string"
54 }
55 }
56 ],
57 "companiesTotal": 0,
58 "partnerRoles": [
59 {
60 "id": 0,
61 "displayId": "string",
62 "changeType": "ADD",
63 "vendorRequestId": 0,
64 "vendorRequestDisplayId": "string",
65 "partnerRole": {
66 "id": 0,
67 "displayId": "string",
68 "status": "CREATED",
69 "name": "string"
70 },
71 "allowsSystemGenerateNewId": true,
72 "numberRangeIdentifierValue": "string",
73 "numberRangeIdentifierType": {
74 "name": "string"
75 },
76 "numberRangeType": {
77 "name": "string"
78 }
79 }
80 ],
81 "partnerRolesTotal": 0,
82 "partnerContacts": [
83 {
84 "id": 0,
85 "displayId": "string",
86 "changeType": "ADD",
87 "vendorRequestId": 0,
88 "vendorRequestDisplayId": "string",
89 "createdPartnerContactDisplayId": "string",
90 "name": "string",
91 "email": "string",
92 "phone": "string",
93 "position": "string",
94 "address": "string",
95 "group": "string",
96 "buildingName": "string",
97 "fax": "string",
98 "erpSystem": {
99 "id": 0,
100 "displayId": "string",
101 "status": "CREATED",
102 "name": "string",
103 "type": "NAKISA",
104 "sapVersion": "ECC_EHP5"
105 },
106 "partnerContact": {
107 "id": 0,
108 "displayId": "string",
109 "status": "CREATED",
110 "name": "string"
111 },
112 "allowsSystemGenerateNewId": true,
113 "numberRangeIdentifierValue": "string",
114 "numberRangeIdentifierType": {
115 "name": "string"
116 },
117 "numberRangeType": {
118 "name": "string"
119 }
120 }
121 ],
122 "partnerContactsTotal": 0,
123 "allowsSystemGenerateNewId": true,
124 "numberRangeIdentifierValue": "string",
125 "numberRangeIdentifierType": {
126 "name": "string"
127 },
128 "numberRangeType": {
129 "name": "string"
130 }
131 }
132]
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 "state": "INV_DRAFT",
19 "vendorId": 0,
20 "vendorDisplayId": "string",
21 "vendorName": "string",
22 "vendorPhone": "string",
23 "vendorFax": "string",
24 "erpSystem": {
25 "id": 0,
26 "displayId": "string",
27 "status": "CREATED",
28 "name": "string",
29 "type": "NAKISA",
30 "sapVersion": "ECC_EHP5"
31 },
32 "vendorParent": {
33 "id": 0,
34 "displayId": "string",
35 "status": "CREATED",
36 "name": "string",
37 "erpSystemDisplayId": "string"
38 },
39 "operation": "VENDOR_CREATE",
40 "operationReason": "string",
41 "companies": [
42 {
43 "id": 0,
44 "displayId": "string",
45 "changeType": "ADD",
46 "vendorRequestId": 0,
47 "vendorRequestDisplayId": "string",
48 "company": {
49 "id": 0,
50 "displayId": "string",
51 "status": "CREATED",
52 "erpSystemId": 0,
53 "erpSystemDisplayId": "string",
54 "countryId": 0,
55 "countryDisplayId": "string",
56 "name": "string",
57 "postingPeriodVariantId": 0,
58 "fiscalVariantId": 0
59 },
60 "allowsSystemGenerateNewId": true,
61 "numberRangeIdentifierValue": "string",
62 "numberRangeIdentifierType": {
63 "name": "string"
64 },
65 "numberRangeType": {
66 "name": "string"
67 }
68 }
69 ],
70 "companiesTotal": 0,
71 "partnerRoles": [
72 {
73 "id": 0,
74 "displayId": "string",
75 "changeType": "ADD",
76 "vendorRequestId": 0,
77 "vendorRequestDisplayId": "string",
78 "partnerRole": {
79 "id": 0,
80 "displayId": "string",
81 "status": "CREATED",
82 "name": "string"
83 },
84 "allowsSystemGenerateNewId": true,
85 "numberRangeIdentifierValue": "string",
86 "numberRangeIdentifierType": {
87 "name": "string"
88 },
89 "numberRangeType": {
90 "name": "string"
91 }
92 }
93 ],
94 "partnerRolesTotal": 0,
95 "partnerContacts": [
96 {
97 "id": 0,
98 "displayId": "string",
99 "changeType": "ADD",
100 "vendorRequestId": 0,
101 "vendorRequestDisplayId": "string",
102 "createdPartnerContactDisplayId": "string",
103 "name": "string",
104 "email": "string",
105 "phone": "string",
106 "position": "string",
107 "address": "string",
108 "group": "string",
109 "buildingName": "string",
110 "fax": "string",
111 "erpSystem": {
112 "id": 0,
113 "displayId": "string",
114 "status": "CREATED",
115 "name": "string",
116 "type": "NAKISA",
117 "sapVersion": "ECC_EHP5"
118 },
119 "partnerContact": {
120 "id": 0,
121 "displayId": "string",
122 "status": "CREATED",
123 "name": "string"
124 },
125 "allowsSystemGenerateNewId": true,
126 "numberRangeIdentifierValue": "string",
127 "numberRangeIdentifierType": {
128 "name": "string"
129 },
130 "numberRangeType": {
131 "name": "string"
132 }
133 }
134 ],
135 "partnerContactsTotal": 0,
136 "allowsSystemGenerateNewId": true,
137 "numberRangeIdentifierValue": "string",
138 "numberRangeIdentifierType": {
139 "name": "string"
140 },
141 "numberRangeType": {
142 "name": "string"
143 }
144 }
145 ]
146}
Bulk-Create Resources¶
HTTP Request
POST /api/v1/vendor-request/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 vendor request details, including vendor information and associated requirements for bulk processing. |
Body Parameters
1[
2 {
3 "id": 0,
4 "displayId": "string",
5 "state": "INV_DRAFT",
6 "vendorId": 0,
7 "vendorDisplayId": "string",
8 "vendorName": "string",
9 "vendorPhone": "string",
10 "vendorFax": "string",
11 "erpSystem": {
12 "id": 0,
13 "displayId": "string",
14 "status": "CREATED",
15 "name": "string",
16 "type": "NAKISA",
17 "sapVersion": "ECC_EHP5"
18 },
19 "vendorParent": {
20 "id": 0,
21 "displayId": "string",
22 "status": "CREATED",
23 "name": "string",
24 "erpSystemDisplayId": "string"
25 },
26 "operation": "VENDOR_CREATE",
27 "operationReason": "string",
28 "companies": [
29 {
30 "id": 0,
31 "displayId": "string",
32 "changeType": "ADD",
33 "vendorRequestId": 0,
34 "vendorRequestDisplayId": "string",
35 "company": {
36 "id": 0,
37 "displayId": "string",
38 "status": "CREATED",
39 "erpSystemId": 0,
40 "erpSystemDisplayId": "string",
41 "countryId": 0,
42 "countryDisplayId": "string",
43 "name": "string",
44 "postingPeriodVariantId": 0,
45 "fiscalVariantId": 0
46 },
47 "allowsSystemGenerateNewId": true,
48 "numberRangeIdentifierValue": "string",
49 "numberRangeIdentifierType": {
50 "name": "string"
51 },
52 "numberRangeType": {
53 "name": "string"
54 }
55 }
56 ],
57 "companiesTotal": 0,
58 "partnerRoles": [
59 {
60 "id": 0,
61 "displayId": "string",
62 "changeType": "ADD",
63 "vendorRequestId": 0,
64 "vendorRequestDisplayId": "string",
65 "partnerRole": {
66 "id": 0,
67 "displayId": "string",
68 "status": "CREATED",
69 "name": "string"
70 },
71 "allowsSystemGenerateNewId": true,
72 "numberRangeIdentifierValue": "string",
73 "numberRangeIdentifierType": {
74 "name": "string"
75 },
76 "numberRangeType": {
77 "name": "string"
78 }
79 }
80 ],
81 "partnerRolesTotal": 0,
82 "partnerContacts": [
83 {
84 "id": 0,
85 "displayId": "string",
86 "changeType": "ADD",
87 "vendorRequestId": 0,
88 "vendorRequestDisplayId": "string",
89 "createdPartnerContactDisplayId": "string",
90 "name": "string",
91 "email": "string",
92 "phone": "string",
93 "position": "string",
94 "address": "string",
95 "group": "string",
96 "buildingName": "string",
97 "fax": "string",
98 "erpSystem": {
99 "id": 0,
100 "displayId": "string",
101 "status": "CREATED",
102 "name": "string",
103 "type": "NAKISA",
104 "sapVersion": "ECC_EHP5"
105 },
106 "partnerContact": {
107 "id": 0,
108 "displayId": "string",
109 "status": "CREATED",
110 "name": "string"
111 },
112 "allowsSystemGenerateNewId": true,
113 "numberRangeIdentifierValue": "string",
114 "numberRangeIdentifierType": {
115 "name": "string"
116 },
117 "numberRangeType": {
118 "name": "string"
119 }
120 }
121 ],
122 "partnerContactsTotal": 0,
123 "allowsSystemGenerateNewId": true,
124 "numberRangeIdentifierValue": "string",
125 "numberRangeIdentifierType": {
126 "name": "string"
127 },
128 "numberRangeType": {
129 "name": "string"
130 }
131 }
132]
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 "state": "INV_DRAFT",
19 "vendorId": 0,
20 "vendorDisplayId": "string",
21 "vendorName": "string",
22 "vendorPhone": "string",
23 "vendorFax": "string",
24 "erpSystem": {
25 "id": 0,
26 "displayId": "string",
27 "status": "CREATED",
28 "name": "string",
29 "type": "NAKISA",
30 "sapVersion": "ECC_EHP5"
31 },
32 "vendorParent": {
33 "id": 0,
34 "displayId": "string",
35 "status": "CREATED",
36 "name": "string",
37 "erpSystemDisplayId": "string"
38 },
39 "operation": "VENDOR_CREATE",
40 "operationReason": "string",
41 "companies": [
42 {
43 "id": 0,
44 "displayId": "string",
45 "changeType": "ADD",
46 "vendorRequestId": 0,
47 "vendorRequestDisplayId": "string",
48 "company": {
49 "id": 0,
50 "displayId": "string",
51 "status": "CREATED",
52 "erpSystemId": 0,
53 "erpSystemDisplayId": "string",
54 "countryId": 0,
55 "countryDisplayId": "string",
56 "name": "string",
57 "postingPeriodVariantId": 0,
58 "fiscalVariantId": 0
59 },
60 "allowsSystemGenerateNewId": true,
61 "numberRangeIdentifierValue": "string",
62 "numberRangeIdentifierType": {
63 "name": "string"
64 },
65 "numberRangeType": {
66 "name": "string"
67 }
68 }
69 ],
70 "companiesTotal": 0,
71 "partnerRoles": [
72 {
73 "id": 0,
74 "displayId": "string",
75 "changeType": "ADD",
76 "vendorRequestId": 0,
77 "vendorRequestDisplayId": "string",
78 "partnerRole": {
79 "id": 0,
80 "displayId": "string",
81 "status": "CREATED",
82 "name": "string"
83 },
84 "allowsSystemGenerateNewId": true,
85 "numberRangeIdentifierValue": "string",
86 "numberRangeIdentifierType": {
87 "name": "string"
88 },
89 "numberRangeType": {
90 "name": "string"
91 }
92 }
93 ],
94 "partnerRolesTotal": 0,
95 "partnerContacts": [
96 {
97 "id": 0,
98 "displayId": "string",
99 "changeType": "ADD",
100 "vendorRequestId": 0,
101 "vendorRequestDisplayId": "string",
102 "createdPartnerContactDisplayId": "string",
103 "name": "string",
104 "email": "string",
105 "phone": "string",
106 "position": "string",
107 "address": "string",
108 "group": "string",
109 "buildingName": "string",
110 "fax": "string",
111 "erpSystem": {
112 "id": 0,
113 "displayId": "string",
114 "status": "CREATED",
115 "name": "string",
116 "type": "NAKISA",
117 "sapVersion": "ECC_EHP5"
118 },
119 "partnerContact": {
120 "id": 0,
121 "displayId": "string",
122 "status": "CREATED",
123 "name": "string"
124 },
125 "allowsSystemGenerateNewId": true,
126 "numberRangeIdentifierValue": "string",
127 "numberRangeIdentifierType": {
128 "name": "string"
129 },
130 "numberRangeType": {
131 "name": "string"
132 }
133 }
134 ],
135 "partnerContactsTotal": 0,
136 "allowsSystemGenerateNewId": true,
137 "numberRangeIdentifierValue": "string",
138 "numberRangeIdentifierType": {
139 "name": "string"
140 },
141 "numberRangeType": {
142 "name": "string"
143 }
144 }
145 ]
146}
Bulk-Delete Resources¶
HTTP Request
DELETE /api/v1/vendor-request/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 vendor request IDs to be deleted in bulk, facilitating efficient management of vendor relationships. |
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}
Start A Vendor Update Request¶
HTTP Request
POST /api/v1/vendor-request/{vendorId}/update/start
📋 Description: Initiates the vendor update workflow for the specified vendor. Creates a draft VendorRequest capturing the proposed changes described in the request body.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
vendorId |
path |
integer(int64) |
true |
Payable vendor ID |
body |
body |
true |
Request body containing the updated vendor request details, including status, relevant documentation, and any necessary metadata for processing the update. |
Body Parameters
1{
2 "operationType": "VENDOR_CREATE",
3 "operationReason": "string"
4}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
204 |
Vendor update request initiated |
None |
|
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
Example Responses
1{
2 "errorCode": "string",
3 "balances": [
4 {
5 "id": 0,
6 "displayId": "string",
7 "invoiceId": 0,
8 "invoiceDisplayId": "string",
9 "invoiceLineItemId": 0,
10 "invoiceLineItemDisplayId": "string",
11 "invoiceLineItemDescription": "string",
12 "expenseCategory": {
13 "id": 0,
14 "displayId": "string",
15 "name": "string"
16 },
17 "totalNetAmount": 0,
18 "totalTaxAmount": 0,
19 "reservedNetAmount": 0,
20 "reservedTaxAmount": 0,
21 "remainingTotalAmount": 0,
22 "remainingNetAmount": 0,
23 "remainingTaxAmount": 0,
24 "allowsSystemGenerateNewId": true,
25 "numberRangeIdentifierValue": "string",
26 "numberRangeIdentifierType": {
27 "name": "string"
28 },
29 "numberRangeType": {
30 "name": "string"
31 }
32 }
33 ]
34}
Search Resources¶
HTTP Request
POST /api/v1/vendor-request/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 vendor requests, including filters and parameters to refine the results based on business needs. |
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 "stateEqual": "INV_DRAFT",
20 "stateIn": [
21 "INV_DRAFT"
22 ],
23 "vendorIdEqual": 0,
24 "vendorDisplayIdLike": "string",
25 "vendorNameLike": "string",
26 "vendorPhoneLike": "string",
27 "vendorFaxLike": "string",
28 "operationEqual": "VENDOR_CREATE",
29 "operationIn": [
30 "VENDOR_CREATE"
31 ],
32 "operationReasonLike": "string"
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 "state": "INV_DRAFT",
23 "vendorId": 0,
24 "vendorDisplayId": "string",
25 "vendorName": "string",
26 "vendorPhone": "string",
27 "vendorFax": "string",
28 "erpSystem": {
29 "id": 0,
30 "displayId": "string",
31 "status": "CREATED",
32 "name": "string",
33 "type": "NAKISA",
34 "sapVersion": "ECC_EHP5"
35 },
36 "vendorParent": {
37 "id": 0,
38 "displayId": "string",
39 "status": "CREATED",
40 "name": "string",
41 "erpSystemDisplayId": "string"
42 },
43 "operation": "VENDOR_CREATE",
44 "operationReason": "string",
45 "companies": [
46 {
47 "id": 0,
48 "displayId": "string",
49 "changeType": "ADD",
50 "vendorRequestId": 0,
51 "vendorRequestDisplayId": "string",
52 "company": {
53 "id": 0,
54 "displayId": "string",
55 "status": "CREATED",
56 "erpSystemId": 0,
57 "erpSystemDisplayId": "string",
58 "countryId": 0,
59 "countryDisplayId": "string",
60 "name": "string",
61 "postingPeriodVariantId": 0,
62 "fiscalVariantId": 0
63 },
64 "allowsSystemGenerateNewId": true,
65 "numberRangeIdentifierValue": "string",
66 "numberRangeIdentifierType": {
67 "name": "string"
68 },
69 "numberRangeType": {
70 "name": "string"
71 }
72 }
73 ],
74 "companiesTotal": 0,
75 "partnerRoles": [
76 {
77 "id": 0,
78 "displayId": "string",
79 "changeType": "ADD",
80 "vendorRequestId": 0,
81 "vendorRequestDisplayId": "string",
82 "partnerRole": {
83 "id": 0,
84 "displayId": "string",
85 "status": "CREATED",
86 "name": "string"
87 },
88 "allowsSystemGenerateNewId": true,
89 "numberRangeIdentifierValue": "string",
90 "numberRangeIdentifierType": {
91 "name": "string"
92 },
93 "numberRangeType": {
94 "name": "string"
95 }
96 }
97 ],
98 "partnerRolesTotal": 0,
99 "partnerContacts": [
100 {
101 "id": 0,
102 "displayId": "string",
103 "changeType": "ADD",
104 "vendorRequestId": 0,
105 "vendorRequestDisplayId": "string",
106 "createdPartnerContactDisplayId": "string",
107 "name": "string",
108 "email": "string",
109 "phone": "string",
110 "position": "string",
111 "address": "string",
112 "group": "string",
113 "buildingName": "string",
114 "fax": "string",
115 "erpSystem": {
116 "id": 0,
117 "displayId": "string",
118 "status": "CREATED",
119 "name": "string",
120 "type": "NAKISA",
121 "sapVersion": "ECC_EHP5"
122 },
123 "partnerContact": {
124 "id": 0,
125 "displayId": "string",
126 "status": "CREATED",
127 "name": "string"
128 },
129 "allowsSystemGenerateNewId": true,
130 "numberRangeIdentifierValue": "string",
131 "numberRangeIdentifierType": {
132 "name": "string"
133 },
134 "numberRangeType": {
135 "name": "string"
136 }
137 }
138 ],
139 "partnerContactsTotal": 0,
140 "allowsSystemGenerateNewId": true,
141 "numberRangeIdentifierValue": "string",
142 "numberRangeIdentifierType": {
143 "name": "string"
144 },
145 "numberRangeType": {
146 "name": "string"
147 }
148 }
149 ],
150 "number": 0,
151 "sort": {
152 "unsorted": true,
153 "sorted": true,
154 "empty": true
155 },
156 "first": true,
157 "last": true,
158 "empty": true
159}
Resolve A Conflicted Vendor Request¶
HTTP Request
POST /api/v1/vendor-request/resolve-conflict
📋 Description: Applies manual conflict resolution to a vendor request that is in a conflicted state (e.g. the underlying vendor was modified by another request after this one was submitted). The resolved data in the request body overwrites the conflicting fields.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the details of the vendor conflict resolution, including conflict identifiers, proposed resolutions, and relevant metadata. |
Body Parameters
1{
2 "id": 0,
3 "displayId": "string",
4 "state": "INV_DRAFT",
5 "vendorId": 0,
6 "vendorDisplayId": "string",
7 "vendorName": "string",
8 "vendorPhone": "string",
9 "vendorFax": "string",
10 "erpSystem": {
11 "id": 0,
12 "displayId": "string",
13 "status": "CREATED",
14 "name": "string",
15 "type": "NAKISA",
16 "sapVersion": "ECC_EHP5"
17 },
18 "vendorParent": {
19 "id": 0,
20 "displayId": "string",
21 "status": "CREATED",
22 "name": "string",
23 "erpSystemDisplayId": "string"
24 },
25 "operation": "VENDOR_CREATE",
26 "operationReason": "string",
27 "companies": [
28 {
29 "id": 0,
30 "displayId": "string",
31 "changeType": "ADD",
32 "vendorRequestId": 0,
33 "vendorRequestDisplayId": "string",
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 "allowsSystemGenerateNewId": true,
47 "numberRangeIdentifierValue": "string",
48 "numberRangeIdentifierType": {
49 "name": "string"
50 },
51 "numberRangeType": {
52 "name": "string"
53 }
54 }
55 ],
56 "companiesTotal": 0,
57 "partnerRoles": [
58 {
59 "id": 0,
60 "displayId": "string",
61 "changeType": "ADD",
62 "vendorRequestId": 0,
63 "vendorRequestDisplayId": "string",
64 "partnerRole": {
65 "id": 0,
66 "displayId": "string",
67 "status": "CREATED",
68 "name": "string"
69 },
70 "allowsSystemGenerateNewId": true,
71 "numberRangeIdentifierValue": "string",
72 "numberRangeIdentifierType": {
73 "name": "string"
74 },
75 "numberRangeType": {
76 "name": "string"
77 }
78 }
79 ],
80 "partnerRolesTotal": 0,
81 "partnerContacts": [
82 {
83 "id": 0,
84 "displayId": "string",
85 "changeType": "ADD",
86 "vendorRequestId": 0,
87 "vendorRequestDisplayId": "string",
88 "createdPartnerContactDisplayId": "string",
89 "name": "string",
90 "email": "string",
91 "phone": "string",
92 "position": "string",
93 "address": "string",
94 "group": "string",
95 "buildingName": "string",
96 "fax": "string",
97 "erpSystem": {
98 "id": 0,
99 "displayId": "string",
100 "status": "CREATED",
101 "name": "string",
102 "type": "NAKISA",
103 "sapVersion": "ECC_EHP5"
104 },
105 "partnerContact": {
106 "id": 0,
107 "displayId": "string",
108 "status": "CREATED",
109 "name": "string"
110 },
111 "allowsSystemGenerateNewId": true,
112 "numberRangeIdentifierValue": "string",
113 "numberRangeIdentifierType": {
114 "name": "string"
115 },
116 "numberRangeType": {
117 "name": "string"
118 }
119 }
120 ],
121 "partnerContactsTotal": 0,
122 "allowsSystemGenerateNewId": true,
123 "numberRangeIdentifierValue": "string",
124 "numberRangeIdentifierType": {
125 "name": "string"
126 },
127 "numberRangeType": {
128 "name": "string"
129 }
130}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
204 |
Conflict resolved |
None |
|
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
Example Responses
1{
2 "errorCode": "string",
3 "balances": [
4 {
5 "id": 0,
6 "displayId": "string",
7 "invoiceId": 0,
8 "invoiceDisplayId": "string",
9 "invoiceLineItemId": 0,
10 "invoiceLineItemDisplayId": "string",
11 "invoiceLineItemDescription": "string",
12 "expenseCategory": {
13 "id": 0,
14 "displayId": "string",
15 "name": "string"
16 },
17 "totalNetAmount": 0,
18 "totalTaxAmount": 0,
19 "reservedNetAmount": 0,
20 "reservedTaxAmount": 0,
21 "remainingTotalAmount": 0,
22 "remainingNetAmount": 0,
23 "remainingTaxAmount": 0,
24 "allowsSystemGenerateNewId": true,
25 "numberRangeIdentifierValue": "string",
26 "numberRangeIdentifierType": {
27 "name": "string"
28 },
29 "numberRangeType": {
30 "name": "string"
31 }
32 }
33 ]
34}
Advanced Vendor Request Search¶
HTTP Request
POST /api/v1/vendor-request/advanced-search
📋 Description: Full-text / multi-field search with faceting. 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 vendor requests, including filters such as vendor type, location, and service offerings to facilitate targeted results. |
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 "state": "INV_DRAFT",
7 "vendorId": 0,
8 "vendorDisplayId": "string",
9 "vendorName": "string",
10 "vendorPhone": "string",
11 "vendorFax": "string",
12 "erpSystem": {
13 "id": 0,
14 "displayId": "string",
15 "status": "CREATED",
16 "name": "string",
17 "type": "NAKISA",
18 "sapVersion": "ECC_EHP5"
19 },
20 "vendorParent": {
21 "id": 0,
22 "displayId": "string",
23 "status": "CREATED",
24 "name": "string",
25 "erpSystemDisplayId": "string"
26 },
27 "operation": "VENDOR_CREATE",
28 "operationReason": "string",
29 "companies": [
30 {
31 "id": 0,
32 "displayId": "string",
33 "changeType": "ADD",
34 "vendorRequestId": 0,
35 "vendorRequestDisplayId": "string",
36 "company": {
37 "id": 0,
38 "displayId": "string",
39 "status": "CREATED",
40 "erpSystemId": 0,
41 "erpSystemDisplayId": "string",
42 "countryId": 0,
43 "countryDisplayId": "string",
44 "name": "string",
45 "postingPeriodVariantId": 0,
46 "fiscalVariantId": 0
47 },
48 "allowsSystemGenerateNewId": true,
49 "numberRangeIdentifierValue": "string",
50 "numberRangeIdentifierType": {
51 "name": "string"
52 },
53 "numberRangeType": {
54 "name": "string"
55 }
56 }
57 ],
58 "companiesTotal": 0,
59 "partnerRoles": [
60 {
61 "id": 0,
62 "displayId": "string",
63 "changeType": "ADD",
64 "vendorRequestId": 0,
65 "vendorRequestDisplayId": "string",
66 "partnerRole": {
67 "id": 0,
68 "displayId": "string",
69 "status": "CREATED",
70 "name": "string"
71 },
72 "allowsSystemGenerateNewId": true,
73 "numberRangeIdentifierValue": "string",
74 "numberRangeIdentifierType": {
75 "name": "string"
76 },
77 "numberRangeType": {
78 "name": "string"
79 }
80 }
81 ],
82 "partnerRolesTotal": 0,
83 "partnerContacts": [
84 {
85 "id": 0,
86 "displayId": "string",
87 "changeType": "ADD",
88 "vendorRequestId": 0,
89 "vendorRequestDisplayId": "string",
90 "createdPartnerContactDisplayId": "string",
91 "name": "string",
92 "email": "string",
93 "phone": "string",
94 "position": "string",
95 "address": "string",
96 "group": "string",
97 "buildingName": "string",
98 "fax": "string",
99 "erpSystem": {
100 "id": 0,
101 "displayId": "string",
102 "status": "CREATED",
103 "name": "string",
104 "type": "NAKISA",
105 "sapVersion": "ECC_EHP5"
106 },
107 "partnerContact": {
108 "id": 0,
109 "displayId": "string",
110 "status": "CREATED",
111 "name": "string"
112 },
113 "allowsSystemGenerateNewId": true,
114 "numberRangeIdentifierValue": "string",
115 "numberRangeIdentifierType": {
116 "name": "string"
117 },
118 "numberRangeType": {
119 "name": "string"
120 }
121 }
122 ],
123 "partnerContactsTotal": 0,
124 "allowsSystemGenerateNewId": true,
125 "numberRangeIdentifierValue": "string",
126 "numberRangeIdentifierType": {
127 "name": "string"
128 },
129 "numberRangeType": {
130 "name": "string"
131 }
132 }
133 ],
134 "facets": {
135 "property1": {},
136 "property2": {}
137 },
138 "aggregations": {
139 "property1": {},
140 "property2": {}
141 },
142 "pagination": {
143 "number": 0,
144 "size": 0,
145 "totalElements": 0,
146 "totalPages": 0,
147 "first": true,
148 "last": true,
149 "empty": true,
150 "numberOfElements": 0
151 }
152}
List All Resources¶
HTTP Request
GET /api/v1/vendor-request
📋 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 response should be paginated, allowing users to retrieve vendor requests in manageable segments for improved data handling and analysis. |
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 "state": "INV_DRAFT",
23 "vendorId": 0,
24 "vendorDisplayId": "string",
25 "vendorName": "string",
26 "vendorPhone": "string",
27 "vendorFax": "string",
28 "erpSystem": {
29 "id": 0,
30 "displayId": "string",
31 "status": "CREATED",
32 "name": "string",
33 "type": "NAKISA",
34 "sapVersion": "ECC_EHP5"
35 },
36 "vendorParent": {
37 "id": 0,
38 "displayId": "string",
39 "status": "CREATED",
40 "name": "string",
41 "erpSystemDisplayId": "string"
42 },
43 "operation": "VENDOR_CREATE",
44 "operationReason": "string",
45 "companies": [
46 {
47 "id": 0,
48 "displayId": "string",
49 "changeType": "ADD",
50 "vendorRequestId": 0,
51 "vendorRequestDisplayId": "string",
52 "company": {
53 "id": 0,
54 "displayId": "string",
55 "status": "CREATED",
56 "erpSystemId": 0,
57 "erpSystemDisplayId": "string",
58 "countryId": 0,
59 "countryDisplayId": "string",
60 "name": "string",
61 "postingPeriodVariantId": 0,
62 "fiscalVariantId": 0
63 },
64 "allowsSystemGenerateNewId": true,
65 "numberRangeIdentifierValue": "string",
66 "numberRangeIdentifierType": {
67 "name": "string"
68 },
69 "numberRangeType": {
70 "name": "string"
71 }
72 }
73 ],
74 "companiesTotal": 0,
75 "partnerRoles": [
76 {
77 "id": 0,
78 "displayId": "string",
79 "changeType": "ADD",
80 "vendorRequestId": 0,
81 "vendorRequestDisplayId": "string",
82 "partnerRole": {
83 "id": 0,
84 "displayId": "string",
85 "status": "CREATED",
86 "name": "string"
87 },
88 "allowsSystemGenerateNewId": true,
89 "numberRangeIdentifierValue": "string",
90 "numberRangeIdentifierType": {
91 "name": "string"
92 },
93 "numberRangeType": {
94 "name": "string"
95 }
96 }
97 ],
98 "partnerRolesTotal": 0,
99 "partnerContacts": [
100 {
101 "id": 0,
102 "displayId": "string",
103 "changeType": "ADD",
104 "vendorRequestId": 0,
105 "vendorRequestDisplayId": "string",
106 "createdPartnerContactDisplayId": "string",
107 "name": "string",
108 "email": "string",
109 "phone": "string",
110 "position": "string",
111 "address": "string",
112 "group": "string",
113 "buildingName": "string",
114 "fax": "string",
115 "erpSystem": {
116 "id": 0,
117 "displayId": "string",
118 "status": "CREATED",
119 "name": "string",
120 "type": "NAKISA",
121 "sapVersion": "ECC_EHP5"
122 },
123 "partnerContact": {
124 "id": 0,
125 "displayId": "string",
126 "status": "CREATED",
127 "name": "string"
128 },
129 "allowsSystemGenerateNewId": true,
130 "numberRangeIdentifierValue": "string",
131 "numberRangeIdentifierType": {
132 "name": "string"
133 },
134 "numberRangeType": {
135 "name": "string"
136 }
137 }
138 ],
139 "partnerContactsTotal": 0,
140 "allowsSystemGenerateNewId": true,
141 "numberRangeIdentifierValue": "string",
142 "numberRangeIdentifierType": {
143 "name": "string"
144 },
145 "numberRangeType": {
146 "name": "string"
147 }
148 }
149 ],
150 "number": 0,
151 "sort": {
152 "unsorted": true,
153 "sorted": true,
154 "empty": true
155 },
156 "first": true,
157 "last": true,
158 "empty": true
159}
Create A Resource¶
HTTP Request
POST /api/v1/vendor-request
📋 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 vendor request details, including vendor information, service requirements, and associated metadata for processing procurement needs. |
Body Parameters
1{
2 "id": 0,
3 "displayId": "string",
4 "state": "INV_DRAFT",
5 "vendorId": 0,
6 "vendorDisplayId": "string",
7 "vendorName": "string",
8 "vendorPhone": "string",
9 "vendorFax": "string",
10 "erpSystem": {
11 "id": 0,
12 "displayId": "string",
13 "status": "CREATED",
14 "name": "string",
15 "type": "NAKISA",
16 "sapVersion": "ECC_EHP5"
17 },
18 "vendorParent": {
19 "id": 0,
20 "displayId": "string",
21 "status": "CREATED",
22 "name": "string",
23 "erpSystemDisplayId": "string"
24 },
25 "operation": "VENDOR_CREATE",
26 "operationReason": "string",
27 "companies": [
28 {
29 "id": 0,
30 "displayId": "string",
31 "changeType": "ADD",
32 "vendorRequestId": 0,
33 "vendorRequestDisplayId": "string",
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 "allowsSystemGenerateNewId": true,
47 "numberRangeIdentifierValue": "string",
48 "numberRangeIdentifierType": {
49 "name": "string"
50 },
51 "numberRangeType": {
52 "name": "string"
53 }
54 }
55 ],
56 "companiesTotal": 0,
57 "partnerRoles": [
58 {
59 "id": 0,
60 "displayId": "string",
61 "changeType": "ADD",
62 "vendorRequestId": 0,
63 "vendorRequestDisplayId": "string",
64 "partnerRole": {
65 "id": 0,
66 "displayId": "string",
67 "status": "CREATED",
68 "name": "string"
69 },
70 "allowsSystemGenerateNewId": true,
71 "numberRangeIdentifierValue": "string",
72 "numberRangeIdentifierType": {
73 "name": "string"
74 },
75 "numberRangeType": {
76 "name": "string"
77 }
78 }
79 ],
80 "partnerRolesTotal": 0,
81 "partnerContacts": [
82 {
83 "id": 0,
84 "displayId": "string",
85 "changeType": "ADD",
86 "vendorRequestId": 0,
87 "vendorRequestDisplayId": "string",
88 "createdPartnerContactDisplayId": "string",
89 "name": "string",
90 "email": "string",
91 "phone": "string",
92 "position": "string",
93 "address": "string",
94 "group": "string",
95 "buildingName": "string",
96 "fax": "string",
97 "erpSystem": {
98 "id": 0,
99 "displayId": "string",
100 "status": "CREATED",
101 "name": "string",
102 "type": "NAKISA",
103 "sapVersion": "ECC_EHP5"
104 },
105 "partnerContact": {
106 "id": 0,
107 "displayId": "string",
108 "status": "CREATED",
109 "name": "string"
110 },
111 "allowsSystemGenerateNewId": true,
112 "numberRangeIdentifierValue": "string",
113 "numberRangeIdentifierType": {
114 "name": "string"
115 },
116 "numberRangeType": {
117 "name": "string"
118 }
119 }
120 ],
121 "partnerContactsTotal": 0,
122 "allowsSystemGenerateNewId": true,
123 "numberRangeIdentifierValue": "string",
124 "numberRangeIdentifierType": {
125 "name": "string"
126 },
127 "numberRangeType": {
128 "name": "string"
129 }
130}
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 "state": "INV_DRAFT",
18 "vendorId": 0,
19 "vendorDisplayId": "string",
20 "vendorName": "string",
21 "vendorPhone": "string",
22 "vendorFax": "string",
23 "erpSystem": {
24 "id": 0,
25 "displayId": "string",
26 "status": "CREATED",
27 "name": "string",
28 "type": "NAKISA",
29 "sapVersion": "ECC_EHP5"
30 },
31 "vendorParent": {
32 "id": 0,
33 "displayId": "string",
34 "status": "CREATED",
35 "name": "string",
36 "erpSystemDisplayId": "string"
37 },
38 "operation": "VENDOR_CREATE",
39 "operationReason": "string",
40 "companies": [
41 {
42 "id": 0,
43 "displayId": "string",
44 "changeType": "ADD",
45 "vendorRequestId": 0,
46 "vendorRequestDisplayId": "string",
47 "company": {
48 "id": 0,
49 "displayId": "string",
50 "status": "CREATED",
51 "erpSystemId": 0,
52 "erpSystemDisplayId": "string",
53 "countryId": 0,
54 "countryDisplayId": "string",
55 "name": "string",
56 "postingPeriodVariantId": 0,
57 "fiscalVariantId": 0
58 },
59 "allowsSystemGenerateNewId": true,
60 "numberRangeIdentifierValue": "string",
61 "numberRangeIdentifierType": {
62 "name": "string"
63 },
64 "numberRangeType": {
65 "name": "string"
66 }
67 }
68 ],
69 "companiesTotal": 0,
70 "partnerRoles": [
71 {
72 "id": 0,
73 "displayId": "string",
74 "changeType": "ADD",
75 "vendorRequestId": 0,
76 "vendorRequestDisplayId": "string",
77 "partnerRole": {
78 "id": 0,
79 "displayId": "string",
80 "status": "CREATED",
81 "name": "string"
82 },
83 "allowsSystemGenerateNewId": true,
84 "numberRangeIdentifierValue": "string",
85 "numberRangeIdentifierType": {
86 "name": "string"
87 },
88 "numberRangeType": {
89 "name": "string"
90 }
91 }
92 ],
93 "partnerRolesTotal": 0,
94 "partnerContacts": [
95 {
96 "id": 0,
97 "displayId": "string",
98 "changeType": "ADD",
99 "vendorRequestId": 0,
100 "vendorRequestDisplayId": "string",
101 "createdPartnerContactDisplayId": "string",
102 "name": "string",
103 "email": "string",
104 "phone": "string",
105 "position": "string",
106 "address": "string",
107 "group": "string",
108 "buildingName": "string",
109 "fax": "string",
110 "erpSystem": {
111 "id": 0,
112 "displayId": "string",
113 "status": "CREATED",
114 "name": "string",
115 "type": "NAKISA",
116 "sapVersion": "ECC_EHP5"
117 },
118 "partnerContact": {
119 "id": 0,
120 "displayId": "string",
121 "status": "CREATED",
122 "name": "string"
123 },
124 "allowsSystemGenerateNewId": true,
125 "numberRangeIdentifierValue": "string",
126 "numberRangeIdentifierType": {
127 "name": "string"
128 },
129 "numberRangeType": {
130 "name": "string"
131 }
132 }
133 ],
134 "partnerContactsTotal": 0,
135 "allowsSystemGenerateNewId": true,
136 "numberRangeIdentifierValue": "string",
137 "numberRangeIdentifierType": {
138 "name": "string"
139 },
140 "numberRangeType": {
141 "name": "string"
142 }
143 }
144}
Get Workflow State History For A Vendor Request¶
HTTP Request
GET /api/v1/vendor-request/{vendorRequestId}/state-history
📋 Description: Returns the ordered list of state transitions the vendor request has gone through.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
vendorRequestId |
path |
integer(int64) |
true |
Vendor request 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 "success": true,
5 "failedMessage": "string",
6 "warningMessage": "string",
7 "fromState": "string",
8 "event": "string",
9 "comment": "string",
10 "vendorRequestRejectionReason": "string",
11 "vendorRequestId": 0
12 }
13]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing the historical state changes of vendor requests, providing insights into their progression and status over time for effective vendor management.] |
|
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» success |
boolean |
false |
none |
Indicates whether the vendor request was successfully processed, providing essential insight into the status of vendor engagement. |
» failedMessage |
string |
false |
none |
Message detailing the reason for the failure of a vendor request, providing essential context for troubleshooting and resolution. |
» warningMessage |
string |
false |
none |
Contains a string message that provides warnings related to the state history of vendor requests, aiding in the identification of potential issues during processing. |
» fromState |
string |
false |
none |
Represents the originating state of the vendor request within the state history, providing insight into its progression and status changes. |
» event |
string |
false |
none |
Represents the specific event associated with the vendor request state history, providing context for changes in the request’s status. |
» comment |
string |
false |
none |
Textual feedback or remarks associated with the vendor request, providing context and insights into the request’s status or history. |
» vendorRequestRejectionReason |
string |
false |
none |
Reason for the rejection of a vendor request, providing clarity on the decision for record-keeping and future reference. |
» vendorRequestId |
integer(int64) |
false |
none |
Unique identifier for the vendor request |
Get Change Diff History For A Vendor¶
HTTP Request
GET /api/v1/vendor-request/{vendorId}/change-diff-history
📋 Description: Returns all historical diffs for a vendor — one per approved vendor request.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
vendorId |
path |
integer(int64) |
true |
Payable vendor 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 "vendorId": 0,
4 "operationReason": "string",
5 "operation": "VENDOR_CREATE",
6 "createdBy": "string",
7 "createdAt": "2019-08-24T14:15:22Z",
8 "fieldDiffs": {
9 "property1": {
10 "newValue": {},
11 "oldValue": {}
12 },
13 "property2": {
14 "newValue": {},
15 "oldValue": {}
16 }
17 },
18 "companyDiff": {
19 "added": [
20 "string"
21 ],
22 "removed": [
23 "string"
24 ]
25 },
26 "roleDiff": {
27 "added": [
28 "string"
29 ],
30 "removed": [
31 "string"
32 ]
33 },
34 "contactDiff": {
35 "added": [
36 {
37 "id": 0,
38 "status": "CREATED",
39 "displayId": "string",
40 "name": "string",
41 "email": "string",
42 "phone": "string",
43 "position": "string",
44 "address": "string",
45 "group": "string",
46 "buildingName": "string",
47 "fax": "string",
48 "erpSystemId": 0,
49 "erpSystemDisplayId": "string",
50 "partnerId": 0,
51 "contactRoleId": 0
52 }
53 ],
54 "removed": [
55 {
56 "id": 0,
57 "status": "CREATED",
58 "displayId": "string",
59 "name": "string",
60 "email": "string",
61 "phone": "string",
62 "position": "string",
63 "address": "string",
64 "group": "string",
65 "buildingName": "string",
66 "fax": "string",
67 "erpSystemId": 0,
68 "erpSystemDisplayId": "string",
69 "partnerId": 0,
70 "contactRoleId": 0
71 }
72 ]
73 },
74 "hasChanges": true
75 }
76]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing the differences identified between vendor records, including relevant metadata and comparison results, to facilitate informed decision-making in vendor management.] |
|
» vendorId |
integer(int64) |
false |
none |
Unique identifier for the vendor |
» operationReason |
string |
false |
none |
Description of the reason for the operational difference identified in the vendor analysis. |
» operation |
string |
false |
none |
Specifies the type of operation performed in the vendor differentiation process, facilitating clear tracking and analysis of vendor performance. |
» createdBy |
string |
false |
none |
Username of who created this resource |
» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
» fieldDiffs |
object |
false |
none |
Contains the differences between vendor data sets, enabling users to identify and analyze discrepancies for informed decision-making. |
»» additionalProperties |
false |
none |
Data transfer object representing the differences between two field values, enabling businesses to track changes and discrepancies in data for improved decision-making and data integrity. |
|
»»» newValue |
object |
false |
none |
Represents the updated value of a field in the context of a change request, facilitating the tracking of modifications within the system. |
»»» oldValue |
object |
false |
none |
Represents the previous state of the field before any modifications were made, providing essential context for tracking changes in data. |
» companyDiff |
false |
none |
Data transfer object representing the differences in string values between two related entities, facilitating comparison and analysis in business processes. |
|
»» added |
[string] |
false |
none |
Array of strings representing the differences that have been added, facilitating tracking of changes within the related data. |
»» removed |
[string] |
false |
none |
Array of strings representing the relationships that have been removed, providing insight into changes in data associations. |
» roleDiff |
false |
none |
Data transfer object representing the differences in string values between two related entities, facilitating comparison and analysis in business processes. |
|
» contactDiff |
false |
none |
Data transfer object representing the contact details of a partner within a relational context, facilitating effective communication and collaboration in business partnerships. |
|
»» added |
false |
none |
Array of related partner contact details that have been added, facilitating enhanced communication and collaboration with stakeholders. |
|
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» status |
string |
false |
none |
Status of the resource |
»»» displayId |
string |
true |
none |
Unique identifier for the display |
»»» name |
string |
true |
none |
Name of the resource |
string |
true |
none |
Email address of the partner contact, used for communication and correspondence within the business relationship. |
|
»»» phone |
string |
false |
none |
Contact phone number for the partner, used for communication and coordination purposes. |
»»» position |
string |
true |
none |
Represents the job title or role of the partner contact within their organization. |
»»» address |
string |
false |
none |
Represents the physical address of the partner contact, essential for communication and logistical purposes. |
»»» group |
string |
false |
none |
Represents the name of the group associated with the partner contact, facilitating organized communication and collaboration within the business context. |
»»» buildingName |
string |
false |
none |
Name of the building |
»»» fax |
string |
false |
none |
Fax number of the partner contact, used for facilitating direct communication and document transmission. |
»»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
»»» erpSystemDisplayId |
string |
false |
none |
Unique identifier for the erp system display |
»»» partnerId |
integer(int64) |
false |
none |
Unique identifier for the partner |
»»» contactRoleId |
integer(int64) |
false |
none |
Unique identifier for the contact role |
»» removed |
false |
none |
List of contacts that have been removed from the partnership, providing insights into changes in stakeholder relationships. |
|
» hasChanges |
boolean |
false |
none |
Whether the resource has has changes |
Enumerated Values
Attribute |
Value |
|---|---|
operation |
VENDOR_CREATE, VENDOR_DELETE, VENDOR_RESTORE, VENDOR_UPDATE |
status |
ACTIVE, CREATED, DECOMMISSIONED, DISABLED |
Preview The Diff For A Vendor Request¶
HTTP Request
GET /api/v1/vendor-request/vendor-diff/preview/{vendorRequestId}
📋 Description: Returns a structured diff of what will change when this vendor request is approved. Use {@code type=NORMAL_DIFF} (default) for a field-by-field comparison, or {@code type=FULL_DIFF} to include unchanged fields as context.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
vendorRequestId |
path |
integer(int64) |
true |
Vendor request ID |
type |
query |
string |
false |
NORMAL_DIFF shows only changed fields; FULL_DIFF includes all fields |
Default Values¶
Parameter |
Default |
Type |
|---|---|---|
type |
|
query |
Enumerated Values
Attribute |
Value |
|---|---|
type |
CONFLICT_DIFF, NORMAL_DIFF |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
||
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
Example Responses
1{
2 "vendorId": 0,
3 "operationReason": "string",
4 "operation": "VENDOR_CREATE",
5 "createdBy": "string",
6 "createdAt": "2019-08-24T14:15:22Z",
7 "fieldDiffs": {
8 "property1": {
9 "newValue": {},
10 "oldValue": {}
11 },
12 "property2": {
13 "newValue": {},
14 "oldValue": {}
15 }
16 },
17 "companyDiff": {
18 "added": [
19 "string"
20 ],
21 "removed": [
22 "string"
23 ]
24 },
25 "roleDiff": {
26 "added": [
27 "string"
28 ],
29 "removed": [
30 "string"
31 ]
32 },
33 "contactDiff": {
34 "added": [
35 {
36 "id": 0,
37 "status": "CREATED",
38 "displayId": "string",
39 "name": "string",
40 "email": "string",
41 "phone": "string",
42 "position": "string",
43 "address": "string",
44 "group": "string",
45 "buildingName": "string",
46 "fax": "string",
47 "erpSystemId": 0,
48 "erpSystemDisplayId": "string",
49 "partnerId": 0,
50 "contactRoleId": 0
51 }
52 ],
53 "removed": [
54 {
55 "id": 0,
56 "status": "CREATED",
57 "displayId": "string",
58 "name": "string",
59 "email": "string",
60 "phone": "string",
61 "position": "string",
62 "address": "string",
63 "group": "string",
64 "buildingName": "string",
65 "fax": "string",
66 "erpSystemId": 0,
67 "erpSystemDisplayId": "string",
68 "partnerId": 0,
69 "contactRoleId": 0
70 }
71 ]
72 },
73 "hasChanges": true
74}
Get Full Vendor Details From Payable Context¶
HTTP Request
GET /api/v1/vendor-request/payable/vendors/{vendorId}
📋 Description: Returns the enriched vendor form data for a specific vendor as stored in the Payable module, including Payable-specific fields not present in FOS.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
vendorId |
path |
integer(int64) |
true |
Payable vendor ID |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
||
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
Example Responses
1{
2 "id": 0,
3 "displayId": "string",
4 "state": "INV_DRAFT",
5 "vendorId": 0,
6 "vendorDisplayId": "string",
7 "vendorName": "string",
8 "vendorPhone": "string",
9 "vendorFax": "string",
10 "erpSystem": {
11 "id": 0,
12 "displayId": "string",
13 "status": "CREATED",
14 "name": "string",
15 "type": "NAKISA",
16 "sapVersion": "ECC_EHP5"
17 },
18 "vendorParent": {
19 "id": 0,
20 "displayId": "string",
21 "status": "CREATED",
22 "name": "string",
23 "erpSystemDisplayId": "string"
24 },
25 "operation": "VENDOR_CREATE",
26 "operationReason": "string",
27 "companies": [
28 {
29 "id": 0,
30 "displayId": "string",
31 "changeType": "ADD",
32 "vendorRequestId": 0,
33 "vendorRequestDisplayId": "string",
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 "allowsSystemGenerateNewId": true,
47 "numberRangeIdentifierValue": "string",
48 "numberRangeIdentifierType": {
49 "name": "string"
50 },
51 "numberRangeType": {
52 "name": "string"
53 }
54 }
55 ],
56 "companiesTotal": 0,
57 "partnerRoles": [
58 {
59 "id": 0,
60 "displayId": "string",
61 "changeType": "ADD",
62 "vendorRequestId": 0,
63 "vendorRequestDisplayId": "string",
64 "partnerRole": {
65 "id": 0,
66 "displayId": "string",
67 "status": "CREATED",
68 "name": "string"
69 },
70 "allowsSystemGenerateNewId": true,
71 "numberRangeIdentifierValue": "string",
72 "numberRangeIdentifierType": {
73 "name": "string"
74 },
75 "numberRangeType": {
76 "name": "string"
77 }
78 }
79 ],
80 "partnerRolesTotal": 0,
81 "partnerContacts": [
82 {
83 "id": 0,
84 "displayId": "string",
85 "changeType": "ADD",
86 "vendorRequestId": 0,
87 "vendorRequestDisplayId": "string",
88 "createdPartnerContactDisplayId": "string",
89 "name": "string",
90 "email": "string",
91 "phone": "string",
92 "position": "string",
93 "address": "string",
94 "group": "string",
95 "buildingName": "string",
96 "fax": "string",
97 "erpSystem": {
98 "id": 0,
99 "displayId": "string",
100 "status": "CREATED",
101 "name": "string",
102 "type": "NAKISA",
103 "sapVersion": "ECC_EHP5"
104 },
105 "partnerContact": {
106 "id": 0,
107 "displayId": "string",
108 "status": "CREATED",
109 "name": "string"
110 },
111 "allowsSystemGenerateNewId": true,
112 "numberRangeIdentifierValue": "string",
113 "numberRangeIdentifierType": {
114 "name": "string"
115 },
116 "numberRangeType": {
117 "name": "string"
118 }
119 }
120 ],
121 "partnerContactsTotal": 0,
122 "vendorState": "CREATED",
123 "hasLinkedProgressingChangeRequest": true,
124 "allowsSystemGenerateNewId": true,
125 "numberRangeIdentifierValue": "string",
126 "numberRangeIdentifierType": {
127 "name": "string"
128 },
129 "numberRangeType": {
130 "name": "string"
131 }
132}