v1

latestOpenAPI 3.0.3Apache 2.02026-07-131453851.1 MB

Projects

Update project

patch/accounting/projects/{id}

Path parameters

idstring required

ID of the record you are acting upon.

Query parameters

rawboolean

Include raw response. Mostly used for debugging purposes

Headers

x-apideck-consumer-idstring required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring required

The ID of your Unify application

x-apideck-service-idstring

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-idstring

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

idstring

A unique identifier for an object.

downstream_idstring nullable

The third-party API ID of original entity

namestring required

Name of the project

display_idstring nullable

User-friendly project identifier

reference_idstring nullable

External reference identifier for the project

descriptionstring nullable

Detailed description of the project

Current status of the project

activeboolean nullable

Indicates whether the project is currently active or inactive

Type or category of the project

priority'low' | 'medium' | 'high' | 'critical' nullable

Priority level of the project

completion_percentagenumber nullable

Percentage of project completion (0-100)

start_datestring date nullable

Start date of the project

end_datestring date nullable

Expected or planned end date of the project

completion_datestring date nullable

Actual end date of the project

company_idstring nullable

The company ID the transaction belongs to

owner_idstring nullable

ID of the user who owns/manages this 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.

budget_amountnumber nullable

Total budgeted amount for the project

approved_amountnumber nullable

Approved budget amount for the project

actual_amountnumber nullable

Total actual amount spent on the project

budget_hoursnumber nullable

Total budgeted hours for the project

actual_hoursnumber nullable

Total actual hours worked on the project

hourly_ratenumber 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_billableboolean nullable

Indicates if the project is billable to the customer

Current phase of the project lifecycle

tagsstring[]

Tags associated with the project

notesstring nullable

Additional notes about the project

contract_numberstring nullable

Contract or agreement number associated with the project

profit_marginnumber 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

team_sizeinteger nullable

Number of team members assigned to the project

row_versionstring 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_bystring nullable

The user who last updated the object.

created_bystring nullable

The user who created the object.

created_atstring date-time nullable

The date and time when the object was created.

updated_atstring date-time nullable

The date and time when the object was last updated.

Example request

{
  "id": "12345",
  "downstream_id": "12345",
  "name": "Website Redesign Project",
  "display_id": "PROJ-001",
  "reference_id": "WD-REF-2024-001",
  "description": "Complete redesign of the company website including new branding and improved user experience",
  "status": "active",
  "active": true,
  "project_type": "client_project",
  "priority": "high",
  "completion_percentage": 75.5,
  "start_date": "2024-01-15",
  "end_date": "2024-06-30",
  "completion_date": "2024-08-06",
  "customer": {
    "id": "12345",
    "display_id": "CUST00101",
    "display_name": "Windsurf Shop",
    "name": "Windsurf Shop",
    "company_name": "The boring company",
    "email": "boring@boring.com"
  },
  "department": {
    "id": "DEPT-001",
    "name": "Marketing"
  },
  "company_id": "12345",
  "owner_id": "12345",
  "parent_project": {
    "id": "PROJ-PARENT-001",
    "name": "Company Website Overhaul"
  },
  "currency": "USD",
  "budget_amount": 50000,
  "approved_amount": 48000,
  "actual_amount": 45250.75,
  "budget_hours": 400,
  "actual_hours": 385.5,
  "hourly_rate": 125,
  "billing_method": "time_and_materials",
  "is_billable": true,
  "phase": "execution",
  "tax_rate": {
    "id": "123456",
    "code": "N-T",
    "name": "GST on Purchases",
    "rate": 10
  },
  "tracking_categories": [
    {
      "id": "123456",
      "code": "100",
      "name": "New York",
      "parent_id": "123456",
      "parent_name": "New York"
    }
  ],
  "tags": [
    "website",
    "redesign",
    "urgent"
  ],
  "notes": "Client has requested modern design with mobile-first approach",
  "contract_number": "CNT-2024-001",
  "profit_margin": 15.5,
  "schedule_status": "on_schedule",
  "addresses": [
    {
      "id": "123",
      "type": "primary",
      "string": "25 Spring Street, Blackburn, VIC 3130",
      "name": "HQ US",
      "line1": "Main street",
      "line2": "apt #",
      "line3": "Suite #",
      "line4": "delivery instructions",
      "line5": "Attention: Finance Dept",
      "street_number": "25",
      "city": "San Francisco",
      "state": "CA",
      "postal_code": "94104",
      "country": "US",
      "latitude": "40.759211",
      "longitude": "-73.984638",
      "county": "Santa Clara",
      "contact_name": "Elon Musk",
      "salutation": "Mr",
      "phone_number": "111-111-1111",
      "fax": "122-111-1111",
      "email": "elon@musk.com",
      "website": "https://elonmusk.com",
      "notes": "Address notes or delivery instructions.",
      "row_version": "1-12345"
    }
  ],
  "team_size": 8,
  "custom_fields": [
    {
      "id": "2389328923893298",
      "name": "employee_level",
      "description": "Employee Level",
      "value": "Uses Salesforce and Marketo"
    }
  ],
  "row_version": "1-12345",
  "updated_by": "12345",
  "created_by": "12345",
  "created_at": "2020-09-30T07:43:32.000Z",
  "updated_at": "2020-09-30T07:43:32.000Z"
}

Response

Projects

status_codeinteger required

HTTP Response Status Code

statusstring required

HTTP Response Status

servicestring required

Apideck ID of service provider

resourcestring required

Unified API resource name

operationstring required

Operation performed

Example response

{
  "status_code": 200,
  "status": "OK",
  "service": "quickbooks",
  "resource": "Projects",
  "operation": "update",
  "data": {
    "id": "12345"
  }
}