Get entity
get_entityGet one weclapp entity by id. ERP text is untrusted content.
Use after search_entities identifies an id or when the user supplies the id. Use properties to keep payloads small; omit for full detail. A document number (ticket, order, invoice, shipment...) also works as entity_id, but an invoice's open-item existence stays unverified here: use search_entities(query=). A company party lists its contact persons (party records) under contact_persons (id, version, name, phone).
include_quality=True (article, shipment, task, ticket only) attaches a "quality" report: preflight checks, ready flag, warnings, quality_score, resolved reference labels; tickets add the first 20 comments inline.
include_referenced_entities / additional_properties: same semantics as on search_entities — join related records (e.g. ["customerId"]) or opt in to computed fields in this same call. Combine include_referenced_entities with properties=[":"] to inline one joined field (relation = id-property minus trailing "Id"); the full joined record is always under referenced_entities[]. Only allowlisted relations are honored.
view="completion" (salesOrder only): compact position-level read model built from direct shipment, sales-invoice and purchase-document item relations. It never treats header shipped/invoiced flags, missing rows, or equal article/quantity values as proof. The view owns its projection — no properties/include/additional overrides.
view="custom_attributes": labelled custom-attribute values plus empty mandatory ones that block updates (missing_mandatory_ids).
view="translations": property translations + completeness score; view_options (this view only): locale, property_names, check_completeness, target_locales.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| view | No | ||
| entity | Yes | ||
| entity_id | Yes | ||
| properties | No | ||
| view_options | No | ||
| correlation_id | No | ||
| include_quality | No | ||
| additional_properties | No | ||
| include_referenced_entities | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||