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

status string

Default: draft

supplier string required
total_score number
start_date string required
end_date string required
scorecard string required
The Supplier Scorecard Period object 
{
  "id": "supplier-scorecard-period_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "supplier": "supplier_example",
  "total_score": 0,
  "start_date": "2024-01-15",
  "end_date": "2024-01-15",
  "scorecard": "scorecard_example"
}
GET /api/buying/supplier-scorecard-period/{id}

Retrieve a supplier scorecard period

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

Path parameters

id string required

The identifier of the supplier scorecard period to retrieve.

Returns

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

GET /api/buying/supplier-scorecard-period/{id} 
curl https://api.overplane.dev/api/buying/supplier-scorecard-period/supplier-scorecard-period_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "supplier-scorecard-period_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "supplier": "supplier_example",
  "total_score": 0,
  "start_date": "2024-01-15",
  "end_date": "2024-01-15",
  "scorecard": "scorecard_example"
}
GET /api/buying/supplier-scorecard-period

List all supplier scorecard periods

Returns a list of supplier scorecard periods. 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 period objects.

GET /api/buying/supplier-scorecard-period 
curl https://api.overplane.dev/api/buying/supplier-scorecard-period \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "supplier-scorecard-period_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "status": "draft",
      "supplier": "supplier_example",
      "total_score": 0,
      "start_date": "2024-01-15",
      "end_date": "2024-01-15",
      "scorecard": "scorecard_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/buying/supplier-scorecard-period

Create a supplier scorecard period

Creates a new supplier scorecard period object.

Body parameters

status string

Default: draft

supplier string required
total_score number
start_date string required
end_date string required
scorecard string required

Returns

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

POST /api/buying/supplier-scorecard-period 
curl https://api.overplane.dev/api/buying/supplier-scorecard-period \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"supplier":"supplier_example","start_date":"2024-01-15","end_date":"2024-01-15","scorecard":"scorecard_example"}'
Response 
{
  "id": "supplier-scorecard-period_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "supplier": "supplier_example",
  "total_score": 0,
  "start_date": "2024-01-15",
  "end_date": "2024-01-15",
  "scorecard": "scorecard_example"
}
PATCH /api/buying/supplier-scorecard-period/{id}

Update a supplier scorecard period

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

Body parameters

status string

Default: draft

supplier string
total_score number
start_date string
end_date string
scorecard string

Returns

Returns the updated supplier scorecard period object.

PATCH /api/buying/supplier-scorecard-period/{id} 
curl https://api.overplane.dev/api/buying/supplier-scorecard-period/supplier-scorecard-period_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"status":"draft","supplier":"supplier_example"}'
Response 
{
  "id": "supplier-scorecard-period_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "supplier": "supplier_example",
  "total_score": 0,
  "start_date": "2024-01-15",
  "end_date": "2024-01-15",
  "scorecard": "scorecard_example"
}
DELETE /api/buying/supplier-scorecard-period/{id}

Delete a supplier scorecard period

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

Path parameters

id string required

The identifier of the supplier scorecard period to delete.

Returns

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

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

Submit a supplier scorecard period

Submits a draft supplier scorecard period, transitioning its status from draft to submitted.

Path parameters

id string required

The identifier of the supplier scorecard period to act on.

Returns

Returns the supplier scorecard period object with updated status.

POST /api/buying/supplier-scorecard-period/{id}/submit 
curl https://api.overplane.dev/api/buying/supplier-scorecard-period/supplier-scorecard-period_abc123/submit \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "supplier-scorecard-period_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "supplier": "supplier_example",
  "total_score": 0,
  "start_date": "2024-01-15",
  "end_date": "2024-01-15",
  "scorecard": "scorecard_example"
}
POST /api/buying/supplier-scorecard-period/{id}/cancel

Cancel a supplier scorecard period

Cancels a submitted supplier scorecard period, transitioning its status to cancelled.

Path parameters

id string required

The identifier of the supplier scorecard period to act on.

Returns

Returns the supplier scorecard period object with updated status.

POST /api/buying/supplier-scorecard-period/{id}/cancel 
curl https://api.overplane.dev/api/buying/supplier-scorecard-period/supplier-scorecard-period_abc123/cancel \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "supplier-scorecard-period_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "supplier": "supplier_example",
  "total_score": 0,
  "start_date": "2024-01-15",
  "end_date": "2024-01-15",
  "scorecard": "scorecard_example"
}

Line items

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

Supplier Scorecard Scoring Variable

Attributes

idx integer
supplier_scorecard_period_id string required
variable_label string required
description string
value number
param_name string
path string

Endpoints

GET /api/buying/supplier-scorecard-scoring-variable?parent_id={id}
POST /api/buying/supplier-scorecard-scoring-variable
PATCH /api/buying/supplier-scorecard-scoring-variable/{id}
DELETE /api/buying/supplier-scorecard-scoring-variable/{id}
POST /api/buying/supplier-scorecard-scoring-variable/reorder
Supplier Scorecard Scoring Variable object 
{
  "id": "supplier-scorecard-scoring-variable_abc123",
  "idx": 1,
  "supplier_scorecard_period_id": "supplier_scorecard_period_id_example",
  "variable_label": "variable_label_example",
  "description": "description_example",
  "value": 0,
  "param_name": "param_name_example",
  "path": "path_example"
}