Vendor Rate Resource¶
Get Vendor Rate¶
HTTP Request
GET /api/vendorRates/{id}
📋 Description: Retrieves detailed information about a specific vendor rate identified by the unique ID, enabling users to assess pricing structures and make informed procurement decisions.
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 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "displayId": "string",
6 "name": "string",
7 "objectAvailable": true
8}
Update Vendor Rate¶
HTTP Request
PUT /api/vendorRates/{id}
📋 Description: Updates the vendor rate associated with the specified ID, allowing businesses to maintain accurate and current pricing information for vendor services.
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 rate information, including pricing details and effective dates, to ensure accurate financial management and vendor relationship optimization. |
Body Parameters
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "displayId": "string",
6 "name": "string",
7 "objectAvailable": true
8}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1{}
Response Schema
Delete Vendor Rate¶
HTTP Request
DELETE /api/vendorRates/{id}
📋 Description: Deletes a specific vendor rate identified by the provided ID, ensuring that outdated or unnecessary vendor rate information is effectively removed from the system.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
204 |
No Content |
None |
Get All Vendor Rate¶
HTTP Request
GET /api/vendorRates
📋 Description: Fetches vendor rate information, enabling users to access and evaluate pricing structures for vendor services.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 {
3 "id": 0,
4 "createdBy": "string",
5 "createdAt": "2019-08-24T14:15:22Z",
6 "displayId": "string",
7 "name": "string",
8 "objectAvailable": true
9 }
10]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing the pricing structure and terms associated with a vendor’s services, enabling effective cost management and decision-making in procurement processes.] |
|
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» createdBy |
string |
false |
none |
Username of who created this resource |
» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
» displayId |
string |
false |
none |
Unique identifier for the display |
» name |
string |
true |
none |
Name of the resource |
» objectAvailable |
boolean |
false |
none |
Indicates whether the vendor rate object is currently available for use in the system. |
Create Vendor Rate¶
HTTP Request
POST /api/vendorRates
📋 Description: Creates a new vendor rate entry in the system, enabling businesses to manage and optimize vendor pricing effectively.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the vendor rate details, including pricing, terms, and associated metadata for effective vendor management. |
Body Parameters
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "displayId": "string",
6 "name": "string",
7 "objectAvailable": true
8}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
Inline |
Example Responses
1{}