The Supplier Scorecard 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.

supplier string
supplier_score string
indicator_color string
status string
period string

Default: Per Month

weighting_function string

Default: {total_score} * max( 0, min ( 1 , (12 - {period_number}) / 12) )

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 string
The Supplier Scorecard object 
{
  "id": "supplier-scorecard_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "supplier": "supplier_example",
  "supplier_score": "supplier_score_example",
  "indicator_color": "indicator_color_example",
  "status": "draft",
  "period": "Per Month",
  "weighting_function": "{total_score} * max( 0, min ( 1 , (12 - {period_number}) / 12) )",
  "warn_rfqs": false,
  "warn_pos": false,
  "prevent_rfqs": false,
  "prevent_pos": false,
  "notify_supplier": false,
  "notify_employee": false,
  "employee": "employee_example"
}
GET /api/buying/supplier-scorecard/{id}

Retrieve a supplier scorecard

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

Path parameters

id string required

The identifier of the supplier scorecard to retrieve.

Returns

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

GET /api/buying/supplier-scorecard/{id} 
curl https://api.overplane.dev/api/buying/supplier-scorecard/supplier-scorecard_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "supplier-scorecard_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "supplier": "supplier_example",
  "supplier_score": "supplier_score_example",
  "indicator_color": "indicator_color_example",
  "status": "draft",
  "period": "Per Month",
  "weighting_function": "{total_score} * max( 0, min ( 1 , (12 - {period_number}) / 12) )",
  "warn_rfqs": false,
  "warn_pos": false,
  "prevent_rfqs": false,
  "prevent_pos": false,
  "notify_supplier": false,
  "notify_employee": false,
  "employee": "employee_example"
}
GET /api/buying/supplier-scorecard

List all supplier scorecards

Returns a list of supplier scorecards. 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 objects.

GET /api/buying/supplier-scorecard 
curl https://api.overplane.dev/api/buying/supplier-scorecard \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "supplier-scorecard_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "supplier": "supplier_example",
      "supplier_score": "supplier_score_example",
      "indicator_color": "indicator_color_example",
      "status": "draft",
      "period": "Per Month",
      "weighting_function": "{total_score} * max( 0, min ( 1 , (12 - {period_number}) / 12) )",
      "warn_rfqs": false,
      "warn_pos": false,
      "prevent_rfqs": false,
      "prevent_pos": false,
      "notify_supplier": false,
      "notify_employee": false,
      "employee": "employee_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/buying/supplier-scorecard

Create a supplier scorecard

Creates a new supplier scorecard object.

Body parameters

supplier string
supplier_score string
indicator_color string
status string
period string

Default: Per Month

weighting_function string

Default: {total_score} * max( 0, min ( 1 , (12 - {period_number}) / 12) )

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 string

Returns

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

POST /api/buying/supplier-scorecard 
curl https://api.overplane.dev/api/buying/supplier-scorecard \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json"
Response 
{
  "id": "supplier-scorecard_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "supplier": "supplier_example",
  "supplier_score": "supplier_score_example",
  "indicator_color": "indicator_color_example",
  "status": "draft",
  "period": "Per Month",
  "weighting_function": "{total_score} * max( 0, min ( 1 , (12 - {period_number}) / 12) )",
  "warn_rfqs": false,
  "warn_pos": false,
  "prevent_rfqs": false,
  "prevent_pos": false,
  "notify_supplier": false,
  "notify_employee": false,
  "employee": "employee_example"
}
PATCH /api/buying/supplier-scorecard/{id}

Update a supplier scorecard

Updates the specified supplier scorecard 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 to update.

Body parameters

supplier string
supplier_score string
indicator_color string
status string
period string

Default: Per Month

weighting_function string

Default: {total_score} * max( 0, min ( 1 , (12 - {period_number}) / 12) )

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 string

Returns

Returns the updated supplier scorecard object.

PATCH /api/buying/supplier-scorecard/{id} 
curl https://api.overplane.dev/api/buying/supplier-scorecard/supplier-scorecard_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"supplier":"supplier_example","supplier_score":"supplier_score_example"}'
Response 
{
  "id": "supplier-scorecard_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "supplier": "supplier_example",
  "supplier_score": "supplier_score_example",
  "indicator_color": "indicator_color_example",
  "status": "draft",
  "period": "Per Month",
  "weighting_function": "{total_score} * max( 0, min ( 1 , (12 - {period_number}) / 12) )",
  "warn_rfqs": false,
  "warn_pos": false,
  "prevent_rfqs": false,
  "prevent_pos": false,
  "notify_supplier": false,
  "notify_employee": false,
  "employee": "employee_example"
}
DELETE /api/buying/supplier-scorecard/{id}

Delete a supplier scorecard

Permanently deletes a supplier scorecard. This cannot be undone.

Path parameters

id string required

The identifier of the supplier scorecard to delete.

Returns

Returns a confirmation that the supplier scorecard has been deleted.

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

Line items

Child objects that belong to this supplier scorecard. These are accessed via the parent's ID.

Supplier Scorecard Scoring Standing

Attributes

idx integer
supplier_scorecard_id string required
standing_name string
standing_color string
min_grade number
max_grade number
warn_rfqs boolean
warn_pos boolean
prevent_rfqs boolean
prevent_pos boolean
notify_supplier boolean
notify_employee boolean
employee_link string

Endpoints

GET /api/buying/supplier-scorecard-scoring-standing?parent_id={id}
POST /api/buying/supplier-scorecard-scoring-standing
PATCH /api/buying/supplier-scorecard-scoring-standing/{id}
DELETE /api/buying/supplier-scorecard-scoring-standing/{id}
POST /api/buying/supplier-scorecard-scoring-standing/reorder
Supplier Scorecard Scoring Standing object 
{
  "id": "supplier-scorecard-scoring-standing_abc123",
  "idx": 1,
  "supplier_scorecard_id": "supplier_scorecard_id_example",
  "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"
}