Get a canon counterparty type
Canon module
GET/canon/counterparty-types/{counterparty_type}canonCounterpartyTypes.get
A vendor counterparty type. Returns one canon counterparty type with its `ETag`. A canon counterparty type the caller may not see returns 404.
- Requires the capability canon.taxonomy.read.
- OAuth scopes: canon.
- Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| counterparty_type | CounterpartyType | Yes | Counterparty type from `xpms.dim_counterparty_type`.Constraints: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]*( [A-Za-z0-9&'/.()-]+)*$ |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
Response 200: CanonCounterpartyType
| Field | Type | Required | Description |
|---|---|---|---|
| counterparty_type | CounterpartyType | Yes | Counterparty type from `xpms.dim_counterparty_type`.Constraints: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]*( [A-Za-z0-9&'/.()-]+)*$ |
| definition | string | Yes | Definition, in sentence case.Constraints: length 1 to 20000 |
| classification_code | string | null | Yes | Classification code.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| vendor_class | string | null | Yes | Vendor class.Constraints: length 1 to 100 |
| clearance_tier | string | null | Yes | Clearance tier.Constraints: length 1 to 200 |
| default_account_code | GlAccountCode | null | Yes |
{
"counterparty_type": "AV Integrator",
"definition": "Designs and installs audiovisual systems.",
"classification_code": "CP-AVINT",
"vendor_class": "Class B",
"clearance_tier": "Tier 2 - Technical Lead",
"default_account_code": "5400"
}Code samples
curl -X GET "$XOS_BASE_URL/canon/counterparty-types/AV%20Integrator" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.canonCounterpartyTypes.get("AV Integrator");response = xos.canon_counterparty_types.get("AV Integrator")xos canon-counterparty-types get AV Integrator