Project data model
View field support, webhooks, and list parameters for each integration on the Supported Integrations page.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | |
created_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
name | string | No | |
code | string | No | provider-side project code/number (e.g. NetSuite entityId, Intacct PROJECTID, BC jobNumber) |
description | string | No | |
status | enum | No | Values: NOT_STARTED, IN_PROGRESS, ON_HOLD, COMPLETED, CANCELLED, CLOSED |
is_active | boolean | No | |
is_billable | boolean | No | |
contact_id | string | No | the customer the project is for (reference to AccountingContact) |
parent_id | string | No | parent project / sub-project hierarchy |
manager_user_id | string | No | references a HRIS employee/user (reference to HrisEmployee) |
started_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
due_at | string (date-time) | No | planned/target end date (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
ended_at | string (date-time) | No | actual completion (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
currency | string | No | |
estimate_amount | number | No | |
estimated_cost_amount | number | No | |
actual_cost_amount | number | No | |
invoiced_amount | number | No | |
to_be_invoiced_amount | number | No | |
expense_amount | number | No | |
deposit_amount | number | No | |
deposit_applied_amount | number | No | |
credit_note_amount | number | No | |
minutes_logged | number | No | integer minutes, not hours |
minutes_to_be_invoiced | number | No | integer minutes, not hours |
percent_complete | number | No | 0-100 |
billing_type | enum | No | Values: FIXED_PRICE, TIME_AND_MATERIALS, MILESTONE, NON_BILLABLE |
category_ids | string[] | No | (reference to AccountingCategory) |
location_id | string | No | |
organization_id | string | No | |
metadata | AccountingMetadata[] | No | |
metadata[].id | string | No | The ID of the custom field definition (from the metadata/metadata endpoint). |
metadata[].slug | string | No | The integration's API name (key) of an existing custom field. List valid slugs for this object with the metadata/metadata endpoint; unknown slugs are rejected by the integration. |
metadata[].value | object | No | The field's value, typed by format: DATE as ISO-8601 (YYYY-MM-DD, or YYYY-MM-DDTHH:MM:SSZ for date-times); NUMBER, PRICE and CURRENCY as a number; BOOLEAN and YES_NO as true/false; MULTIPLE_SELECT as an array of option values; otherwise a string. |
metadata[].namespace | string | No | |
metadata[].format | enum | No | The data type of the custom field, which determines how value is formatted. Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL |
metadata[].extra_data | object | No |
Are we missing anything? Let us know
Was this page helpful?