Get a canon counterparty type

Módulo Canon

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.

Requiere la capacidad canon.taxonomy.read.
Alcances de OAuth: canon.
Estados de error: 400, 401, 404, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

canonCounterpartyTypes.get: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
counterparty_type	CounterpartyType	Sí	Counterparty type from `xpms.dim_counterparty_type`.Restricciones: 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.Restricciones: pattern ^[a-z_][a-z0-9_](,[a-z_][a-z0-9_])*$

Respuesta 200: CanonCounterpartyType

canonCounterpartyTypes.get: CanonCounterpartyType
Campo	Tipo	Obligatorio	Descripción
counterparty_type	CounterpartyType	Sí	Counterparty type from `xpms.dim_counterparty_type`.Restricciones: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]( [A-Za-z0-9&'/.()-]+)$
definition	string	Sí	Definition, in sentence case.Restricciones: length 1 to 20000
classification_code	string \| null	Sí	Classification code.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
vendor_class	string \| null	Sí	Vendor class.Restricciones: length 1 to 100
clearance_tier	string \| null	Sí	Clearance tier.Restricciones: length 1 to 200
default_account_code	GlAccountCode \| null	Sí

{
  "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"
}

Ejemplos de código

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