Skip to main content
GET
/
v1
/
payroll
/
schemes
/
{country}
List available payroll schemes for a country
curl --request GET \
  --url https://api.example.com/v1/payroll/schemes/{country}
{
  "country": "<string>",
  "schemes": [
    {
      "id": "<string>",
      "legal_name": "<string>",
      "country": "<string>",
      "currency": "<string>",
      "effective_from": "<string>",
      "effective_until": "<string>",
      "version": "<string>",
      "status": "active",
      "concept_count": 123,
      "legal_references": [
        "<string>"
      ],
      "dsl_path": "<string>",
      "changelog": [
        {}
      ]
    }
  ],
  "total": 123
}

Path Parameters

country
string
required

ISO 3166-1 alpha-2 country code

Pattern: ^[A-Za-z]{2}$
Example:

"MX"

Response

Scheme list returned.

Response for GET /v1/payroll/schemes/{country}.

country
string
required
schemes
SchemeInfo · object[]
required
total
integer
required