API Documentation

API Endpoint

Prices

Prices

Supported filter params

  • company_id (array)
GET /api/v2/prices
Requestsreturns prices

GET  /api/v2/prices

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "1",
      "type": "prices",
      "attributes": {
        "name": "Price",
        "pricing_type_id": null,
        "unit_id": 2,
        "quantity": "5.0",
        "updated_at": "2021-01-24T00:04:53.031+01:00",
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "rate": 10000,
        "rate_default": 10000,
        "rate_normalized": 10000,
        "fixed_amount": null,
        "fixed_amount_default": null,
        "fixed_amount_normalized": null,
        "hourly_rate": null,
        "hourly_rate_default": null,
        "hourly_rate_normalized": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 546
          }
        },
        "service_type": {
          "data": {
            "type": "service_types",
            "id": "70"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1756"
          }
        },
        "updater": {
          "data": {
            "type": "people",
            "id": "1347"
          }
        }
      }
    }
  ],
  "included": [
    {
      "id": "70",
      "type": "service_types",
      "attributes": {
        "name": "test name",
        "category_id": null,
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 546
          }
        }
      }
    },
    {
      "id": "1756",
      "type": "companies",
      "attributes": {
        "name": "Client1211",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-01-24T00:04:53.026+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 546
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "1347",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1297@email.com",
        "title": null,
        "joined_at": "2021-01-24T00:04:53.000+01:00",
        "last_seen_at": "2021-01-24T00:04:53.043+01:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-01-24T00:04:52.991+01:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 546
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1755"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "1755",
      "type": "companies",
      "attributes": {
        "name": "Organization546",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-01-24T00:04:52.990+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 546
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "links": {
    "first": "http://www.example.com/api/v2/prices?page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://www.example.com/api/v2/prices?page%5Bnumber%5D=1&page%5Bsize%5D=30"
  },
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 1,
    "page_size": 30,
    "max_page_size": 200,
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

Get prices
GET/api/v2/prices

GET /api/v2/prices/1
Requestsreturns price

GET  /api/v2/prices/2

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "2",
    "type": "prices",
    "attributes": {
      "name": "Price",
      "pricing_type_id": null,
      "unit_id": 2,
      "quantity": "5.0",
      "updated_at": "2021-01-24T00:04:53.127+01:00",
      "currency": "USD",
      "currency_default": "USD",
      "currency_normalized": "USD",
      "rate": 10000,
      "rate_default": 10000,
      "rate_normalized": 10000,
      "fixed_amount": null,
      "fixed_amount_default": null,
      "fixed_amount_normalized": null,
      "hourly_rate": null,
      "hourly_rate_default": null,
      "hourly_rate_normalized": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 547
        }
      },
      "service_type": {
        "data": {
          "type": "service_types",
          "id": "71"
        }
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "1758"
        }
      },
      "updater": {
        "data": {
          "type": "people",
          "id": "1348"
        }
      }
    }
  },
  "included": [
    {
      "id": "71",
      "type": "service_types",
      "attributes": {
        "name": "test name",
        "category_id": null,
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 547
          }
        }
      }
    },
    {
      "id": "1758",
      "type": "companies",
      "attributes": {
        "name": "Client1212",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-01-24T00:04:53.122+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 547
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "1348",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1298@email.com",
        "title": null,
        "joined_at": "2021-01-24T00:04:53.000+01:00",
        "last_seen_at": "2021-01-24T00:04:53.137+01:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-01-24T00:04:53.102+01:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 547
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1757"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "1757",
      "type": "companies",
      "attributes": {
        "name": "Organization547",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-01-24T00:04:53.100+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 547
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

Gets a price
GET/api/v2/prices/{id}

URI Parameters
HideShow
id
number (required) Example: 1

price id

POST /api/v2/prices
Requestscreates pricereturns errorcreates price

POST  /api/v2/prices

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "prices",
    "attributes": {
      "name": "test name",
      "unit_id": 2,
      "rate": 100,
      "currency": "USD",
      "quantity": 5
    },
    "relationships": {
      "company": {
        "data": {
          "type": "companies",
          "id": "1760"
        }
      },
      "service_type": {
        "data": {
          "type": "service_types",
          "id": "72"
        }
      }
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "4",
    "type": "prices",
    "attributes": {
      "name": "test name",
      "pricing_type_id": null,
      "unit_id": 2,
      "quantity": "5.0",
      "updated_at": "2021-01-24T00:04:53.234+01:00",
      "currency": "USD",
      "currency_default": "USD",
      "currency_normalized": "USD",
      "rate": 100,
      "rate_default": 100,
      "rate_normalized": 100,
      "fixed_amount": null,
      "fixed_amount_default": null,
      "fixed_amount_normalized": null,
      "hourly_rate": null,
      "hourly_rate_default": null,
      "hourly_rate_normalized": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 548
        }
      },
      "service_type": {
        "data": {
          "type": "service_types",
          "id": "72"
        }
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "1760"
        }
      },
      "updater": {
        "data": {
          "type": "people",
          "id": "1349"
        }
      }
    }
  },
  "included": [
    {
      "id": "72",
      "type": "service_types",
      "attributes": {
        "name": "test name",
        "category_id": null,
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 548
          }
        }
      }
    },
    {
      "id": "1760",
      "type": "companies",
      "attributes": {
        "name": "Client1213",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-01-24T00:04:53.210+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 548
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "1349",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1299@email.com",
        "title": null,
        "joined_at": "2021-01-24T00:04:53.000+01:00",
        "last_seen_at": "2021-01-24T00:04:53.225+01:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-01-24T00:04:53.191+01:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 548
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1759"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "1759",
      "type": "companies",
      "attributes": {
        "name": "Organization548",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-01-24T00:04:53.189+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 548
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

POST  /api/v2/prices

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "prices",
    "attributes": {
      "name": ""
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/name"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/company"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/unit"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/currency"
      }
    }
  ]
}

POST  /api/v2/prices

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "prices",
    "attributes": {
      "name": "test name",
      "unit_id": 2,
      "rate": 100,
      "currency": "USD",
      "quantity": 5.12345
    },
    "relationships": {
      "company": {
        "data": {
          "type": "companies",
          "id": "1764"
        }
      },
      "service_type": {
        "data": {
          "type": "service_types",
          "id": "74"
        }
      }
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "7",
    "type": "prices",
    "attributes": {
      "name": "test name",
      "pricing_type_id": null,
      "unit_id": 2,
      "quantity": "5.12",
      "updated_at": "2021-01-24T00:04:53.405+01:00",
      "currency": "USD",
      "currency_default": "USD",
      "currency_normalized": "USD",
      "rate": 100,
      "rate_default": 100,
      "rate_normalized": 100,
      "fixed_amount": null,
      "fixed_amount_default": null,
      "fixed_amount_normalized": null,
      "hourly_rate": null,
      "hourly_rate_default": null,
      "hourly_rate_normalized": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 550
        }
      },
      "service_type": {
        "data": {
          "type": "service_types",
          "id": "74"
        }
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "1764"
        }
      },
      "updater": {
        "data": {
          "type": "people",
          "id": "1351"
        }
      }
    }
  },
  "included": [
    {
      "id": "74",
      "type": "service_types",
      "attributes": {
        "name": "test name",
        "category_id": null,
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 550
          }
        }
      }
    },
    {
      "id": "1764",
      "type": "companies",
      "attributes": {
        "name": "Client1215",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-01-24T00:04:53.379+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 550
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "1351",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1301@email.com",
        "title": null,
        "joined_at": "2021-01-24T00:04:53.000+01:00",
        "last_seen_at": "2021-01-24T00:04:53.398+01:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-01-24T00:04:53.359+01:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 550
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1763"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "1763",
      "type": "companies",
      "attributes": {
        "name": "Organization550",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-01-24T00:04:53.358+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 550
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

Create a price
POST/api/v2/prices

URI Parameters
HideShow
name
string (required) Example: Name

name

company_id
number (required) Example: 1

company id

service_type_id
number (required) Example: 1

service type id

unit_id
number (required) Example: 1

unit id

PATCH /api/v2/prices/1
Requestsupdates pricereturns errorreturns errorreturns errorupdates priceupdates price

PATCH  /api/v2/prices/8

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "prices",
    "attributes": {
      "name": "new name"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "8",
    "type": "prices",
    "attributes": {
      "name": "new name",
      "pricing_type_id": null,
      "unit_id": 2,
      "quantity": "5.0",
      "updated_at": "2021-01-24T00:04:53.502+01:00",
      "currency": "USD",
      "currency_default": "USD",
      "currency_normalized": "USD",
      "rate": 10000,
      "rate_default": 10000,
      "rate_normalized": 10000,
      "fixed_amount": null,
      "fixed_amount_default": null,
      "fixed_amount_normalized": null,
      "hourly_rate": null,
      "hourly_rate_default": null,
      "hourly_rate_normalized": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 551
        }
      },
      "service_type": {
        "data": {
          "type": "service_types",
          "id": "75"
        }
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "1766"
        }
      },
      "updater": {
        "data": {
          "type": "people",
          "id": "1352"
        }
      }
    }
  },
  "included": [
    {
      "id": "75",
      "type": "service_types",
      "attributes": {
        "name": "test name",
        "category_id": null,
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 551
          }
        }
      }
    },
    {
      "id": "1766",
      "type": "companies",
      "attributes": {
        "name": "Client1216",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-01-24T00:04:53.481+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 551
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "1352",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1302@email.com",
        "title": null,
        "joined_at": "2021-01-24T00:04:53.000+01:00",
        "last_seen_at": "2021-01-24T00:04:53.496+01:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-01-24T00:04:53.461+01:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 551
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1765"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "1765",
      "type": "companies",
      "attributes": {
        "name": "Organization551",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-01-24T00:04:53.459+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 551
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

PATCH  /api/v2/prices/9

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "prices",
    "attributes": {
      "name": ""
    },
    "relationships": {
      "company": {
        "data": {
          "type": "companies",
          "id": "0"
        }
      }
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/name"
      }
    }
  ]
}

PATCH  /api/v2/prices/10

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "prices",
    "attributes": {
      "name": ""
    },
    "relationships": {
      "service_type": {
        "data": {
          "type": "service_types",
          "id": "0"
        }
      }
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/name"
      }
    }
  ]
}

PATCH  /api/v2/prices/11

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "prices",
    "attributes": {
      "name": ""
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/name"
      }
    }
  ]
}

PATCH  /api/v2/prices/12

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "prices",
    "attributes": {
      "name": "new name"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "12",
    "type": "prices",
    "attributes": {
      "name": "new name",
      "pricing_type_id": null,
      "unit_id": 2,
      "quantity": "5.12345",
      "updated_at": "2021-01-24T00:04:53.828+01:00",
      "currency": "USD",
      "currency_default": "USD",
      "currency_normalized": "USD",
      "rate": 10000,
      "rate_default": 10000,
      "rate_normalized": 10000,
      "fixed_amount": null,
      "fixed_amount_default": null,
      "fixed_amount_normalized": null,
      "hourly_rate": null,
      "hourly_rate_default": null,
      "hourly_rate_normalized": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 555
        }
      },
      "service_type": {
        "data": {
          "type": "service_types",
          "id": "79"
        }
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "1774"
        }
      },
      "updater": {
        "data": {
          "type": "people",
          "id": "1356"
        }
      }
    }
  },
  "included": [
    {
      "id": "79",
      "type": "service_types",
      "attributes": {
        "name": "test name",
        "category_id": null,
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 555
          }
        }
      }
    },
    {
      "id": "1774",
      "type": "companies",
      "attributes": {
        "name": "Client1220",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-01-24T00:04:53.800+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 555
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "1356",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1306@email.com",
        "title": null,
        "joined_at": "2021-01-24T00:04:53.000+01:00",
        "last_seen_at": "2021-01-24T00:04:53.822+01:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-01-24T00:04:53.779+01:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 555
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1773"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "1773",
      "type": "companies",
      "attributes": {
        "name": "Organization555",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-01-24T00:04:53.778+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 555
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

PATCH  /api/v2/prices/13

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "prices",
    "attributes": {
      "name": "new name",
      "quantity": 2.12345
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "13",
    "type": "prices",
    "attributes": {
      "name": "new name",
      "pricing_type_id": null,
      "unit_id": 2,
      "quantity": "2.12",
      "updated_at": "2021-01-24T00:04:53.935+01:00",
      "currency": "USD",
      "currency_default": "USD",
      "currency_normalized": "USD",
      "rate": 10000,
      "rate_default": 10000,
      "rate_normalized": 10000,
      "fixed_amount": null,
      "fixed_amount_default": null,
      "fixed_amount_normalized": null,
      "hourly_rate": null,
      "hourly_rate_default": null,
      "hourly_rate_normalized": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 556
        }
      },
      "service_type": {
        "data": {
          "type": "service_types",
          "id": "80"
        }
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "1776"
        }
      },
      "updater": {
        "data": {
          "type": "people",
          "id": "1357"
        }
      }
    }
  },
  "included": [
    {
      "id": "80",
      "type": "service_types",
      "attributes": {
        "name": "test name",
        "category_id": null,
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 556
          }
        }
      }
    },
    {
      "id": "1776",
      "type": "companies",
      "attributes": {
        "name": "Client1221",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-01-24T00:04:53.906+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 556
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "1357",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1307@email.com",
        "title": null,
        "joined_at": "2021-01-24T00:04:53.000+01:00",
        "last_seen_at": "2021-01-24T00:04:53.929+01:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-01-24T00:04:53.885+01:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 556
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1775"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "1775",
      "type": "companies",
      "attributes": {
        "name": "Organization556",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-01-24T00:04:53.883+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 556
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

Update a price
PATCH/api/v2/prices/{id}

URI Parameters
HideShow
id
number (required) Example: 1

price id

DELETE /api/v2/prices/1
Requestsarchives price

DELETE  /api/v2/prices/14

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses204
This response has no content.

Deletes a price
DELETE/api/v2/prices/{id}

URI Parameters
HideShow
id
number (required) Example: 1

price id

Generated by aglio on 23 Jan 2021