The following macros are not currently supported in the header:
  • style

Get contract

Owned by Kun Liu (Unlicensed)
Last updated: Dec 11, 2014

UNDER DEVELOPMENT

Returns a contract identified by its id.

GET /contracts/:contract_id

Handling 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.

idInteger A unique id assigned to the period.
titleString 
date_createdunix timestamp 
date_startedunix timestamp 
date_expiresunix timestamp 
date_period_expiresunix timestamp 
againstString The API url for the against object.
against_idUnsigned int 
against_typeString 
valueDecimal 
auto_renewString, yes or no 
renew_daysUnsigned int 
send_invoiceString 
standingStringStanding status
period_template_idUnsigned int 
typeUnsigned int or object 
managerUnsigned int or object 
billableUnsigned int or object 
affiliationUnsigned int or object 
statusUnsigned int or object 
companyUnsigned int or object 
jobUnsigned int or object 
NEW affiliationObject 
NEW notesString 
NEW current_periodObject 
DEPRECATED parentArrayPlease use breadcrumbs.
NEW period_templateObject 

NEW date_last_interacted

unix ts 
NEW breadcrumbsArray 

For example, to get contract #10 with against type included in the response:

GET /contracts/10.xml?_fields=standing