About API
Visit this website for the technical set of API directions.
API stands for application programming interface, which is a set of commands, functions, and protocols that programmers can use when building interfaces to communicate with Ajera.
The API makes it possible for programmers to create a seamless interface between another application and Ajera. For example, if you enter your employees in your human resource system, you can write a program using the Ajera API to automatically add the employee to Ajera as well. It is important to understand that the API is a set of commands but a programmer needs to write the code.
You can access the following records via the API:
- Projects
- Clients
- Contacts
- Vendors
- Vendor Invoices
- Employees
- Expense Reports
- General Ledger (GL) Accounts
The API makes it possible for a programmer to develop an interface with Ajera to read, create, update, or delete these types of records in Ajera.
Below are method definitions that are important to know when setting up the API:
Method | Definition |
Get | Given one or more primary keys, the Get method returns a list of matching items in the database. Each item returned by the Get method includes all of that item’s database fields. |
List | The List method returns a list of all items in the database related to the method. Optional filters may be used to limit the items returned. Each item returned has only a small subset of the item’s database fields, but the primary key is always returned. |
Update | The Update method is used to add, remove, or modify a database item. |
In order to access the API, you first need to:
Once these are set up, you will provide the third party with their API username, password, and the API URL.