Create a vendor scorecard
Vendors module
POST/vendor-scorecardsvendorScorecards.create
A vendor scorecard for an engagement or project. Creates a vendor scorecard. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.
- Requires the capability vendors.scorecard.write.
- OAuth scopes: vendors.
- Send an Idempotency-Key header. A replay with the same key returns the original response.
- Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.
Request body: VendorScorecardCreate
| Field | Type | Required | Description |
|---|---|---|---|
| vendor_id | string (uuid) | Yes | Identifier of the vendor. |
| project_id | string (uuid) | null | No | Identifier of the project. |
| note | string | null | No | Internal notes.Constraints: length 1 to 20000 |
| period_end | string (date) | Yes | Last day of the period scored. |
| quality_score | integer | null | No | Quality, 1 to 5; null when not scored.Constraints: range 1 to any |
| delivery_score | integer | null | No | On-time delivery, 1 to 5; null when not scored.Constraints: range 1 to any |
| safety_score | integer | null | No | Safety, 1 to 5; null when not scored.Constraints: range 1 to any |
{
"vendor_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"note": "On time; one damaged deck.",
"period_end": "2026-10-08",
"quality_score": 4,
"delivery_score": 4,
"safety_score": 4
}Response 201: VendorScorecard
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the vendor scorecard. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| vendor_id | string (uuid) | Yes | Identifier of the vendor. |
| project_id | string (uuid) | null | Yes | Identifier of the project. |
| note | string | null | Yes | Internal notes.Constraints: length 1 to 20000 |
| period_end | string (date) | Yes | Last day of the period scored. |
| quality_score | integer | null | Yes | Quality, 1 to 5; null when not scored.Constraints: range 1 to any |
| delivery_score | integer | null | Yes | On-time delivery, 1 to 5; null when not scored.Constraints: range 1 to any |
| safety_score | integer | null | Yes | Safety, 1 to 5; null when not scored.Constraints: range 1 to any |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"vendor_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"note": "On time; one damaged deck.",
"period_end": "2026-10-08",
"quality_score": 4,
"delivery_score": 4,
"safety_score": 4
}Code samples
curl -X POST "$XOS_BASE_URL/vendor-scorecards" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"vendor_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","note":"On time; one damaged deck.","period_end":"2026-10-08","quality_score":4,"delivery_score":4,"safety_score":4}'const { data } = await xos.vendorScorecards.create({
"vendor_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"note": "On time; one damaged deck.",
"period_end": "2026-10-08",
"quality_score": 4,
"delivery_score": 4,
"safety_score": 4
});response = xos.vendor_scorecards.create({"vendor_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "note": "On time; one damaged deck.", "period_end": "2026-10-08", "quality_score": 4, "delivery_score": 4, "safety_score": 4})xos vendor-scorecards create --data '{"vendor_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","note":"On time; one damaged deck.","period_end":"2026-10-08","quality_score":4,"delivery_score":4,"safety_score":4}'