Scorecards

Toolkit Scorecards represent B-BBEE scorecards generated within BEEtoolkit, covering all pillars such as Ownership, Management Control, Skills Development, Enterprise/Supplier Development, and SED. These APIs allow you to programmatically create, retrieve, update, and delete scorecards.

Each scorecard has a unique ID used for all subsequent interactions.

---

Endpoints

Method	Path	Purpose
GET	/api/public/v1/scorecards	Retrieve all scorecards
GET	/api/public/v1/scorecards/{scorecard_id}	Retrieve a specific scorecard
POST	/api/public/v1/scorecards	Create a new scorecard
PUT	/api/public/v1/scorecards/{scorecard_id}	Update an existing scorecard
DELETE	/api/public/v1/scorecards/{scorecard_id}	Delete a scorecard

All requests must be authenticated using your API key and HMAC signature.

---

Scorecard Attributes

Unless otherwise specified, all fields are optional.

Attribute	Example	Description
description	"YTD Scorecard Nov 2024"	Free-text description for internal use
start_date	"2024-01-01"	Start date for the scorecard period (YYYY-MM-DD)
end_date	"2024-11-30"	End date for the scorecard period (YYYY-MM-DD)
charter_id	"bravo_generic"	B-BBEE charter used for calculations (see list below)
province	"National"	Province used for reporting and funding allocation

---

Notes

• Dates must be in ISO8601 format (YYYY-MM-DD).
• charter_id must match one of the accepted charter IDs listed below.
• Updates are partial — only send the fields you want to modify.
• The API returns structured JSON representing the full scorecard record.

---

Example: Creating a Toolkit Scorecard

const url = "https://www.beetoolkit.co.za/api/public/v1/scorecards";
const payload = {
  scorecard: {
    description: "YTD Scorecard Nov 2024",
    start_date: "2024-01-01",
    end_date: "2024-11-30",
    charter_id: "bravo_generic",
    province: "National"
  }
};

await axios.post(url, payload, {
  headers: {
    Accept: "application/json",
    Authorization: "HMAC <your signature>",
    "X-Api-Key": "<your account key>"
  }
});

---

Accepted Charter IDs

The following values are accepted for charter_id:

• bravo_generic
• bravo_agri
• bravo_forestry
• bravo_transport_public_sector
• bravo_construction_built_environment_professionals
• bravo_construction_contractors
• bravo_specialised
• bravo_tourism
• bravo_specialised_ict
• bravo_ict
• bravo_mac
• bravo_transport_road_freight
• bravo_transport_bus_commuter
• bravo_transport_coach_services
• bravo_financial_long_term
• bravo_financial_short_term
• bravo_financial_other
• bravo_financial_specialised
• bravo_financial_stock_exchanges
• bravo_financial_banking
• bravo_property_internal_management
• bravo_property_owners
• bravo_defence
• bravo_legal_attorneys