Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Resource URL

Code Block
languagebash
/rates/:rate_id

Parameters

Table of allowed paramaters.

_fieldspartial stringAllows you to specify optional fields and linked objects to include in the response.

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 paramater; see included examples.

idunsigned intUnique identifier for the rate.
titlestringThe rate title
chargeddoubleThe amount charged.
standingstringThe rates standing status. This can be: active or inactive.
objectstringThe object of the rate. This can be: staff, issue, component, job or contract_period.

Sample Response

Code Block
languagebash
GET /rates/18.json?_fields=standing,charged

...