api_external.engagements
View
The caller's external engagements (Section 8.7): their own, their account's or a represented artist's, while the engagement area is open. The rate is the party's own and appears only while the money area is open; internal notes never appear.
| Column | Type | Nullable | Description |
|---|---|---|---|
| id | uuid | Yes | Engagement. |
| org_id | uuid | Yes | Engaging org. |
| org_name | text | Yes | Engaging org name. |
| project_id | uuid | Yes | Project. |
| project_name | text | Yes | Project name. |
| role_type | app.external_role_type | Yes | External role type. |
| role_code | text | Yes | Canon role. |
| job_title | xpms.canon_text | Yes | Job title from the Roles Library. |
| person_id | uuid | Yes | Engaged person. |
| account_id | uuid | Yes | Engaged external account. |
| pay_basis | text | Yes | Pay basis. |
| arrangement | text | Yes | Arrangement. |
| rate_minor | bigint | Yes | The party's rate in minor units while the money area is open; NULL otherwise or when unpaid. |
| rate_currency_code | bpchar | Yes | Currency of the rate. |
| start_date | date | Yes | First day. |
| end_date | date | Yes | Last day. |
| engagement_state | app.engagement_state | Yes | Engagement state. |
| areas | text[] | Yes | Areas open to the caller: engagement, documents, onboarding, operational, money. |
| project_time_zone | text | Yes | IANA time zone of the engagement's project: the calendar its dates (due today, this week, the default invoice date) follow. |