Bill4Time provides two public APIs for your integration needs. Our original v1, and the recently released v2 with expanded data points. Both API versions offer a collection of read-only resources for your use.
Getting Started
API Keys and Routes
You will First need to create one or more API Keys from the API tab of the Bill4Time Settings screen as shown below (please note the difference between v1 and v2).
You will then insert the newly created API key into any route you are trying to access data from.
In the following example insert your secure API key into the url where you see the '{Api Key}'
v1
Which will yield the final URL:
v2
Which will yield the final URL:
OData Routes
All of the Bill4Time API read/get routes support functionality similar to OData.
You can use the following query string Clauses:
- $filter
- $orderBy
- $select
- $top
- $skip
- $count
You can use the following $filter comparison operators:
operator | purpose | example |
eq | equality operator | $filter=id eq 1234 |
ne | non-equality operator | $filter=status ne 'Disabled' |
gt | greater than operator | $filter=cost gt 10.00 |
ge | greater than or equal operator | $filter=cost ge 25.00 |
lt | less than operator | $filter=entryDate lt '2017-01-01' |
le | less than or equal operator | $filter=entryDate le '2017-01-01' |
Examples
Find all Active clients:
Comments
0 comments
Please sign in to leave a comment.