- style
Get contract
under development
Returns a contract identified by its id.
GET /contracts/:contract_idHandling the response
Below is a table of available response fields and objects that are returned within the response object of the returned object. The optional fields and objects can be requested in the _fields parameter. Underlined values are always returned.
id | Integer | A unique id assigned to the period. |
|---|---|---|
title | String |
|
date_created | unix timestamp |
|
date_started | unix timestamp |
|
date_expires | unix timestamp |
|
date_period_expires | unix timestamp |
|
against | String | The API url for the against object. |
against_id | Unsigned int |
|
against_type | String |
|
value | Decimal |
|
auto_renew | String, yes or no |
|
renew_days | Unsigned int |
|
send_invoice | String |
|
standing | String | Standing status |
period_template_id | Unsigned int |
|
type | Unsigned int or object |
|
manager | Unsigned int or object |
|
billable | Unsigned int or object |
|
affiliation | Unsigned int or object |
|
status | Unsigned int or object |
|
company | Unsigned int or object |
|
job | Unsigned int or object |
|
NEW affiliation | Object |
|
NEW notes | String |
|
NEW current_period | Object |
|
deprecated parent | Array | Please use breadcrumbs. |
NEW period_template | Object |
|
NEW date_last_interacted | unix ts |
|
NEW breadcrumbs | Array |
|
For example, to get contract #10 with against type included in the response:
GET /contracts/10.xml?_fields=standing