{"id":3359,"date":"2017-02-07T11:43:22","date_gmt":"2017-02-07T09:43:22","guid":{"rendered":"http:\/\/www.erplybooks.com\/api\/"},"modified":"2023-07-07T06:42:52","modified_gmt":"2023-07-07T06:42:52","slug":"api","status":"publish","type":"page","link":"https:\/\/www.erplybooks.com\/ru\/api\/","title":{"rendered":"API"},"content":{"rendered":"
\n
\n

API in ERPLY Books<\/h1>\n

Why choose ERPLY Books accounting API? Because it is full-featured,\u00a0provides support for the current system in your business and supports your software with various features. If you want to know more about the world’s best accounting API then click here<\/a>!<\/p>\n

 <\/p>\n

API Token<\/h3>\n<\/div>\n
\n
\n

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.<\/p>\n

 <\/p>\n

API Structure<\/h3>\n

All the methods are REST based.
\nBase url: https:\/\/api.erplybooks.com\/api<\/code>
\nIf your API token is paejtblf2q2j6jvt4pscbm4jc2nsicjhmtqm9bqs<\/code> then your requests should have header:
\nX-API-TOKEN: paejtblf2q2j6jvt4pscbm4jc2nsicjhmtqm9bqs<\/code>.
\nAnother alternative is using the url query parameter (less secure), if necessary (to test some requests in the browser, for example) by adding ?token=paejtblf2q2j6jvt4pscbm4jc2nsicjhmtqm9bqs<\/code> to the end of the request URL.<\/p>\n

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:<\/p>\n

https:\/\/api.erplybooks.com\/api\/customers.json<\/code><\/p>\n

GET and POST are allowed with all request types. If you\u2019d like to delete or update an item, you have to provide the item\u2019s id in the url like this:
\nhttps:\/\/api.erplybooks.com\/api\/REQUEST_TYPE\/ITEM_ID<\/code><\/p>\n<\/div>\n<\/div>\n

\n
\n

 <\/p>\n

Custom Types with API<\/h3>\n<\/div>\n
\n

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<\/a>.<\/p>\n

 <\/p>\n<\/div>\n<\/div>\n

\n
\n

Report Generator through the API<\/h3>\n<\/div>\n
To access ERPLY Books’ report generator through the API, click here<\/a>.<\/div>\n<\/div>\n<\/div>\n
<\/div>\n
<\/div>\n
<\/div>\n
<\/div>\n
\n
\n

API Requests<\/h2>\n<\/div>\n<\/div>\n
\n
\n
\n

Available Request Types with API<\/h3>\n<\/div>\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
<\/th>\nGET<\/th>\nPOST<\/th>\nPUT<\/th>\nDELETE<\/th>\nREQUEST_TYPE
\n(goes to URL)<\/th>\n<\/tr>\n<\/thead>\n
Account Entries<\/td>\n\"API\"<\/td>\n<\/td>\n<\/td>\n<\/td>\naccount_entries<\/td>\n<\/tr>\n
Accounts<\/td>\n\"API\"<\/td>\n\"API\"<\/td>\n\"API\"<\/td>\n\"API\"<\/td>\naccounts<\/td>\n<\/tr>\n
Articles<\/td>\n\"API\"<\/td>\n\"API\"<\/td>\n\"API\"<\/td>\n\"API\"<\/td>\narticles<\/td>\n<\/tr>\n
Customers<\/td>\n\"API\"<\/td>\n<\/td>\n<\/td>\n<\/td>\ncustomers<\/td>\n<\/tr>\n
Invoices<\/td>\n\"API\"<\/td>\n\"API\"<\/td>\n\"API\"<\/td>\n\"API<\/td>\ninvoices<\/td>\n<\/tr>\n
Payments<\/td>\n\"API\"<\/td>\n\"API\"<\/td>\n\"API\"<\/td>\n\"API\"<\/td>\npayments<\/td>\n<\/tr>\n
Projects<\/td>\n\"API\"<\/td>\n\"API\"<\/td>\n\"API\"<\/td>\n\"API\"<\/td>\nprojects<\/td>\n<\/tr>\n
Transaction Entries<\/td>\n\"API\"<\/td>\n\"API\"<\/td>\n\"API\"<\/td>\n\"API\"<\/td>\ntransaction_entries<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<\/div>\n<\/div>\n

 <\/p>\n

\n
\n
\n

Request URL<\/h3>\n<\/div>\n
\n

GET, POST<\/h4>\n

GET and POST requests don’t require an ID.
\nURL example: https:\/\/api.erplybooks.com\/api\/invoices<\/code><\/p>\n

PUT, DELETE<\/h4>\n

PUT and DELETE requests do require an ID.
\nURL example: https:\/\/api.erplybooks.com\/api\/invoices\/INVOICE_ID<\/code><\/p>\n<\/div>\n<\/div>\n<\/div>\n

\n
\n

 <\/p>\n

API Methods<\/h2>\n

Account Entries<\/h3>\n

\/api\/account_entries\/<\/a>
\nHere you can find how to get account entries data.<\/p>\n

Accounts<\/h3>\n

\/api\/accounts\/<\/a>
\nHere you will find information how to add, edit and delete accounts<\/p>\n

Attributes<\/h3>\n

\/api\/attributes\/<\/a><\/p>\n

\/api\/attributes\/v2<\/a><\/p>\n

Tax Rates<\/h3>\n

\/api\/tax_rates\/<\/a>
\nHere you can find how to add, edit and delete tax rates.<\/p>\n

Articles<\/h3>\n

\/api\/articles\/<\/a>
\nHere you can find how to add, edit and delete tax rates.<\/p>\n

Customers<\/h3>\n

\/api\/customers\/v2<\/a>
\nHere 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.<\/p>\n

Invoices<\/h3>\n

\/api\/invoices\/<\/a>
\nSending 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.
\nAlso invoice API applies to all document types: sales invoice, purchase invoice, order, purchase order, waybill, purchase waybill, price offer, sales contract ,purchase contract.
\nPlease also look how to PARTNER API<\/a> and Queue<\/a><\/p>\n

Payments<\/h3>\n

\/api\/payments\/<\/a>
\nDescribes how to add, edit and delete payments.<\/p>\n<\/div>\n

Payments\/Import<\/h3>\n

\/api\/payments\/import<\/a>
\nDescribes how to create bank import and payment files<\/p>\n

\n

Projects<\/h3>\n

\/api\/projects\/<\/a>
\nHere you can find how to add, edit and delete projects.<\/p>\n

Transaction Entries<\/h3>\n

\/api\/transaction_entries<\/a>
\nDescribes how to add, edit and delete transaction entries.<\/p>\n

Reports<\/h3>\n

\/api\/reports<\/a>
\nHere you can find how to get reports.<\/p>\n

Attachments<\/h3>\n

\/api\/attachments<\/a>
\nDescribes how to get, add and delete attachments.<\/p>\n

Queue<\/h3>\n

\/api\/invoices\/add_to_queue\/<\/a><\/p>\n

Organisation<\/h3>\n

\/api\/organisation<\/a><\/p>\n

Dictionary<\/h3>\n

API Dictionary<\/a>
\nHere you can find a dictionary regarding API.<\/p>\n

Partner API<\/h3>\n

Partner API<\/a><\/p>\n

Custom API access points<\/h3>\n

Custom API access points<\/a><\/p>\n<\/div>\n<\/div>\n

Document types<\/h3>\n

Document types<\/a><\/p>\n","protected":false},"excerpt":{"rendered":"

API in ERPLY Books Why choose ERPLY Books accounting API? Because it is full-featured,\u00a0provides support for the current system in your business and supports your software with various features. If you want to know more about the world’s best accounting API then click here!   API Token You need API token for all queries. The […]<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":0,"menu_order":81,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_et_pb_use_builder":"","_et_pb_old_content":"","_et_gb_content_width":"","footnotes":""},"categories":[739],"tags":[740,740,1161],"class_list":{"0":"post-3359","1":"page","2":"type-page","3":"status-publish","4":"hentry","5":"category-integrations-ru","6":"tag-api-ru","8":"tag-integration-ru"},"_links":{"self":[{"href":"https:\/\/www.erplybooks.com\/ru\/wp-json\/wp\/v2\/pages\/3359","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.erplybooks.com\/ru\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/www.erplybooks.com\/ru\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/www.erplybooks.com\/ru\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.erplybooks.com\/ru\/wp-json\/wp\/v2\/comments?post=3359"}],"version-history":[{"count":0,"href":"https:\/\/www.erplybooks.com\/ru\/wp-json\/wp\/v2\/pages\/3359\/revisions"}],"wp:attachment":[{"href":"https:\/\/www.erplybooks.com\/ru\/wp-json\/wp\/v2\/media?parent=3359"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.erplybooks.com\/ru\/wp-json\/wp\/v2\/categories?post=3359"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.erplybooks.com\/ru\/wp-json\/wp\/v2\/tags?post=3359"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}