Versions Compared

Key

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

Resource URL

Returns an array of budget objects.

Code Block
languagebash
GET /budgets

Parameters

Table of allowed paramatersparameters.

_pageunsigned intThe page of the list to display. For example, 5 will display the fifth page. Each page contains 10 resources.
_limitunsigned intThe maximum number of resources to return. Default is 10 and maximum is 50.
_offsetunsigned intThe 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.
_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 parameter; see included examples. Underlined values are default.

idunsigned intThe budget's unique identifier.
timeunsigned intThe total time within the budget.
chargeddoubleThe total charged.
againststringThe resource the budget is linked against. For example, companies/12.
creditintNOT SURE 
fixed_chargeddoubleNOT SURE 
service_timeintNOT SURE 
full_service_chargeddoubleThe total service charged.

...