List canon counterparty type rows

Canon module

GET/canon/counterparty-typescanonCounterpartyTypes.list

A vendor counterparty type. Returns a cursor page of canon counterparty type rows the caller may see. The default order is `counterparty_type` ascending. Supports sparse fieldsets and the filter grammar.

Requires the capability canon.taxonomy.read.
OAuth scopes: canon.
Cursor-paginated: limit, cursor, fields, sort and filter apply.
Error statuses: 400, 401, 429. Errors are RFC 9457 problem details.

Path and query parameters

canonCounterpartyTypes.list: Path and query parameters
Field	Type	Required	Description
limit	Limit	No	Page size. Default 50, maximum 200.Constraints: range 1 to 200
cursor	Cursor	No	Opaque cursor from `next_cursor` of the previous page.Constraints: length 1 to any
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_])*$
sort	Sort	No	Sort keys, comma-separated; a leading `-` sorts descending. Without `sort`, the documented default order applies (coded lists sort in numeric code order).Constraints: pattern ^-?[a-z_][a-z0-9_](,-?[a-z_][a-z0-9_])*$
filter	Filter	No	Filter grammar `filter[field][op]=value`. Operators: eq, ne, lt, lte, gt, gte, in (comma-separated values), is_null (true or false) and contains. Conditions combine with AND.

Response 200: a page of CanonCounterpartyType

canonCounterpartyTypes.list: 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

{
  "data": [
    {
      "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"
    }
  ],
  "next_cursor": null
}

Code samples

curl -X GET "$XOS_BASE_URL/canon/counterparty-types" \
  -H "Authorization: Bearer $XOS_API_KEY"

for await (const row of xos.canonCounterpartyTypes.listAll()) {
  console.log(row);
}

for row in xos.canon_counterparty_types.list_all():
    print(row)

xos canon-counterparty-types list --all