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

GET /budgets

Deprecated 14th Jan 2015

The budget endpoints have been deprecated. Please use Object Budgets

Resource URL

Returns an array of budget objects.

GET /budgets

Parameters

Table of allowed parameters.

_page

unsigned int

The page of the list to display. For example, 5 will display the fifth page. Each page contains 10 resources.

_limit

unsigned int

The maximum number of resources to return. Default is 10 and maximum is 50.

_offset

unsigned int

The position in the list of resources to return from. For example, if you had 20 resources and requested an offset of 10. Resources 10 to 19 would be returned. Offset cannot be used in conjunction with _page.

_fields

partial string

Allows 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 parameter; see included examples. Underlined values are default.

id

unsigned int

The budget's unique identifier.

time

unsigned int

The total time within the budget.

charged

double

The total charged.

against

string

The resource the budget is linked against. For example, companies/12.

credit

int

 

fixed_charged

double

 

service_time

int

 

full_service_charged

double

The total service charged.

Sample Response

GET /budgets.json?_fields=against&_limit=2
{ "response" : [ { "against" : "components/9265", "charged" : "450.00", "time" : "10800", "id" : "1" }, { "against" : "components/9266", "charged" : "150.00", "time" : "3600", "id" : "2" } ], "meta" : { "status" : "ok", "message" : "Everything executed as expected." } }