The Supplier Scorecard Standing object

Attributes

id string

Unique identifier for the object.

created_at string

ISO 8601 timestamp of when the object was created.

updated_at string

ISO 8601 timestamp of when the object was last updated.

standing_name string
standing_color string
min_grade number
max_grade number
warn_rfqs boolean

Default: false

warn_pos boolean

Default: false

prevent_rfqs boolean

Default: false

prevent_pos boolean

Default: false

notify_supplier boolean

Default: false

notify_employee boolean

Default: false

employee_link string
The Supplier Scorecard Standing object 
{
  "id": "supplier-scorecard-standing_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "standing_name": "standing_name_example",
  "standing_color": "standing_color_example",
  "min_grade": 0,
  "max_grade": 0,
  "warn_rfqs": false,
  "warn_pos": false,
  "prevent_rfqs": false,
  "prevent_pos": false,
  "notify_supplier": false,
  "notify_employee": false,
  "employee_link": "employee_link_example"
}
GET /api/buying/supplier-scorecard-standing/{id}

Retrieve a supplier scorecard standing

Retrieves the details of an existing supplier scorecard standing. Supply the unique supplier scorecard standing ID that was returned from a previous request.

Path parameters

id string required

The identifier of the supplier scorecard standing to retrieve.

Returns

Returns the supplier scorecard standing object if a valid identifier was provided.

GET /api/buying/supplier-scorecard-standing/{id} 
curl https://api.overplane.dev/api/buying/supplier-scorecard-standing/supplier-scorecard-standing_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "supplier-scorecard-standing_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "standing_name": "standing_name_example",
  "standing_color": "standing_color_example",
  "min_grade": 0,
  "max_grade": 0,
  "warn_rfqs": false,
  "warn_pos": false,
  "prevent_rfqs": false,
  "prevent_pos": false,
  "notify_supplier": false,
  "notify_employee": false,
  "employee_link": "employee_link_example"
}
GET /api/buying/supplier-scorecard-standing

List all supplier scorecard standings

Returns a list of supplier scorecard standings. The results are sorted by creation date, with the most recently created appearing first.

Query parameters

limit integer

Maximum number of objects to return. Default: 20.

offset integer

Number of objects to skip for pagination. Default: 0.

Returns

A paginated list of supplier scorecard standing objects.

GET /api/buying/supplier-scorecard-standing 
curl https://api.overplane.dev/api/buying/supplier-scorecard-standing \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "supplier-scorecard-standing_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "standing_name": "standing_name_example",
      "standing_color": "standing_color_example",
      "min_grade": 0,
      "max_grade": 0,
      "warn_rfqs": false,
      "warn_pos": false,
      "prevent_rfqs": false,
      "prevent_pos": false,
      "notify_supplier": false,
      "notify_employee": false,
      "employee_link": "employee_link_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/buying/supplier-scorecard-standing

Create a supplier scorecard standing

Creates a new supplier scorecard standing object.

Body parameters

standing_name string
standing_color string
min_grade number
max_grade number
warn_rfqs boolean

Default: false

warn_pos boolean

Default: false

prevent_rfqs boolean

Default: false

prevent_pos boolean

Default: false

notify_supplier boolean

Default: false

notify_employee boolean

Default: false

employee_link string

Returns

Returns the newly created supplier scorecard standing object if the call succeeded.

POST /api/buying/supplier-scorecard-standing 
curl https://api.overplane.dev/api/buying/supplier-scorecard-standing \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json"
Response 
{
  "id": "supplier-scorecard-standing_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "standing_name": "standing_name_example",
  "standing_color": "standing_color_example",
  "min_grade": 0,
  "max_grade": 0,
  "warn_rfqs": false,
  "warn_pos": false,
  "prevent_rfqs": false,
  "prevent_pos": false,
  "notify_supplier": false,
  "notify_employee": false,
  "employee_link": "employee_link_example"
}
PATCH /api/buying/supplier-scorecard-standing/{id}

Update a supplier scorecard standing

Updates the specified supplier scorecard standing by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path parameters

id string required

The identifier of the supplier scorecard standing to update.

Body parameters

standing_name string
standing_color string
min_grade number
max_grade number
warn_rfqs boolean

Default: false

warn_pos boolean

Default: false

prevent_rfqs boolean

Default: false

prevent_pos boolean

Default: false

notify_supplier boolean

Default: false

notify_employee boolean

Default: false

employee_link string

Returns

Returns the updated supplier scorecard standing object.

PATCH /api/buying/supplier-scorecard-standing/{id} 
curl https://api.overplane.dev/api/buying/supplier-scorecard-standing/supplier-scorecard-standing_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"standing_name":"standing_name_example","standing_color":"standing_color_example"}'
Response 
{
  "id": "supplier-scorecard-standing_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "standing_name": "standing_name_example",
  "standing_color": "standing_color_example",
  "min_grade": 0,
  "max_grade": 0,
  "warn_rfqs": false,
  "warn_pos": false,
  "prevent_rfqs": false,
  "prevent_pos": false,
  "notify_supplier": false,
  "notify_employee": false,
  "employee_link": "employee_link_example"
}
DELETE /api/buying/supplier-scorecard-standing/{id}

Delete a supplier scorecard standing

Permanently deletes a supplier scorecard standing. This cannot be undone.

Path parameters

id string required

The identifier of the supplier scorecard standing to delete.

Returns

Returns a confirmation that the supplier scorecard standing has been deleted.

DELETE /api/buying/supplier-scorecard-standing/{id} 
curl https://api.overplane.dev/api/buying/supplier-scorecard-standing/supplier-scorecard-standing_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "supplier-scorecard-standing_abc123",
  "deleted": true
}