# Accounting API — Projects > Canonical URL: https://developers.apideck.com/apis/accounting/reference#tag/Projects This document contains every operation on the `Projects` resource. --- # List projects > **Accounting API** · `GET /accounting/projects` > Canonical URL: https://developers.apideck.com/apis/accounting/reference#tag/Projects/operation/projectsAll List projects ## Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `raw` | query | `boolean` | No | Include raw response. Mostly used for debugging purposes | | `x-apideck-consumer-id` | header | `string` | Yes | ID of the consumer which you want to get or push data from | | `x-apideck-app-id` | header | `string` | Yes | The ID of your Unify application | | `x-apideck-service-id` | header | `string` | No | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | | `x-apideck-company-id` | header | `string` | No | The ID of the company to scope requests to. For connectors that support multi-company, this overrides the default company configured in connection settings. | | `cursor` | query | `string` | No | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | | `limit` | query | `integer` | No | Number of results to return. Minimum 1, Maximum 200, Default 20 | | `filter` | query | `object` | No | Apply filters | | `sort` | query | `object` | No | Apply sorting | | `pass_through` | query | `object` | No | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | | `fields` | query | `string` | No | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | ### Responses #### 200 — Projects - `status_code` `integer` **required** — HTTP Response Status Code — example: `200` - `status` `string` **required** — HTTP Response Status — example: `OK` - `service` `string` **required** — Apideck ID of service provider — example: `quickbooks` - `resource` `string` **required** — Unified API resource name — example: `Projects` - `operation` `string` **required** — Operation performed — example: `all` - `data` `array of object` **required** - `id` `string` — A unique identifier for an object. — example: `12345` - `downstream_id` `string` — The third-party API ID of original entity — example: `12345` - `name` `string` **required** — Name of the project — example: `Website Redesign Project` - `display_id` `string` — User-friendly project identifier — example: `PROJ-001` - `reference_id` `string` — External reference identifier for the project — example: `WD-REF-2024-001` - `description` `string` — Detailed description of the project — example: `Complete redesign of the company website including new branding and improved user experience` - `status` `string` — Current status of the project — enum: `active`, `completed`, `on_hold`, `cancelled`, `draft`, `in_progress`, `approved`, `other` — example: `OK` - `active` `boolean` — Indicates whether the project is currently active or inactive — example: `true` - `project_type` `string` — Type or category of the project — enum: `client_project`, `internal_project`, `maintenance`, `research_development`, `training`, `other` — example: `client_project` - `priority` `string` — Priority level of the project — enum: `low`, `medium`, `high`, `critical` — example: `high` - `completion_percentage` `number` — Percentage of project completion (0-100) — example: `75.5` - `start_date` `string` — Start date of the project — format: `date` — example: `2024-01-15` - `end_date` `string` — Expected or planned end date of the project — format: `date` — example: `2024-06-30` - `completion_date` `string` — Actual end date of the project — format: `date` — example: `2024-08-06` - `customer` `object` — The customer this entity is linked to. - `id` `string` — The ID of the customer this entity is linked to. — example: `12345` - `display_id` `string` — The display ID of the customer. — example: `CUST00101` - `display_name` `string` — The display name of the customer. — example: `Windsurf Shop` - `name` `string` — The name of the customer. Deprecated, use display_name instead. — example: `Windsurf Shop` - `company_name` `string` — The company name of the customer. — example: `The boring company` - `email` `string` — The email address of the customer. — example: `boring@boring.com` - `department` `object` — Department or organizational unit associated with the project - `id` `string` — Unique identifier for the department — example: `DEPT-001` - `name` `string` — Name of the department — example: `Marketing` - `company_id` `string` — The company ID the transaction belongs to — example: `12345` - `owner_id` `string` — ID of the user who owns/manages this project — example: `12345` - `parent_project` `object` — Parent project if this is a subproject - `id` `string` — Unique identifier for the parent project — example: `PROJ-PARENT-001` - `name` `string` — Name of the parent project — example: `Company Website Overhaul` - `currency` `string` — Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). — enum: `UNKNOWN_CURRENCY`, `AED`, `AFN`, `ALL`, `AMD`, `ANG`, `AOA`, `ARS`, `AUD`, `AWG`, `AZN`, `BAM`, `BBD`, `BDT`, `BGN`, `BHD`, `BIF`, `BMD`, `BND`, `BOB`, `BOV`, `BRL`, `BSD`, `BTN`, `BWP`, `BYR`, `BZD`, `CAD`, `CDF`, `CHE`, `CHF`, `CHW`, `CLF`, `CLP`, `CNY`, `COP`, `COU`, `CRC`, `CUC`, `CUP`, `CVE`, `CZK`, `DJF`, `DKK`, `DOP`, `DZD`, `EGP`, `ERN`, `ETB`, `EUR`, `FJD`, `FKP`, `GBP`, `GEL`, `GHS`, `GIP`, `GMD`, `GNF`, `GTQ`, `GYD`, `HKD`, `HNL`, `HRK`, `HTG`, `HUF`, `IDR`, `ILS`, `INR`, `IQD`, `IRR`, `ISK`, `JMD`, `JOD`, `JPY`, `KES`, `KGS`, `KHR`, `KMF`, `KPW`, `KRW`, `KWD`, `KYD`, `KZT`, `LAK`, `LBP`, `LKR`, `LRD`, `LSL`, `LTL`, `LVL`, `LYD`, `MAD`, `MDL`, `MGA`, `MKD`, `MMK`, `MNT`, `MOP`, `MRO`, `MUR`, `MVR`, `MWK`, `MXN`, `MXV`, `MYR`, `MZN`, `NAD`, `NGN`, `NIO`, `NOK`, `NPR`, `NZD`, `OMR`, `PAB`, `PEN`, `PGK`, `PHP`, `PKR`, `PLN`, `PYG`, `QAR`, `RON`, `RSD`, `RUB`, `RWF`, `SAR`, `SBD`, `SCR`, `SDG`, `SEK`, `SGD`, `SHP`, `SLL`, `SOS`, `SRD`, `SSP`, `STD`, `SVC`, `SYP`, `SZL`, `THB`, `TJS`, `TMT`, `TND`, `TOP`, `TRC`, `TRY`, `TTD`, `TWD`, `TZS`, `UAH`, `UGX`, `USD`, `USN`, `USS`, `UYI`, `UYU`, `UZS`, `VEF`, `VND`, `VUV`, `WST`, `XAF`, `XAG`, `XAU`, `XBA`, `XBB`, `XBC`, `XBD`, `XCD`, `XDR`, `XOF`, `XPD`, `XPF`, `XPT`, `XTS`, `XXX`, `YER`, `ZAR`, `ZMK`, `ZMW`, `BTC`, `ETH` — example: `USD` - `budget_amount` `number` — Total budgeted amount for the project — example: `50000` - `approved_amount` `number` — Approved budget amount for the project — example: `48000` - `actual_amount` `number` — Total actual amount spent on the project — example: `45250.75` - `budget_hours` `number` — Total budgeted hours for the project — example: `400` - `actual_hours` `number` — Total actual hours worked on the project — example: `385.5` - `hourly_rate` `number` — Default hourly rate for project work — example: `125` - `billing_method` `string` — Method used for billing this project — enum: `fixed_price`, `time_and_materials`, `milestone_based`, `retainer`, `non_billable` — example: `time_and_materials` - `is_billable` `boolean` — Indicates if the project is billable to the customer — example: `true` - `phase` `string` — Current phase of the project lifecycle — enum: `initiation`, `planning`, `execution`, `monitoring`, `closure`, `other` — example: `execution` - `tax_rate` `object` - `id` `string` — The ID of the object. — example: `123456` - `code` `string` — Tax rate code — example: `N-T` - `name` `string` — Name of the tax rate — example: `GST on Purchases` - `rate` `number` — Rate of the tax rate — example: `10` - `tracking_categories` `array of object` — A list of linked tracking categories. - `id` `string` — The unique identifier for the tracking category. — example: `123456` - `code` `string` — The code of the tracking category. — example: `100` - `name` `string` — The name of the tracking category. — example: `New York` - `parent_id` `string` — The unique identifier for the parent tracking category. — example: `123456` - `parent_name` `string` — The name of the parent tracking category. — example: `New York` - `tags` `array of string` — Tags associated with the project - `notes` `string` — Additional notes about the project — example: `Client has requested modern design with mobile-first approach` - `contract_number` `string` — Contract or agreement number associated with the project — example: `CNT-2024-001` - `profit_margin` `number` — Expected profit margin percentage for the project — example: `15.5` - `schedule_status` `string` — Current status of project schedule compared to plan — enum: `ahead_of_schedule`, `on_schedule`, `behind_schedule`, `critical_delay` — example: `on_schedule` - `addresses` `array of object` — An array of addresses associated with the project (billing, job site, etc.) - `id` `string` — Unique identifier for the address. — example: `123` - `type` `string` — The type of address. — enum: `primary`, `secondary`, `home`, `office`, `shipping`, `billing`, `work`, `other` — example: `primary` - `string` `string` — The address string. Some APIs don't provide structured address data. — example: `25 Spring Street, Blackburn, VIC 3130` - `name` `string` — The name of the address. — example: `HQ US` - `line1` `string` — Line 1 of the address e.g. number, street, suite, apt #, etc. — example: `Main street` - `line2` `string` — Line 2 of the address — example: `apt #` - `line3` `string` — Line 3 of the address — example: `Suite #` - `line4` `string` — Line 4 of the address — example: `delivery instructions` - `line5` `string` — Line 5 of the address — example: `Attention: Finance Dept` - `street_number` `string` — Street number — example: `25` - `city` `string` — Name of city. — example: `San Francisco` - `state` `string` — Name of state — example: `CA` - `postal_code` `string` — Zip code or equivalent. — example: `94104` - `country` `string` — country code according to ISO 3166-1 alpha-2. — example: `US` - `latitude` `string` — Latitude of the address — example: `40.759211` - `longitude` `string` — Longitude of the address — example: `-73.984638` - `county` `string` — Address field that holds a sublocality, such as a county — example: `Santa Clara` - `contact_name` `string` — Name of the contact person at the address — example: `Elon Musk` - `salutation` `string` — Salutation of the contact person at the address — example: `Mr` - `phone_number` `string` — Phone number of the address — example: `111-111-1111` - `fax` `string` — Fax number of the address — example: `122-111-1111` - `email` `string` — Email address of the address — example: `elon@musk.com` - `website` `string` — Website of the address — example: `https://elonmusk.com` - `notes` `string` — Additional notes — example: `Address notes or delivery instructions.` - `row_version` `string` — A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object. — example: `1-12345` - `team_size` `integer` — Number of team members assigned to the project — example: `8` - `custom_fields` `array of object` - `id` `string` — Unique identifier for the custom field. — example: `2389328923893298` - `name` `string` — Name of the custom field. — example: `employee_level` - `description` `string` — More information about the custom field — example: `Employee Level` - `value` `string | number | boolean | object | array of string | number | boolean | object` - One of: - Option 1: string - Option 2: number - Option 3: boolean - Option 4: object - Option 5: array of string | number | boolean | object - `row_version` `string` — A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object. — example: `1-12345` - `updated_by` `string` — The user who last updated the object. — example: `12345` - `created_by` `string` — The user who created the object. — example: `12345` - `created_at` `string` — The date and time when the object was created. — format: `date-time` — example: `2020-09-30T07:43:32.000Z` - `updated_at` `string` — The date and time when the object was last updated. — format: `date-time` — example: `2020-09-30T07:43:32.000Z` - `meta` `object` — Response metadata - `items_on_page` `integer` — Number of items returned in the data property of the response — example: `50` - `cursors` `object` — Cursors to navigate to previous or next pages through the API - `previous` `string` — Cursor to navigate to the previous page of results through the API — example: `em9oby1jcm06OnBhZ2U6OjE=` - `current` `string` — Cursor to navigate to the current page of results through the API — example: `em9oby1jcm06OnBhZ2U6OjI=` - `next` `string` — Cursor to navigate to the next page of results through the API — example: `em9oby1jcm06OnBhZ2U6OjM=` - `links` `object` — Links to navigate to previous or next pages through the API - `previous` `string` — Link to navigate to the previous page through the API — example: `https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D` - `current` `string` — Link to navigate to the current page through the API — example: `https://unify.apideck.com/crm/companies` - `next` `string` — Link to navigate to the previous page through the API — example: `https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM` #### 400 — Bad Request > Standard error response — see [Error Responses](https://developers.apideck.com/errors) #### 401 — Unauthorized > Standard error response — see [Error Responses](https://developers.apideck.com/errors) #### 402 — Payment Required > Standard error response — see [Error Responses](https://developers.apideck.com/errors) #### 404 — The specified resource was not found > Standard error response — see [Error Responses](https://developers.apideck.com/errors) #### 422 — Unprocessable > Standard error response — see [Error Responses](https://developers.apideck.com/errors) #### default — Unexpected error > Standard error response — see [Error Responses](https://developers.apideck.com/errors) --- # Create project > **Accounting API** · `POST /accounting/projects` > Canonical URL: https://developers.apideck.com/apis/accounting/reference#tag/Projects/operation/projectsAdd Create project ## Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `raw` | query | `boolean` | No | Include raw response. Mostly used for debugging purposes | | `x-apideck-consumer-id` | header | `string` | Yes | ID of the consumer which you want to get or push data from | | `x-apideck-app-id` | header | `string` | Yes | The ID of your Unify application | | `x-apideck-service-id` | header | `string` | No | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | | `x-apideck-company-id` | header | `string` | No | The ID of the company to scope requests to. For connectors that support multi-company, this overrides the default company configured in connection settings. | ### Request Body _Required._ - `id` `string` — A unique identifier for an object. — example: `12345` - `downstream_id` `string` — The third-party API ID of original entity — example: `12345` - `name` `string` **required** — Name of the project — example: `Website Redesign Project` - `display_id` `string` — User-friendly project identifier — example: `PROJ-001` - `reference_id` `string` — External reference identifier for the project — example: `WD-REF-2024-001` - `description` `string` — Detailed description of the project — example: `Complete redesign of the company website including new branding and improved user experience` - `status` `string` — Current status of the project — enum: `active`, `completed`, `on_hold`, `cancelled`, `draft`, `in_progress`, `approved`, `other` — example: `active` - `active` `boolean` — Indicates whether the project is currently active or inactive — example: `true` - `project_type` `string` — Type or category of the project — enum: `client_project`, `internal_project`, `maintenance`, `research_development`, `training`, `other` — example: `client_project` - `priority` `string` — Priority level of the project — enum: `low`, `medium`, `high`, `critical` — example: `high` - `completion_percentage` `number` — Percentage of project completion (0-100) — example: `75.5` - `start_date` `string` — Start date of the project — format: `date` — example: `2024-01-15` - `end_date` `string` — Expected or planned end date of the project — format: `date` — example: `2024-06-30` - `completion_date` `string` — Actual end date of the project — format: `date` — example: `2024-08-06` - `customer` `object` — The customer this entity is linked to. - `id` `string` — The ID of the customer this entity is linked to. — example: `12345` - `display_id` `string` — The display ID of the customer. — example: `CUST00101` - `display_name` `string` — The display name of the customer. — example: `Windsurf Shop` - `name` `string` — The name of the customer. Deprecated, use display_name instead. — example: `Windsurf Shop` - `company_name` `string` — The company name of the customer. — example: `The boring company` - `email` `string` — The email address of the customer. — example: `boring@boring.com` - `department` `object` — Department or organizational unit associated with the project - `id` `string` — Unique identifier for the department — example: `DEPT-001` - `name` `string` — Name of the department — example: `Marketing` - `company_id` `string` — The company ID the transaction belongs to — example: `12345` - `owner_id` `string` — ID of the user who owns/manages this project — example: `12345` - `parent_project` `object` — Parent project if this is a subproject - `id` `string` — Unique identifier for the parent project — example: `PROJ-PARENT-001` - `name` `string` — Name of the parent project — example: `Company Website Overhaul` - `currency` `string` — Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). — enum: `UNKNOWN_CURRENCY`, `AED`, `AFN`, `ALL`, `AMD`, `ANG`, `AOA`, `ARS`, `AUD`, `AWG`, `AZN`, `BAM`, `BBD`, `BDT`, `BGN`, `BHD`, `BIF`, `BMD`, `BND`, `BOB`, `BOV`, `BRL`, `BSD`, `BTN`, `BWP`, `BYR`, `BZD`, `CAD`, `CDF`, `CHE`, `CHF`, `CHW`, `CLF`, `CLP`, `CNY`, `COP`, `COU`, `CRC`, `CUC`, `CUP`, `CVE`, `CZK`, `DJF`, `DKK`, `DOP`, `DZD`, `EGP`, `ERN`, `ETB`, `EUR`, `FJD`, `FKP`, `GBP`, `GEL`, `GHS`, `GIP`, `GMD`, `GNF`, `GTQ`, `GYD`, `HKD`, `HNL`, `HRK`, `HTG`, `HUF`, `IDR`, `ILS`, `INR`, `IQD`, `IRR`, `ISK`, `JMD`, `JOD`, `JPY`, `KES`, `KGS`, `KHR`, `KMF`, `KPW`, `KRW`, `KWD`, `KYD`, `KZT`, `LAK`, `LBP`, `LKR`, `LRD`, `LSL`, `LTL`, `LVL`, `LYD`, `MAD`, `MDL`, `MGA`, `MKD`, `MMK`, `MNT`, `MOP`, `MRO`, `MUR`, `MVR`, `MWK`, `MXN`, `MXV`, `MYR`, `MZN`, `NAD`, `NGN`, `NIO`, `NOK`, `NPR`, `NZD`, `OMR`, `PAB`, `PEN`, `PGK`, `PHP`, `PKR`, `PLN`, `PYG`, `QAR`, `RON`, `RSD`, `RUB`, `RWF`, `SAR`, `SBD`, `SCR`, `SDG`, `SEK`, `SGD`, `SHP`, `SLL`, `SOS`, `SRD`, `SSP`, `STD`, `SVC`, `SYP`, `SZL`, `THB`, `TJS`, `TMT`, `TND`, `TOP`, `TRC`, `TRY`, `TTD`, `TWD`, `TZS`, `UAH`, `UGX`, `USD`, `USN`, `USS`, `UYI`, `UYU`, `UZS`, `VEF`, `VND`, `VUV`, `WST`, `XAF`, `XAG`, `XAU`, `XBA`, `XBB`, `XBC`, `XBD`, `XCD`, `XDR`, `XOF`, `XPD`, `XPF`, `XPT`, `XTS`, `XXX`, `YER`, `ZAR`, `ZMK`, `ZMW`, `BTC`, `ETH` — example: `USD` - `budget_amount` `number` — Total budgeted amount for the project — example: `50000` - `approved_amount` `number` — Approved budget amount for the project — example: `48000` - `actual_amount` `number` — Total actual amount spent on the project — example: `45250.75` - `budget_hours` `number` — Total budgeted hours for the project — example: `400` - `actual_hours` `number` — Total actual hours worked on the project — example: `385.5` - `hourly_rate` `number` — Default hourly rate for project work — example: `125` - `billing_method` `string` — Method used for billing this project — enum: `fixed_price`, `time_and_materials`, `milestone_based`, `retainer`, `non_billable` — example: `time_and_materials` - `is_billable` `boolean` — Indicates if the project is billable to the customer — example: `true` - `phase` `string` — Current phase of the project lifecycle — enum: `initiation`, `planning`, `execution`, `monitoring`, `closure`, `other` — example: `execution` - `tax_rate` `object` - `id` `string` — The ID of the object. — example: `123456` - `code` `string` — Tax rate code — example: `N-T` - `name` `string` — Name of the tax rate — example: `GST on Purchases` - `rate` `number` — Rate of the tax rate — example: `10` - `tracking_categories` `array of object` — A list of linked tracking categories. - `id` `string` — The unique identifier for the tracking category. — example: `123456` - `code` `string` — The code of the tracking category. — example: `100` - `name` `string` — The name of the tracking category. — example: `New York` - `parent_id` `string` — The unique identifier for the parent tracking category. — example: `123456` - `parent_name` `string` — The name of the parent tracking category. — example: `New York` - `tags` `array of string` — Tags associated with the project - `notes` `string` — Additional notes about the project — example: `Client has requested modern design with mobile-first approach` - `contract_number` `string` — Contract or agreement number associated with the project — example: `CNT-2024-001` - `profit_margin` `number` — Expected profit margin percentage for the project — example: `15.5` - `schedule_status` `string` — Current status of project schedule compared to plan — enum: `ahead_of_schedule`, `on_schedule`, `behind_schedule`, `critical_delay` — example: `on_schedule` - `addresses` `array of object` — An array of addresses associated with the project (billing, job site, etc.) - `id` `string` — Unique identifier for the address. — example: `123` - `type` `string` — The type of address. — enum: `primary`, `secondary`, `home`, `office`, `shipping`, `billing`, `work`, `other` — example: `primary` - `string` `string` — The address string. Some APIs don't provide structured address data. — example: `25 Spring Street, Blackburn, VIC 3130` - `name` `string` — The name of the address. — example: `HQ US` - `line1` `string` — Line 1 of the address e.g. number, street, suite, apt #, etc. — example: `Main street` - `line2` `string` — Line 2 of the address — example: `apt #` - `line3` `string` — Line 3 of the address — example: `Suite #` - `line4` `string` — Line 4 of the address — example: `delivery instructions` - `line5` `string` — Line 5 of the address — example: `Attention: Finance Dept` - `street_number` `string` — Street number — example: `25` - `city` `string` — Name of city. — example: `San Francisco` - `state` `string` — Name of state — example: `CA` - `postal_code` `string` — Zip code or equivalent. — example: `94104` - `country` `string` — country code according to ISO 3166-1 alpha-2. — example: `US` - `latitude` `string` — Latitude of the address — example: `40.759211` - `longitude` `string` — Longitude of the address — example: `-73.984638` - `county` `string` — Address field that holds a sublocality, such as a county — example: `Santa Clara` - `contact_name` `string` — Name of the contact person at the address — example: `Elon Musk` - `salutation` `string` — Salutation of the contact person at the address — example: `Mr` - `phone_number` `string` — Phone number of the address — example: `111-111-1111` - `fax` `string` — Fax number of the address — example: `122-111-1111` - `email` `string` — Email address of the address — example: `elon@musk.com` - `website` `string` — Website of the address — example: `https://elonmusk.com` - `notes` `string` — Additional notes — example: `Address notes or delivery instructions.` - `row_version` `string` — A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object. — example: `1-12345` - `team_size` `integer` — Number of team members assigned to the project — example: `8` - `custom_fields` `array of object` - `id` `string` — Unique identifier for the custom field. — example: `2389328923893298` - `name` `string` — Name of the custom field. — example: `employee_level` - `description` `string` — More information about the custom field — example: `Employee Level` - `value` `string | number | boolean | object | array of string | number | boolean | object` - One of: - Option 1: string - Option 2: number - Option 3: boolean - Option 4: object - Option 5: array of string | number | boolean | object - `row_version` `string` — A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object. — example: `1-12345` - `updated_by` `string` — The user who last updated the object. — example: `12345` - `created_by` `string` — The user who created the object. — example: `12345` - `created_at` `string` — The date and time when the object was created. — format: `date-time` — example: `2020-09-30T07:43:32.000Z` - `updated_at` `string` — The date and time when the object was last updated. — format: `date-time` — example: `2020-09-30T07:43:32.000Z` ### Responses #### 201 — Projects - `status_code` `integer` **required** — HTTP Response Status Code — example: `201` - `status` `string` **required** — HTTP Response Status — example: `Created` - `service` `string` **required** — Apideck ID of service provider — example: `quickbooks` - `resource` `string` **required** — Unified API resource name — example: `Projects` - `operation` `string` **required** — Operation performed — example: `add` - `data` `object` **required** — A object containing a unique identifier for the resource that was created, updated, or deleted. - `id` `string` **required** — The unique identifier of the resource — example: `12345` #### 400 — Bad Request > Standard error response — see [Error Responses](https://developers.apideck.com/errors) #### 401 — Unauthorized > Standard error response — see [Error Responses](https://developers.apideck.com/errors) #### 402 — Payment Required > Standard error response — see [Error Responses](https://developers.apideck.com/errors) #### 404 — The specified resource was not found > Standard error response — see [Error Responses](https://developers.apideck.com/errors) #### 422 — Unprocessable > Standard error response — see [Error Responses](https://developers.apideck.com/errors) #### default — Unexpected error > Standard error response — see [Error Responses](https://developers.apideck.com/errors) --- # Get project > **Accounting API** · `GET /accounting/projects/{id}` > Canonical URL: https://developers.apideck.com/apis/accounting/reference#tag/Projects/operation/projectsOne Get project ## Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `id` | path | `string` | Yes | ID of the record you are acting upon. | | `x-apideck-consumer-id` | header | `string` | Yes | ID of the consumer which you want to get or push data from | | `x-apideck-app-id` | header | `string` | Yes | The ID of your Unify application | | `x-apideck-service-id` | header | `string` | No | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | | `x-apideck-company-id` | header | `string` | No | The ID of the company to scope requests to. For connectors that support multi-company, this overrides the default company configured in connection settings. | | `raw` | query | `boolean` | No | Include raw response. Mostly used for debugging purposes | ### Responses #### 200 — Projects - `status_code` `integer` **required** — HTTP Response Status Code — example: `200` - `status` `string` **required** — HTTP Response Status — example: `OK` - `service` `string` **required** — Apideck ID of service provider — example: `quickbooks` - `resource` `string` **required** — Unified API resource name — example: `Projects` - `operation` `string` **required** — Operation performed — example: `one` - `data` `object` **required** - `id` `string` — A unique identifier for an object. — example: `12345` - `downstream_id` `string` — The third-party API ID of original entity — example: `12345` - `name` `string` **required** — Name of the project — example: `Website Redesign Project` - `display_id` `string` — User-friendly project identifier — example: `PROJ-001` - `reference_id` `string` — External reference identifier for the project — example: `WD-REF-2024-001` - `description` `string` — Detailed description of the project — example: `Complete redesign of the company website including new branding and improved user experience` - `status` `string` — Current status of the project — enum: `active`, `completed`, `on_hold`, `cancelled`, `draft`, `in_progress`, `approved`, `other` — example: `OK` - `active` `boolean` — Indicates whether the project is currently active or inactive — example: `true` - `project_type` `string` — Type or category of the project — enum: `client_project`, `internal_project`, `maintenance`, `research_development`, `training`, `other` — example: `client_project` - `priority` `string` — Priority level of the project — enum: `low`, `medium`, `high`, `critical` — example: `high` - `completion_percentage` `number` — Percentage of project completion (0-100) — example: `75.5` - `start_date` `string` — Start date of the project — format: `date` — example: `2024-01-15` - `end_date` `string` — Expected or planned end date of the project — format: `date` — example: `2024-06-30` - `completion_date` `string` — Actual end date of the project — format: `date` — example: `2024-08-06` - `customer` `object` — The customer this entity is linked to. - `id` `string` — The ID of the customer this entity is linked to. — example: `12345` - `display_id` `string` — The display ID of the customer. — example: `CUST00101` - `display_name` `string` — The display name of the customer. — example: `Windsurf Shop` - `name` `string` — The name of the customer. Deprecated, use display_name instead. — example: `Windsurf Shop` - `company_name` `string` — The company name of the customer. — example: `The boring company` - `email` `string` — The email address of the customer. — example: `boring@boring.com` - `department` `object` — Department or organizational unit associated with the project - `id` `string` — Unique identifier for the department — example: `DEPT-001` - `name` `string` — Name of the department — example: `Marketing` - `company_id` `string` — The company ID the transaction belongs to — example: `12345` - `owner_id` `string` — ID of the user who owns/manages this project — example: `12345` - `parent_project` `object` — Parent project if this is a subproject - `id` `string` — Unique identifier for the parent project — example: `PROJ-PARENT-001` - `name` `string` — Name of the parent project — example: `Company Website Overhaul` - `currency` `string` — Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). — enum: `UNKNOWN_CURRENCY`, `AED`, `AFN`, `ALL`, `AMD`, `ANG`, `AOA`, `ARS`, `AUD`, `AWG`, `AZN`, `BAM`, `BBD`, `BDT`, `BGN`, `BHD`, `BIF`, `BMD`, `BND`, `BOB`, `BOV`, `BRL`, `BSD`, `BTN`, `BWP`, `BYR`, `BZD`, `CAD`, `CDF`, `CHE`, `CHF`, `CHW`, `CLF`, `CLP`, `CNY`, `COP`, `COU`, `CRC`, `CUC`, `CUP`, `CVE`, `CZK`, `DJF`, `DKK`, `DOP`, `DZD`, `EGP`, `ERN`, `ETB`, `EUR`, `FJD`, `FKP`, `GBP`, `GEL`, `GHS`, `GIP`, `GMD`, `GNF`, `GTQ`, `GYD`, `HKD`, `HNL`, `HRK`, `HTG`, `HUF`, `IDR`, `ILS`, `INR`, `IQD`, `IRR`, `ISK`, `JMD`, `JOD`, `JPY`, `KES`, `KGS`, `KHR`, `KMF`, `KPW`, `KRW`, `KWD`, `KYD`, `KZT`, `LAK`, `LBP`, `LKR`, `LRD`, `LSL`, `LTL`, `LVL`, `LYD`, `MAD`, `MDL`, `MGA`, `MKD`, `MMK`, `MNT`, `MOP`, `MRO`, `MUR`, `MVR`, `MWK`, `MXN`, `MXV`, `MYR`, `MZN`, `NAD`, `NGN`, `NIO`, `NOK`, `NPR`, `NZD`, `OMR`, `PAB`, `PEN`, `PGK`, `PHP`, `PKR`, `PLN`, `PYG`, `QAR`, `RON`, `RSD`, `RUB`, `RWF`, `SAR`, `SBD`, `SCR`, `SDG`, `SEK`, `SGD`, `SHP`, `SLL`, `SOS`, `SRD`, `SSP`, `STD`, `SVC`, `SYP`, `SZL`, `THB`, `TJS`, `TMT`, `TND`, `TOP`, `TRC`, `TRY`, `TTD`, `TWD`, `TZS`, `UAH`, `UGX`, `USD`, `USN`, `USS`, `UYI`, `UYU`, `UZS`, `VEF`, `VND`, `VUV`, `WST`, `XAF`, `XAG`, `XAU`, `XBA`, `XBB`, `XBC`, `XBD`, `XCD`, `XDR`, `XOF`, `XPD`, `XPF`, `XPT`, `XTS`, `XXX`, `YER`, `ZAR`, `ZMK`, `ZMW`, `BTC`, `ETH` — example: `USD` - `budget_amount` `number` — Total budgeted amount for the project — example: `50000` - `approved_amount` `number` — Approved budget amount for the project — example: `48000` - `actual_amount` `number` — Total actual amount spent on the project — example: `45250.75` - `budget_hours` `number` — Total budgeted hours for the project — example: `400` - `actual_hours` `number` — Total actual hours worked on the project — example: `385.5` - `hourly_rate` `number` — Default hourly rate for project work — example: `125` - `billing_method` `string` — Method used for billing this project — enum: `fixed_price`, `time_and_materials`, `milestone_based`, `retainer`, `non_billable` — example: `time_and_materials` - `is_billable` `boolean` — Indicates if the project is billable to the customer — example: `true` - `phase` `string` — Current phase of the project lifecycle — enum: `initiation`, `planning`, `execution`, `monitoring`, `closure`, `other` — example: `execution` - `tax_rate` `object` - `id` `string` — The ID of the object. — example: `123456` - `code` `string` — Tax rate code — example: `N-T` - `name` `string` — Name of the tax rate — example: `GST on Purchases` - `rate` `number` — Rate of the tax rate — example: `10` - `tracking_categories` `array of object` — A list of linked tracking categories. - `id` `string` — The unique identifier for the tracking category. — example: `123456` - `code` `string` — The code of the tracking category. — example: `100` - `name` `string` — The name of the tracking category. — example: `New York` - `parent_id` `string` — The unique identifier for the parent tracking category. — example: `123456` - `parent_name` `string` — The name of the parent tracking category. — example: `New York` - `tags` `array of string` — Tags associated with the project - `notes` `string` — Additional notes about the project — example: `Client has requested modern design with mobile-first approach` - `contract_number` `string` — Contract or agreement number associated with the project — example: `CNT-2024-001` - `profit_margin` `number` — Expected profit margin percentage for the project — example: `15.5` - `schedule_status` `string` — Current status of project schedule compared to plan — enum: `ahead_of_schedule`, `on_schedule`, `behind_schedule`, `critical_delay` — example: `on_schedule` - `addresses` `array of object` — An array of addresses associated with the project (billing, job site, etc.) - `id` `string` — Unique identifier for the address. — example: `123` - `type` `string` — The type of address. — enum: `primary`, `secondary`, `home`, `office`, `shipping`, `billing`, `work`, `other` — example: `primary` - `string` `string` — The address string. Some APIs don't provide structured address data. — example: `25 Spring Street, Blackburn, VIC 3130` - `name` `string` — The name of the address. — example: `HQ US` - `line1` `string` — Line 1 of the address e.g. number, street, suite, apt #, etc. — example: `Main street` - `line2` `string` — Line 2 of the address — example: `apt #` - `line3` `string` — Line 3 of the address — example: `Suite #` - `line4` `string` — Line 4 of the address — example: `delivery instructions` - `line5` `string` — Line 5 of the address — example: `Attention: Finance Dept` - `street_number` `string` — Street number — example: `25` - `city` `string` — Name of city. — example: `San Francisco` - `state` `string` — Name of state — example: `CA` - `postal_code` `string` — Zip code or equivalent. — example: `94104` - `country` `string` — country code according to ISO 3166-1 alpha-2. — example: `US` - `latitude` `string` — Latitude of the address — example: `40.759211` - `longitude` `string` — Longitude of the address — example: `-73.984638` - `county` `string` — Address field that holds a sublocality, such as a county — example: `Santa Clara` - `contact_name` `string` — Name of the contact person at the address — example: `Elon Musk` - `salutation` `string` — Salutation of the contact person at the address — example: `Mr` - `phone_number` `string` — Phone number of the address — example: `111-111-1111` - `fax` `string` — Fax number of the address — example: `122-111-1111` - `email` `string` — Email address of the address — example: `elon@musk.com` - `website` `string` — Website of the address — example: `https://elonmusk.com` - `notes` `string` — Additional notes — example: `Address notes or delivery instructions.` - `row_version` `string` — A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object. — example: `1-12345` - `team_size` `integer` — Number of team members assigned to the project — example: `8` - `custom_fields` `array of object` - `id` `string` — Unique identifier for the custom field. — example: `2389328923893298` - `name` `string` — Name of the custom field. — example: `employee_level` - `description` `string` — More information about the custom field — example: `Employee Level` - `value` `string | number | boolean | object | array of string | number | boolean | object` - One of: - Option 1: string - Option 2: number - Option 3: boolean - Option 4: object - Option 5: array of string | number | boolean | object - `row_version` `string` — A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object. — example: `1-12345` - `updated_by` `string` — The user who last updated the object. — example: `12345` - `created_by` `string` — The user who created the object. — example: `12345` - `created_at` `string` — The date and time when the object was created. — format: `date-time` — example: `2020-09-30T07:43:32.000Z` - `updated_at` `string` — The date and time when the object was last updated. — format: `date-time` — example: `2020-09-30T07:43:32.000Z` #### 400 — Bad Request > Standard error response — see [Error Responses](https://developers.apideck.com/errors) #### 401 — Unauthorized > Standard error response — see [Error Responses](https://developers.apideck.com/errors) #### 402 — Payment Required > Standard error response — see [Error Responses](https://developers.apideck.com/errors) #### 404 — The specified resource was not found > Standard error response — see [Error Responses](https://developers.apideck.com/errors) #### 422 — Unprocessable > Standard error response — see [Error Responses](https://developers.apideck.com/errors) #### default — Unexpected error > Standard error response — see [Error Responses](https://developers.apideck.com/errors) --- # Delete project > **Accounting API** · `DELETE /accounting/projects/{id}` > Canonical URL: https://developers.apideck.com/apis/accounting/reference#tag/Projects/operation/projectsDelete Delete project ## Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `id` | path | `string` | Yes | ID of the record you are acting upon. | | `x-apideck-consumer-id` | header | `string` | Yes | ID of the consumer which you want to get or push data from | | `x-apideck-app-id` | header | `string` | Yes | The ID of your Unify application | | `x-apideck-service-id` | header | `string` | No | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | | `x-apideck-company-id` | header | `string` | No | The ID of the company to scope requests to. For connectors that support multi-company, this overrides the default company configured in connection settings. | | `raw` | query | `boolean` | No | Include raw response. Mostly used for debugging purposes | ### Responses #### 200 — Projects - `status_code` `integer` **required** — HTTP Response Status Code — example: `200` - `status` `string` **required** — HTTP Response Status — example: `OK` - `service` `string` **required** — Apideck ID of service provider — example: `quickbooks` - `resource` `string` **required** — Unified API resource name — example: `Projects` - `operation` `string` **required** — Operation performed — example: `delete` - `data` `object` **required** — A object containing a unique identifier for the resource that was created, updated, or deleted. - `id` `string` **required** — The unique identifier of the resource — example: `12345` #### 400 — Bad Request > Standard error response — see [Error Responses](https://developers.apideck.com/errors) #### 401 — Unauthorized > Standard error response — see [Error Responses](https://developers.apideck.com/errors) #### 402 — Payment Required > Standard error response — see [Error Responses](https://developers.apideck.com/errors) #### 404 — The specified resource was not found > Standard error response — see [Error Responses](https://developers.apideck.com/errors) #### 422 — Unprocessable > Standard error response — see [Error Responses](https://developers.apideck.com/errors) #### default — Unexpected error > Standard error response — see [Error Responses](https://developers.apideck.com/errors) --- # Update project > **Accounting API** · `PATCH /accounting/projects/{id}` > Canonical URL: https://developers.apideck.com/apis/accounting/reference#tag/Projects/operation/projectsUpdate Update project ## Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `id` | path | `string` | Yes | ID of the record you are acting upon. | | `x-apideck-consumer-id` | header | `string` | Yes | ID of the consumer which you want to get or push data from | | `x-apideck-app-id` | header | `string` | Yes | The ID of your Unify application | | `x-apideck-service-id` | header | `string` | No | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | | `x-apideck-company-id` | header | `string` | No | The ID of the company to scope requests to. For connectors that support multi-company, this overrides the default company configured in connection settings. | | `raw` | query | `boolean` | No | Include raw response. Mostly used for debugging purposes | ### Request Body _Required._ - `id` `string` — A unique identifier for an object. — example: `12345` - `downstream_id` `string` — The third-party API ID of original entity — example: `12345` - `name` `string` **required** — Name of the project — example: `Website Redesign Project` - `display_id` `string` — User-friendly project identifier — example: `PROJ-001` - `reference_id` `string` — External reference identifier for the project — example: `WD-REF-2024-001` - `description` `string` — Detailed description of the project — example: `Complete redesign of the company website including new branding and improved user experience` - `status` `string` — Current status of the project — enum: `active`, `completed`, `on_hold`, `cancelled`, `draft`, `in_progress`, `approved`, `other` — example: `active` - `active` `boolean` — Indicates whether the project is currently active or inactive — example: `true` - `project_type` `string` — Type or category of the project — enum: `client_project`, `internal_project`, `maintenance`, `research_development`, `training`, `other` — example: `client_project` - `priority` `string` — Priority level of the project — enum: `low`, `medium`, `high`, `critical` — example: `high` - `completion_percentage` `number` — Percentage of project completion (0-100) — example: `75.5` - `start_date` `string` — Start date of the project — format: `date` — example: `2024-01-15` - `end_date` `string` — Expected or planned end date of the project — format: `date` — example: `2024-06-30` - `completion_date` `string` — Actual end date of the project — format: `date` — example: `2024-08-06` - `customer` `object` — The customer this entity is linked to. - `id` `string` — The ID of the customer this entity is linked to. — example: `12345` - `display_id` `string` — The display ID of the customer. — example: `CUST00101` - `display_name` `string` — The display name of the customer. — example: `Windsurf Shop` - `name` `string` — The name of the customer. Deprecated, use display_name instead. — example: `Windsurf Shop` - `company_name` `string` — The company name of the customer. — example: `The boring company` - `email` `string` — The email address of the customer. — example: `boring@boring.com` - `department` `object` — Department or organizational unit associated with the project - `id` `string` — Unique identifier for the department — example: `DEPT-001` - `name` `string` — Name of the department — example: `Marketing` - `company_id` `string` — The company ID the transaction belongs to — example: `12345` - `owner_id` `string` — ID of the user who owns/manages this project — example: `12345` - `parent_project` `object` — Parent project if this is a subproject - `id` `string` — Unique identifier for the parent project — example: `PROJ-PARENT-001` - `name` `string` — Name of the parent project — example: `Company Website Overhaul` - `currency` `string` — Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). — enum: `UNKNOWN_CURRENCY`, `AED`, `AFN`, `ALL`, `AMD`, `ANG`, `AOA`, `ARS`, `AUD`, `AWG`, `AZN`, `BAM`, `BBD`, `BDT`, `BGN`, `BHD`, `BIF`, `BMD`, `BND`, `BOB`, `BOV`, `BRL`, `BSD`, `BTN`, `BWP`, `BYR`, `BZD`, `CAD`, `CDF`, `CHE`, `CHF`, `CHW`, `CLF`, `CLP`, `CNY`, `COP`, `COU`, `CRC`, `CUC`, `CUP`, `CVE`, `CZK`, `DJF`, `DKK`, `DOP`, `DZD`, `EGP`, `ERN`, `ETB`, `EUR`, `FJD`, `FKP`, `GBP`, `GEL`, `GHS`, `GIP`, `GMD`, `GNF`, `GTQ`, `GYD`, `HKD`, `HNL`, `HRK`, `HTG`, `HUF`, `IDR`, `ILS`, `INR`, `IQD`, `IRR`, `ISK`, `JMD`, `JOD`, `JPY`, `KES`, `KGS`, `KHR`, `KMF`, `KPW`, `KRW`, `KWD`, `KYD`, `KZT`, `LAK`, `LBP`, `LKR`, `LRD`, `LSL`, `LTL`, `LVL`, `LYD`, `MAD`, `MDL`, `MGA`, `MKD`, `MMK`, `MNT`, `MOP`, `MRO`, `MUR`, `MVR`, `MWK`, `MXN`, `MXV`, `MYR`, `MZN`, `NAD`, `NGN`, `NIO`, `NOK`, `NPR`, `NZD`, `OMR`, `PAB`, `PEN`, `PGK`, `PHP`, `PKR`, `PLN`, `PYG`, `QAR`, `RON`, `RSD`, `RUB`, `RWF`, `SAR`, `SBD`, `SCR`, `SDG`, `SEK`, `SGD`, `SHP`, `SLL`, `SOS`, `SRD`, `SSP`, `STD`, `SVC`, `SYP`, `SZL`, `THB`, `TJS`, `TMT`, `TND`, `TOP`, `TRC`, `TRY`, `TTD`, `TWD`, `TZS`, `UAH`, `UGX`, `USD`, `USN`, `USS`, `UYI`, `UYU`, `UZS`, `VEF`, `VND`, `VUV`, `WST`, `XAF`, `XAG`, `XAU`, `XBA`, `XBB`, `XBC`, `XBD`, `XCD`, `XDR`, `XOF`, `XPD`, `XPF`, `XPT`, `XTS`, `XXX`, `YER`, `ZAR`, `ZMK`, `ZMW`, `BTC`, `ETH` — example: `USD` - `budget_amount` `number` — Total budgeted amount for the project — example: `50000` - `approved_amount` `number` — Approved budget amount for the project — example: `48000` - `actual_amount` `number` — Total actual amount spent on the project — example: `45250.75` - `budget_hours` `number` — Total budgeted hours for the project — example: `400` - `actual_hours` `number` — Total actual hours worked on the project — example: `385.5` - `hourly_rate` `number` — Default hourly rate for project work — example: `125` - `billing_method` `string` — Method used for billing this project — enum: `fixed_price`, `time_and_materials`, `milestone_based`, `retainer`, `non_billable` — example: `time_and_materials` - `is_billable` `boolean` — Indicates if the project is billable to the customer — example: `true` - `phase` `string` — Current phase of the project lifecycle — enum: `initiation`, `planning`, `execution`, `monitoring`, `closure`, `other` — example: `execution` - `tax_rate` `object` - `id` `string` — The ID of the object. — example: `123456` - `code` `string` — Tax rate code — example: `N-T` - `name` `string` — Name of the tax rate — example: `GST on Purchases` - `rate` `number` — Rate of the tax rate — example: `10` - `tracking_categories` `array of object` — A list of linked tracking categories. - `id` `string` — The unique identifier for the tracking category. — example: `123456` - `code` `string` — The code of the tracking category. — example: `100` - `name` `string` — The name of the tracking category. — example: `New York` - `parent_id` `string` — The unique identifier for the parent tracking category. — example: `123456` - `parent_name` `string` — The name of the parent tracking category. — example: `New York` - `tags` `array of string` — Tags associated with the project - `notes` `string` — Additional notes about the project — example: `Client has requested modern design with mobile-first approach` - `contract_number` `string` — Contract or agreement number associated with the project — example: `CNT-2024-001` - `profit_margin` `number` — Expected profit margin percentage for the project — example: `15.5` - `schedule_status` `string` — Current status of project schedule compared to plan — enum: `ahead_of_schedule`, `on_schedule`, `behind_schedule`, `critical_delay` — example: `on_schedule` - `addresses` `array of object` — An array of addresses associated with the project (billing, job site, etc.) - `id` `string` — Unique identifier for the address. — example: `123` - `type` `string` — The type of address. — enum: `primary`, `secondary`, `home`, `office`, `shipping`, `billing`, `work`, `other` — example: `primary` - `string` `string` — The address string. Some APIs don't provide structured address data. — example: `25 Spring Street, Blackburn, VIC 3130` - `name` `string` — The name of the address. — example: `HQ US` - `line1` `string` — Line 1 of the address e.g. number, street, suite, apt #, etc. — example: `Main street` - `line2` `string` — Line 2 of the address — example: `apt #` - `line3` `string` — Line 3 of the address — example: `Suite #` - `line4` `string` — Line 4 of the address — example: `delivery instructions` - `line5` `string` — Line 5 of the address — example: `Attention: Finance Dept` - `street_number` `string` — Street number — example: `25` - `city` `string` — Name of city. — example: `San Francisco` - `state` `string` — Name of state — example: `CA` - `postal_code` `string` — Zip code or equivalent. — example: `94104` - `country` `string` — country code according to ISO 3166-1 alpha-2. — example: `US` - `latitude` `string` — Latitude of the address — example: `40.759211` - `longitude` `string` — Longitude of the address — example: `-73.984638` - `county` `string` — Address field that holds a sublocality, such as a county — example: `Santa Clara` - `contact_name` `string` — Name of the contact person at the address — example: `Elon Musk` - `salutation` `string` — Salutation of the contact person at the address — example: `Mr` - `phone_number` `string` — Phone number of the address — example: `111-111-1111` - `fax` `string` — Fax number of the address — example: `122-111-1111` - `email` `string` — Email address of the address — example: `elon@musk.com` - `website` `string` — Website of the address — example: `https://elonmusk.com` - `notes` `string` — Additional notes — example: `Address notes or delivery instructions.` - `row_version` `string` — A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object. — example: `1-12345` - `team_size` `integer` — Number of team members assigned to the project — example: `8` - `custom_fields` `array of object` - `id` `string` — Unique identifier for the custom field. — example: `2389328923893298` - `name` `string` — Name of the custom field. — example: `employee_level` - `description` `string` — More information about the custom field — example: `Employee Level` - `value` `string | number | boolean | object | array of string | number | boolean | object` - One of: - Option 1: string - Option 2: number - Option 3: boolean - Option 4: object - Option 5: array of string | number | boolean | object - `row_version` `string` — A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object. — example: `1-12345` - `updated_by` `string` — The user who last updated the object. — example: `12345` - `created_by` `string` — The user who created the object. — example: `12345` - `created_at` `string` — The date and time when the object was created. — format: `date-time` — example: `2020-09-30T07:43:32.000Z` - `updated_at` `string` — The date and time when the object was last updated. — format: `date-time` — example: `2020-09-30T07:43:32.000Z` ### Responses #### 200 — Projects - `status_code` `integer` **required** — HTTP Response Status Code — example: `200` - `status` `string` **required** — HTTP Response Status — example: `OK` - `service` `string` **required** — Apideck ID of service provider — example: `quickbooks` - `resource` `string` **required** — Unified API resource name — example: `Projects` - `operation` `string` **required** — Operation performed — example: `update` - `data` `object` **required** — A object containing a unique identifier for the resource that was created, updated, or deleted. - `id` `string` **required** — The unique identifier of the resource — example: `12345` #### 400 — Bad Request > Standard error response — see [Error Responses](https://developers.apideck.com/errors) #### 401 — Unauthorized > Standard error response — see [Error Responses](https://developers.apideck.com/errors) #### 402 — Payment Required > Standard error response — see [Error Responses](https://developers.apideck.com/errors) #### 404 — The specified resource was not found > Standard error response — see [Error Responses](https://developers.apideck.com/errors) #### 422 — Unprocessable > Standard error response — see [Error Responses](https://developers.apideck.com/errors) #### default — Unexpected error > Standard error response — see [Error Responses](https://developers.apideck.com/errors) ---