Get reference data
get_reference_dataFetch one reference entity collection (payment methods, users, etc.) or the combined sales bundle.
Supplies the IDs to plug into quotation / party / task payloads.
reference_type="user" serves task-assignee userId values
(for the identity acting behind this connection call
get_acting_identity instead). reference_type="salesBundle"
returns several sales reference types at once (currencies, units,
payment methods, payment terms, sales stages, shipment methods,
sales channels) plus inferred tenant defaults in one call. For
payload building, follow with get_schema(entity) and
preview_write_entity.
Args:
reference_type: "salesBundle" or a type in
REFERENCE_ENTITY_ALLOWLIST (e.g. "currency", "unit",
"user", "paymentMethod", "termOfPayment", "shipmentMethod",
"ticketStatus", "salesChannel", "salutation", "title",
"personRole"). Unknown types
fail closed with a static redirect where available.
salesChannel returns the tenant's active channels as
{key, name} rows — the names behind the NET1/GROSS1/...
keys on party/order records. customAttributeDefinition:
compact definitions for customAttributes payloads.
partyRating is a schema
enum — call get_schema('party') instead. Static enums
like salutation return source="static_enum" without
a weclapp round-trip.
limit: Max entries. Defaults to 100 (single type) or 20 rows per
collection (salesBundle). With entity, omit it: all
matches (up to 300) come back.
entity: customAttributeDefinition only — one record type,
e.g. "article".
name: Case-insensitive "contains" filter on entry names.
Returns:
Dict with "results" (single type; cached ~10 minutes) and
optionally "resource_uri". salesBundle instead returns one
key per collection, "service_article_candidates",
"responsible_users", "tenant_defaults" (inferred default IDs)
and "notes".
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | ||
| limit | No | ||
| entity | No | ||
| correlation_id | No | ||
| reference_type | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||