API in ERPLY Books

 

API Token

You need API token for all queries. The token is connected with the user and the organisation, meaning that users can have multiple tokens if they have more than one organisation in ERPLY Books.

 

API Structure

All the methods are REST based.
Base url: https://api.erplybooks.com/api
If your API token is paejtblf2q2j6jvt4pscbm4jc2nsicjhmtqm9bqs then your requests should have header:
X-API-TOKEN: paejtblf2q2j6jvt4pscbm4jc2nsicjhmtqm9bqs.
Another alternative is using the url query parameter (less secure), if necessary (to test some requests in the browser, for example) by adding ?token=paejtblf2q2j6jvt4pscbm4jc2nsicjhmtqm9bqs to the end of the request URL.

The Content-Type header should be set to application/json or application/xml, although we strongly recommend using the JSON format. You can also specify the response type by adding either .json or .xml right before the start of the query string, for example:

https://api.erplybooks.com/api/customers.json

GET and POST are allowed with all request types. If you’d like to delete or update an item, you have to provide the item’s id in the url like this:
https://api.erplybooks.com/api/REQUEST_TYPE/ITEM_ID

Custom Types with API

To make different queries you may need to add different types (document type, currency, language etc). You have to use custom types set by ERPLY Books. See them here.

 

Report Generator through the API

To access ERPLY Books’ report generator through the API, click here.

API Requests

Available Request Types with API

GETPOSTPUTDELETEREQUEST_TYPE
(goes to URL)
Account EntriesAPIaccount_entries
AccountsAPIAPIAPIAPIaccounts
ArticlesAPIAPIAPIAPIarticles
CustomersAPIcustomers
InvoicesAPIAPIAPIAPI invoices
PaymentsAPIAPIAPIAPIpayments
ProjectsAPIAPIAPIAPIprojects
Transaction EntriesAPIAPIAPIAPItransaction_entries

 

Request URL

GET, POST

GET and POST requests don’t require an ID.
URL example: https://api.erplybooks.com/api/invoices

PUT, DELETE

PUT and DELETE requests do require an ID.
URL example: https://api.erplybooks.com/api/invoices/INVOICE_ID

 

API Methods

 

Account Entries

/api/account_entries/
Here you can find how to get account entries data.

Accounts

/api/accounts/
Here you will find information how to add, edit and delete accounts

Tax Rates

/api/tax_rates/
Here you can find how to add, edit and delete tax rates.

Articles

/api/articles/
Here you can find how to add, edit and delete tax rates.

Customers

/api/customers/v2
Here you can find how to add, edit and delete customers. Note: by using partner API customers and suppliers can be created by the document (invoice / order etc). Also please note that customers have two API versions.

Invoices

/api/invoices/
Sending invoices is the most important part of the API: with invoice object you can send customer/supplier, invoice rows, payments, payer, connections with other documents, document attributes.
Also invoice API applies to all document types: sales invoice, purchase invoice, order, purchase order, waybill, purchase waybill, price offer, sales contract ,purchase contract.
Please also look how to PARTNER API and Queue

Payments

/api/payments/
Describes how to add, edit and delete payments.

Payments/Import

/api/payments/import
Describes how to create bank import and payment files

Projects

/api/projects/
Here you can find how to add, edit and delete projects.

Transaction Entries

/api/transaction_entries
Describes how to add, edit and delete transaction entries.

Reports

/api/reports
Here you can find how to get reports.

Attachments

/api/attachments
Describes how to get, add and delete attachments.

Queue

/api/invoices/add_to_queue/

Organisation

/api/organisation

Dictionary

API Dictionary
Here you can find a dictionary regarding API.

Partner API

Partner API