Organization 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 | |
legal_name | string | No | |
currency | string | No | Currency primarily used by the organization, in ISO 4217 format (e.g. U.S. dollars is USD). |
address | object | No | |
address.address1 | string | No | |
address.address2 | string | No | |
address.city | string | No | |
address.region | string | No | Regional area of the employee's address. For example, in the U.S., the region is the employee's state; in Canada, the region is the employee’s province. |
address.region_code | string | No | Short form for the regional area of the employee's address. For example, in the U.S., the region code is the two-letter abbreviation for the employee’s state; in Canada, the region is the two-letter abbreviation for the employee's province. |
address.postal_code | string | No | |
address.country | string | No | |
address.country_code | string | No | Country code for the country, in ISO 3166 A-2 format |
tax_number | string | No | Organization's tax number. For example, in the U.S., this is an Employer Identification Number (EIN). |
timezone | string | No | |
website | string | No | |
parent_id | string | No | |
fiscal_year_end_month | number | No | Month of the year when the organization’s fiscal year ends (1 - 12, where January is 1) |
organization_code | string | No | Identifier for tracking and categorizing organizations for reporting or analysis purposes that is defined by the end-customer |
type | enum | No | Entity type within a consolidation hierarchy Values: COMPANY, SUBSIDIARY, DIVISION, LOCATION |
is_elimination | boolean | No | True for consolidation/elimination entities |
books_close_at | string (date-time) | No | Company-wide books close / lock date; transactions on or before this date fall in a closed accounting period (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
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?