--- title: "Get project" method: GET path: "/accounting/projects/{id}" tags: ["Projects"] --- # Get project `GET /accounting/projects/{id}` Get project ## Path parameters - `id` string, required ## Query parameters - `raw` boolean ## Headers - `x-apideck-consumer-id` string, required - `x-apideck-app-id` string, required - `x-apideck-service-id` string - `x-apideck-company-id` string ## Response `200` Projects - GetProjectResponse - `status_code` integer, required — HTTP Response Status Code - `status` string, required — HTTP Response Status - `service` string, required — Apideck ID of service provider - `resource` string, required — Unified API resource name - `operation` string, required — Operation performed - `data` Project, required - `id` string — A unique identifier for an object. - `downstream_id` string, nullable — The third-party API ID of original entity - `name` string, required — Name of the project - `display_id` string, nullable — User-friendly project identifier - `reference_id` string, nullable — External reference identifier for the project - `description` string, nullable — Detailed description of the project - `status` 'active' | 'completed' | 'on_hold' | 'cancelled' | 'draft' | 'in_progress' | 'approved' | 'other', nullable — Current status of the project - `active` boolean, nullable — Indicates whether the project is currently active or inactive - `project_type` 'client_project' | 'internal_project' | 'maintenance' | 'research_development' | 'training' | 'other', nullable — Type or category of the project - `priority` 'low' | 'medium' | 'high' | 'critical', nullable — Priority level of the project - `completion_percentage` number, nullable — Percentage of project completion (0-100) - `start_date` string, date, nullable — Start date of the project - `end_date` string, date, nullable — Expected or planned end date of the project - `completion_date` string, date, nullable — Actual end date of the project - `customer` LinkedCustomer, nullable — The customer this entity is linked to. - `id` string — The ID of the customer this entity is linked to. - `display_id` string, nullable — The display ID of the customer. - `display_name` string, nullable — The display name of the customer. - `name` string — The name of the customer. Deprecated, use display_name instead. - `company_name` string, nullable — The company name of the customer. - `email` string — The email address of the customer. - `department` object, nullable — Department or organizational unit associated with the project - `id` string — Unique identifier for the department - `name` string — Name of the department - `company_id` string, nullable — The company ID the transaction belongs to - `owner_id` string, nullable — ID of the user who owns/manages this project - `parent_project` object, nullable — Parent project if this is a subproject - `id` string — Unique identifier for the parent project - `name` string — Name of the parent project - `currency` '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', nullable — Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). - `budget_amount` number, nullable — Total budgeted amount for the project - `approved_amount` number, nullable — Approved budget amount for the project - `actual_amount` number, nullable — Total actual amount spent on the project - `budget_hours` number, nullable — Total budgeted hours for the project - `actual_hours` number, nullable — Total actual hours worked on the project - `hourly_rate` number, nullable — Default hourly rate for project work - `billing_method` 'fixed_price' | 'time_and_materials' | 'milestone_based' | 'retainer' | 'non_billable', nullable — Method used for billing this project - `is_billable` boolean, nullable — Indicates if the project is billable to the customer - `phase` 'initiation' | 'planning' | 'execution' | 'monitoring' | 'closure' | 'other', nullable — Current phase of the project lifecycle - `tax_rate` LinkedTaxRate - `id` string, nullable — The ID of the object. - `code` string, nullable — Tax rate code - `name` string, nullable — Name of the tax rate - `rate` number, nullable — Rate of the tax rate - `tracking_categories` LinkedTrackingCategory[], nullable — A list of linked tracking categories. - `id` string — The unique identifier for the tracking category. - `code` string, nullable — The code of the tracking category. - `name` string, nullable — The name of the tracking category. - `parent_id` string — The unique identifier for the parent tracking category. - `parent_name` string, nullable — The name of the parent tracking category. - `tags` string[] — Tags associated with the project - `notes` string, nullable — Additional notes about the project - `contract_number` string, nullable — Contract or agreement number associated with the project - `profit_margin` number, nullable — Expected profit margin percentage for the project - `schedule_status` 'ahead_of_schedule' | 'on_schedule' | 'behind_schedule' | 'critical_delay', nullable — Current status of project schedule compared to plan - `addresses` Address[] — An array of addresses associated with the project (billing, job site, etc.) - `id` string, nullable — Unique identifier for the address. - `type` 'primary' | 'secondary' | 'home' | 'office' | 'shipping' | 'billing' | 'work' | 'other', nullable — The type of address. - `string` string, nullable — The address string. Some APIs don't provide structured address data. - `name` string, nullable — The name of the address. - `line1` string, nullable — Line 1 of the address e.g. number, street, suite, apt #, etc. - `line2` string, nullable — Line 2 of the address - `line3` string, nullable — Line 3 of the address - `line4` string, nullable — Line 4 of the address - `line5` string, nullable — Line 5 of the address - `street_number` string, nullable — Street number - `city` string, nullable — Name of city. - `state` string, nullable — Name of state - `postal_code` string, nullable — Zip code or equivalent. - `country` string, nullable — country code according to ISO 3166-1 alpha-2. - `latitude` string, nullable — Latitude of the address - `longitude` string, nullable — Longitude of the address - `county` string, nullable — Address field that holds a sublocality, such as a county - `contact_name` string, nullable — Name of the contact person at the address - `salutation` string, nullable — Salutation of the contact person at the address - `phone_number` string, nullable — Phone number of the address - `fax` string, nullable — Fax number of the address - `email` string, nullable — Email address of the address - `website` string, nullable — Website of the address - `notes` string, nullable — Additional notes - `row_version` string, nullable — 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. - `team_size` integer, nullable — Number of team members assigned to the project - `custom_fields` CustomField[] - union - object - `id` string, nullable, required — Unique identifier for the custom field. - `name` string, nullable — Name of the custom field. - `description` string, nullable — More information about the custom field - `value` union - string, nullable - number, nullable - boolean, nullable - object, nullable - union[] - … - object - `id` string, nullable — Unique identifier for the custom field. - `name` string, nullable, required — Name of the custom field. - `description` string, nullable — More information about the custom field - `value` union - string, nullable - number, nullable - boolean, nullable - object, nullable - union[] - … - `row_version` string, nullable — 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. - `updated_by` string, nullable — The user who last updated the object. - `created_by` string, nullable — The user who created the object. - `created_at` string, date-time, nullable — The date and time when the object was created. - `updated_at` string, date-time, nullable — The date and time when the object was last updated. - `meta` Meta — Response metadata - `items_on_page` integer — Number of items returned in the data property of the response - `cursors` object — Cursors to navigate to previous or next pages through the API - `previous` string, nullable — Cursor to navigate to the previous page of results through the API - `current` string, nullable — Cursor to navigate to the current page of results through the API - `next` string, nullable — Cursor to navigate to the next page of results through the API - `total_count` integer — Number of records available in total for this resource - `warnings` object[], nullable — Non-fatal warnings emitted when optional workflow steps failed. Present only when at least one step degraded; the response status remains 200. - `type` string — Discriminator for the warning kind. - `status_code` integer, nullable — HTTP status code returned by the failed downstream request, when available. - `error` string, nullable — Short error description from the downstream provider, when available. - `operation` string, nullable — Identifier of the workflow step that failed. - `message` string, nullable — Detailed message from the downstream provider, when available. ## Other responses - `400` — Bad Request - `401` — Unauthorized - `402` — Payment Required - `404` — The specified resource was not found - `422` — Unprocessable - `default` — Unexpected error --- [API](https://skmtc.net/apideck-libraries/apis/accounting-api.md) · [All operations](https://skmtc.net/apideck-libraries/apis/accounting-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/apideck-libraries/accounting-api/versions/33e09b023d02/schema)