;
api login

If you're familiar with BigTime, you know that some of the system's most powerful features are based on your ability to adjust screens, workflow and lookup values based on your firm's individual needs.

As you use the api, you may need access to some of these settings in order to personalize your work. If, for example, you're creating a time-entry widget that can be used by BigTime customers -- most of those customers will want you to use the vocabulary they've setup in the system in place of generic labels. This section of the api can be used to query those types of settings.

Firm-Level Vocabulary.
try it
  • This is a get request. No posting data required.

  • GET

Vocabulary settings can be used by each firm to adjust labels and menus in the system. A law firm, for example, isn't used to working with "projects", but they are very familiar with "matters." The more use your extension can make of system vocabulary, the more readily users will accept it as a natural extension of their core system.

HEADERS:  X-Auth-Token:{YourAPIToken}, X-Auth-Realm:{YourFirmId}
HTTP GET:  /settings/vocabulary
HTTP RESPONSE:  array of vocabulary items (Id and Value)
         [{id:"PROJECT", name:"matter"}, 
         {id:"PRJ_TASK", name="engagement"}, 
         {id:"LABOR_CODE", name="work code"},...] 

Timesheet "Schema" Values.
try it
  • This is a get request. No posting data required.

  • GET

When a firm sets up their timesheet in BigTime, they can activate/de-activate fields that they'd like their users to track. Some firms track time against tasks and some don't. Some firms REQUIRE a labor-code entry and others don't. Downlaod the timesheet schema to see what fields are included in a firm's time entry settings and your time-entry related products will be automatically customized the same way the user's online timesheet is customized!

HEADERS:  X-Auth-Token:{YourAPIToken}, X-Auth-Realm:{YourFirmId}
HTTP GET:  /settings/timesheet/schema
HTTP RESPONSE:  array of field items (see below)
FieldTypeDescription
FldNm String The name of the field that is included on a firm's timesheet. This name should match up with the field name(s) in the time entry api (add/update views).
ColOrder Integer Order in which the fields appear on a user's timesheet.
IsRequired Boolean TRUE if the firm has determined that this field MUST be filled out before a new time entry can be saved to the system. Note that ProjectSid is ALWAYS required (and always included in the timesheet schema).
IsDetail Boolean For weekly views, a user can decide that a value should be tracked on a per-cell basis instead of at the column level. A field that is a "detail" level field can be downplayed in your UI.
Label String The label attached to a column or field in the BigTime UI. Use this value in place of a static label for fields like project, task or time.