Report Generator API Documentation

Report Generator API Documentation

General

This document describes the different datatypes that ERPLY Books’ report generator API uses. To see the entire POST data, go to a custom report and click on “JSON”. This will give you an example of the same query sent through the API.

You can find the general manual for the report generator here

To access the rest of ERPLY Books’ API, click here.
To find out about custom types, click here.

API Token

In order to use ERPLY Books’s Report generator through the API, you need to send POST requests to https://accounting.erply.com/api/report_generator. Additionally, you have to provide a token. For example, if your token is 25is6ho0tld7kft9b56rg6l3feeqr6ckiaatjuu , then the complete URL will look like this:https://accounting.erply.com/api/report_generator?token=25is6ho0tld7kft9b56rg6l3feeqr6ckiaatjuu

Supported Tables

Using the API you can access the following tables:

TableDescription
DOCUMENTInvoices
PAYMENTPayments done on invoices
ARTICLE_ROWRows on a single invoice (different items, for example)
ACCOUNTBank accounts
ACCOUNT_ENTRYTransactions that affect a specific account.
TRANSACTION_ENTRYComplete transactions that usually contain several account entries.
ENTITYCustomers, suppliers and other contacts
TAX_RATETax rates
PROJECTProjects
ARTICLEArticles
PARTNER_SYNC_HISTORYSynchronization history
ACTIVITY_ITEMCan contain various data, like integration settings and saved custom reports
ORGANISATION_TERMContains info about the organisation
USER_ORGANISATION_ROLEInfo about user roles

Operations

Supported Operations

When adding parameters to your search queries, these are the available operations:

OperationDescription
INEquals
NOT_INDoesn’t equal
LIKEContains
IS_NULLIs empty
NOT_NULLIs not empty
MORE_THANIs More than
MORE_THAN_EQUALIs more than or is equal
LESS_THANIs less than
LESS_THAN_EQUALIs less than or is equal

Dictionary

Supported Fields

The following table lists all possible fields from all tables. We highly recommend that, instead of creating JSON queries manually, you use our front-end report generator module and the JSON creator provided. If you have any questions, please contact us at support@erplybooks.com

TableFieldDatatype
DOCUMENTIDTEXT
DOCUMENTDOCUMENT_INFO_IDTEXT
DOCUMENTNUMBERTEXT
DOCUMENTCUSTOMER_ENTITY_IDCUSTOMER
DOCUMENTDATETIMEDATE
DOCUMENTTYPE_CODEDOCUMENT_TYPE
DOCUMENTLANGUAGE_CODELANGUAGE
DOCUMENTCURRENCY_CODECURRENCY
DOCUMENTSUM_NO_VATNUMBER
DOCUMENTSUM_WITH_VATNUMBER
DOCUMENTSUM_PAIDNUMBER
DOCUMENTROUNDING_TRANSACTION_ENTRY_IDTEXT
DOCUMENTOWNER_ORGANISATION_IDTEXT
DOCUMENTVAT_PERCENTTEXT
DOCUMENTREFERENCE_NUMBERTEXT
DOCUMENTMAIN_DISCOUNTTEXT
DOCUMENTDEADLINE_DATEDATE
DOCUMENTPENALTY_PERCENTTEXT
DOCUMENTINFOTEXT
DOCUMENTHASHTEXT
DOCUMENTPRINTED_INFOTEXT
DOCUMENTPROJECT_IDPROJECT
DOCUMENTCODETEXT
DOCUMENTREFERRING_IDENTIFIERTEXT
DOCUMENTTRANSACTION_DATETIMEDATE
DOCUMENTPARTNER_DOCUMENT_IDTEXT
DOCUMENTVAT_TOTAL_ROUNDING_TRANSACTION_ENTRY_IDTEXT
DOCUMENTMAIN_PROJECT_IDPROJECT
DOCUMENTDOCUMENT_STATUS_TYPE_CODEDOCUMENT_STATUS_TYPE
DOCUMENTPROJECTSTEXT
DOCUMENTCREATOR_USER_IDTEXT
DOCUMENTCREATE_DATETIMEDATE
DOCUMENTMOD_USER_IDTEXT
DOCUMENTMOD_DATETIMEDATE
DOCUMENTDEL_USER_IDTEXT
DOCUMENTDEL_DATETIMEDATE
PAYMENTIDTEXT
PAYMENTSUM_MOVEDNUMBER
PAYMENTTYPE_CODEPAYMENT_TYPE
PAYMENTDATETIMEDATE
PAYMENTTRANSACTION_ENTRY_IDTEXT
PAYMENTACCOUNT_IDACCOUNT
PAYMENTDOCUMENT_IDTEXT
PAYMENTCURRENCY_CODECURRENCY
PAYMENTINFOTEXT
PAYMENTARCHIVING_IDTEXT
PAYMENTPARTNER_PAYMENT_IDTEXT
PAYMENTENTITY_IDCUSTOMER
PAYMENTIMPORTEDBOOLEAN
PAYMENTORIGINAL_SUMNUMBER
PAYMENTORGANISATION_IDTEXT
PAYMENTPARTNER_DOCUMENT_IDTEXT
PAYMENTDOCUMENT_STATUS_TYPE_CODEDOCUMENT_STATUS_TYPE
PAYMENTCURRENCY_RATETEXT
PAYMENTPROJECT_IDPROJECT
PAYMENTMAIN_PROJECT_IDPROJECT
PAYMENTSTATUS_CHANGE_DATETIMEDATE
PAYMENTENTITY_NAMETEXT
PAYMENTPARENT_PAYMENT_IDTEXT
PAYMENTPROJECTSTEXT
PAYMENTCREATOR_USER_IDTEXT
PAYMENTCREATE_DATETIMEDATE
PAYMENTMOD_USER_IDTEXT
PAYMENTMOD_DATETIMEDATE
PAYMENTDEL_USER_IDTEXT
PAYMENTDEL_DATETIMEDATE
ARTICLE_ROWIDTEXT
ARTICLE_ROWARTICLE_IDTEXT
ARTICLE_ROWNAMETEXT
ARTICLE_ROWQUANTITYTEXT
ARTICLE_ROWDATETIMEDATE
ARTICLE_ROWPRICETEXT
ARTICLE_ROWVAT_PERCENTTEXT
ARTICLE_ROWTYPE_CODEARTICLE_ROW_TYPE
ARTICLE_ROWEXTRA_CHARGETEXT
ARTICLE_ROWDOCUMENT_IDTEXT
ARTICLE_ROWTRANSACTION_ENTRY_IDTEXT
ARTICLE_ROWDISCOUNTTEXT
ARTICLE_ROWUNIT_CODEUNIT
ARTICLE_ROWCODETEXT
ARTICLE_ROWVAT_ACCOUNT_IDACCOUNT
ARTICLE_ROWEXPENSE_ACCOUNT_IDACCOUNT
ARTICLE_ROWREVENUE_ACCOUNT_IDACCOUNT
ARTICLE_ROWPROJECT_IDPROJECT
ARTICLE_ROWRESIDUAL_VALUETEXT
ARTICLE_ROWORGANISATION_IDTEXT
ARTICLE_ROWTAX_RATE_IDTEXT
ARTICLE_ROWMAIN_PROJECT_IDPROJECT
ARTICLE_ROWACTIVITY_ITEM_IDTEXT
ARTICLE_ROWPROJECTSTEXT
ARTICLE_ROWCREATOR_USER_IDTEXT
ARTICLE_ROWCREATE_DATETIMEDATE
ARTICLE_ROWMOD_USER_IDTEXT
ARTICLE_ROWMOD_DATETIMEDATE
ARTICLE_ROWDEL_USER_IDTEXT
ARTICLE_ROWDEL_DATETIMEDATE
ACCOUNTIDTEXT
ACCOUNTORGANISATION_IDTEXT
ACCOUNTNUMBERTEXT
ACCOUNTNAMETEXT
ACCOUNTSALDO_SUMNUMBER
ACCOUNTINCOME_TYPE_CODEINCOME_TYPE
ACCOUNTBALANCE_TYPE_CODEBALANCE_TYPE
ACCOUNTTYPE_CODEACCOUNT_TYPE
ACCOUNTCASH_FLOW_TYPE_CODECASH_FLOW_TYPE
ACCOUNTDESCRIPTIONTEXT
ACCOUNTCURRENCY_CODECURRENCY
ACCOUNTPARTNER_ACCOUNT_IDACCOUNT
ACCOUNTTAX_RATE_IDTEXT
ACCOUNTCREATOR_USER_IDTEXT
ACCOUNTCREATE_DATETIMEDATE
ACCOUNTMOD_USER_IDTEXT
ACCOUNTMOD_DATETIMEDATE
ACCOUNTDEL_USER_IDTEXT
ACCOUNTDEL_DATETIMEDATE
ACCOUNT_ENTRYIDTEXT
ACCOUNT_ENTRYACCOUNT_IDACCOUNT
ACCOUNT_ENTRYTRANSACTION_ENTRY_IDTEXT
ACCOUNT_ENTRYDEBIT_SUMNUMBER
ACCOUNT_ENTRYCREDIT_SUMNUMBER
ACCOUNT_ENTRYDESCRIPTIONTEXT
ACCOUNT_ENTRYOP_DATEDATE
ACCOUNT_ENTRYCURRENCY_CODECURRENCY
ACCOUNT_ENTRYORGANISATION_IDTEXT
ACCOUNT_ENTRYPROJECT_IDPROJECT
ACCOUNT_ENTRYMAIN_PROJECT_IDPROJECT
ACCOUNT_ENTRYACTIVITY_ITEM_IDTEXT
ACCOUNT_ENTRYPROJECTSTEXT
ACCOUNT_ENTRYCREATOR_USER_IDTEXT
ACCOUNT_ENTRYCREATE_DATETIMEDATE
ACCOUNT_ENTRYMOD_USER_IDTEXT
ACCOUNT_ENTRYMOD_DATETIMEDATE
TRANSACTION_ENTRYIDTEXT
TRANSACTION_ENTRYORGANISATION_IDTEXT
TRANSACTION_ENTRYSUMNUMBER
TRANSACTION_ENTRYOP_DATEDATE
TRANSACTION_ENTRYDESCRIPTIONTEXT
TRANSACTION_ENTRYTYPE_CODETRANSACTION_TYPE
TRANSACTION_ENTRYCODETEXT
TRANSACTION_ENTRYPERCENTTEXT
TRANSACTION_ENTRYPROJECT_IDPROJECT
TRANSACTION_ENTRYTAX_RATE_IDTEXT
TRANSACTION_ENTRYCURRENCY_RATETEXT
TRANSACTION_ENTRYMAIN_PROJECT_IDPROJECT
TRANSACTION_ENTRYPROJECTSTEXT
TRANSACTION_ENTRYCREATOR_USER_IDTEXT
TRANSACTION_ENTRYCREATE_DATETIMEDATE
TRANSACTION_ENTRYMOD_USER_IDTEXT
TRANSACTION_ENTRYMOD_DATETIMEDATE
TRANSACTION_ENTRYDEL_USER_IDTEXT
TRANSACTION_ENTRYDEL_DATETIMEDATE
ENTITYIDTEXT
ENTITYCODETEXT
ENTITYBILLING_NAMETEXT
ENTITYENTITY_TYPE_CODEENTITY_TYPE
ENTITYREGISTRATION_CODETEXT
ENTITYVAT_NUMBERTEXT
ENTITYINFOTEXT
ENTITYREFERENCE_NUMBERTEXT
ENTITYPENALTY_PERCENTTEXT
ENTITYDEADLINE_DAYSTEXT
ENTITYDISCOUNTTEXT
ENTITYCONTACT_ENTITY_IDTEXT
ENTITYCONTACT_LEGAL_ADDRESSTEXT
ENTITYCONTACT_LEGAL_POSTCODETEXT
ENTITYCONTACT_EMAILTEXT
ENTITYCONTACT_ACTUAL_COUNTRY_ISO2COUNTRY_TYPE
ENTITYCONTACT_ACTUAL_POSTCODETEXT
ENTITYCONTACT_MOBILETEXT
ENTITYCONTACT_PHONETEXT
ENTITYCONTACT_WEBSITETEXT
ENTITYCONTACT_FAXTEXT
ENTITYCONTACT_ACTUAL_ADDRESSTEXT
ENTITYCONTACT_LEGAL_COUNTRY_ISO2COUNTRY_TYPE
ENTITYIMAGE_FILENAMETEXT
ENTITYPARTNER_CUSTOMER_IDTEXT
ENTITYPARTNER_SUPPLIER_IDTEXT
ENTITYBANK_NAMETEXT
ENTITYBANK_ACCOUNT_NUMBERTEXT
ENTITYBANK_IBANTEXT
ENTITYBANK_SWIFTTEXT
ENTITYBANK_IDENTIFICATORTEXT
ENTITYORGANISATION_IDTEXT
ENTITYCUSTOMERTEXT
ENTITYSUPPLIERTEXT
ENTITYCUSTOMER_DEBIT_ACCOUNT_IDACCOUNT
ENTITYCUSTOMER_CREDIT_ACCOUNT_IDACCOUNT
ENTITYSUPPLIER_DEBIT_ACCOUNT_IDACCOUNT
ENTITYSUPPLIER_CREDIT_ACCOUNT_IDACCOUNT
ENTITYCREATOR_USER_IDTEXT
ENTITYCREATE_DATETIMEDATE
ENTITYMOD_USER_IDTEXT
ENTITYMOD_DATETIMEDATE
ENTITYDEL_USER_IDTEXT
ENTITYDEL_DATETIMEDATE
TAX_RATEIDTEXT
TAX_RATEORGANISATION_IDTEXT
TAX_RATEPERCENTTEXT
TAX_RATEDESCRIPTIONTEXT
TAX_RATETYPE_CODETAX_RATE_TYPE
TAX_RATEPARTNER_TAX_RATE_IDTEXT
TAX_RATEDEBIT_ACCOUNT_IDACCOUNT
TAX_RATECREDIT_ACCOUNT_IDACCOUNT
TAX_RATEREVENUE_ACCOUNT_IDACCOUNT
TAX_RATECOEFFICIENTTEXT
TAX_RATECREATOR_USER_IDTEXT
TAX_RATECREATE_DATETIMEDATE
TAX_RATEMOD_USER_IDTEXT
TAX_RATEMOD_DATETIMEDATE
TAX_RATEDEL_USER_IDTEXT
TAX_RATEDEL_DATETIMEDATE
PROJECTIDTEXT
PROJECTORGANISATION_IDTEXT
PROJECTNAMETEXT
PROJECTAFFIRMEDBOOLEAN
PROJECTDESCRIPTIONTEXT
PROJECTPARTNER_PROJECT_IDTEXT
PROJECTSYNC_ERPLY_USERSBOOLEAN
PROJECTMAIN_PROJECT_IDPROJECT
PROJECTCREATOR_USER_IDTEXT
PROJECTCREATE_DATETIMEDATE
PROJECTMOD_USER_IDTEXT
PROJECTMOD_DATETIMEDATE
PROJECTDEL_USER_IDTEXT
PROJECTDEL_DATETIMEDATE
ARTICLEIDTEXT
ARTICLEORGANISATION_IDTEXT
ARTICLETYPE_CODEARTICLE_TYPE
ARTICLENAMETEXT
ARTICLEEXPENSE_ACCOUNT_IDACCOUNT
ARTICLEASSET_ACCOUNT_IDACCOUNT
ARTICLECODETEXT
ARTICLEVAT_PERCENTTEXT
ARTICLEINFOTEXT
ARTICLEUNIT_CODEUNIT
ARTICLEPARTNER_ARTICLE_IDTEXT
ARTICLEREVENUE_ACCOUNT_IDACCOUNT
ARTICLETAX_RATE_IDTEXT
ARTICLELIFESPANTEXT
ARTICLECREATOR_USER_IDTEXT
ARTICLECREATE_DATETIMEDATE
ARTICLEMOD_USER_IDTEXT
ARTICLEMOD_DATETIMEDATE
ARTICLEDEL_USER_IDTEXT
ARTICLEDEL_DATETIMEDATE
PARTNER_SYNC_HISTORYIDTEXT
PARTNER_SYNC_HISTORYORGANISATION_IDTEXT
PARTNER_SYNC_HISTORYPARTNER_TYPE_CODEPARTNER_TYPE
PARTNER_SYNC_HISTORYTASK_NAMETEXT
PARTNER_SYNC_HISTORYSTART_TIMETEXT
PARTNER_SYNC_HISTORYSTOP_TIMETEXT
PARTNER_SYNC_HISTORYSYNC_STATUS_TYPE_CODESYNC_STATUS_TYPE
PARTNER_SYNC_HISTORYSYNC_FROM_TIMETEXT
PARTNER_SYNC_HISTORYCREATOR_USER_IDTEXT
PARTNER_SYNC_HISTORYCREATE_DATETIMEDATE
PARTNER_SYNC_HISTORYMOD_USER_IDTEXT
PARTNER_SYNC_HISTORYMOD_DATETIMEDATE
ACTIVITY_ITEMidTEXT
ACTIVITY_ITEMACTIVITY_IDTEXT
ACTIVITY_ITEMTYPE_CODEACTIVITY_ITEM_TYPE
ACTIVITY_ITEMDESCRIPTIONTEXT
ACTIVITY_ITEMVALUETEXT
ACTIVITY_ITEMNAMETEXT
ACTIVITY_ITEMROWTEXT
ACTIVITY_ITEMCOLUMNTEXT
ACTIVITY_ITEMTRANSACTION_ENTRY_IDTEXT
ACTIVITY_ITEMORGANISATION_IDTEXT
ACTIVITY_ITEMENTITY_IDCUSTOMER
ACTIVITY_ITEMDATE_FROMDATE
ACTIVITY_ITEMDATE_TODATE
ACTIVITY_ITEMDECIMAL_VALUETEXT
ACTIVITY_ITEMPROJECT_IDPROJECT
ACTIVITY_ITEMMAIN_PROJECT_IDPROJECT
ACTIVITY_ITEMALTERNATIVE_VALUETEXT
ACTIVITY_ITEMALTERNATIVE_VALUE2TEXT
ACTIVITY_ITEMALTERNATIVE_VALUE3TEXT
ACTIVITY_ITEMALTERNATIVE_VALUE4TEXT
ACTIVITY_ITEMALTERNATIVE_VALUE5TEXT
ACTIVITY_ITEMALTERNATIVE_VALUE6TEXT
ACTIVITY_ITEMALTERNATIVE_VALUE7TEXT
ACTIVITY_ITEMALTERNATIVE_VALUE8TEXT
ACTIVITY_ITEMALTERNATIVE_VALUE9TEXT
ACTIVITY_ITEMCREATOR_USER_IDTEXT
ACTIVITY_ITEMCREATE_DATETIMEDATE
ACTIVITY_ITEMMOD_USER_IDTEXT
ACTIVITY_ITEMMOD_DATETIMEDATE
ACTIVITY_ITEMDEL_USER_IDTEXT
ACTIVITY_ITEMDEL_DATETIMEDATE
ORGANISATION_TERMIDTEXT
ORGANISATION_TERMORGANISATION_IDTEXT
ORGANISATION_TERMPENALTY_PERCENTTEXT
ORGANISATION_TERMMAIN_LANGUAGE_CODELANGUAGE
ORGANISATION_TERMMAIN_CURRENCY_CODECURRENCY
ORGANISATION_TERMIF_VAT_LIABLEBOOLEAN
ORGANISATION_TERMFIRST_INVOICE_NUMBERTEXT
ORGANISATION_TERMDEADLINE_DAYSTEXT
ORGANISATION_TERMDIGITS_AFTER_ROUNDINGTEXT
ORGANISATION_TERMDEFAULT_EXTRA_CHARGETEXT
ORGANISATION_TERMDOC_EMAIL_TEXTTEXT
ORGANISATION_TERMREFERRAL_CODETEXT
ORGANISATION_TERMREFERRED_REFERRAL_CODETEXT
ORGANISATION_TERMDATE_FORMAT_CODETEXT
ORGANISATION_TERMERPLY_CLIENT_CODETEXT
ORGANISATION_TERMERPLY_LAST_SYNC_DATETIMEDATE
ORGANISATION_TERMERPLY_CUSTOMER_ENTITY_IDTEXT
ORGANISATION_TERMPRICEPLAN_TYPE_CODEPRICEPLAN_TYPE
ORGANISATION_TERMLOCKING_DATETIMEDATE
ORGANISATION_TERMCREATE_TRANSACTIONS_BEFORE_LOCKED_DATEBOOLEAN
ORGANISATION_TERMRECONCILING_DATEDATE
ORGANISATION_TERMUSE_ARTICLE_DESCRIPTIONTEXT
ORGANISATION_TERMSYNC_WAYBILLSBOOLEAN
ORGANISATION_TERMAUTOMATIC_BANK_INTEGRATIONBOOLEAN
ORGANISATION_TERMDASHBOARD_CODETEXT
ORGANISATION_TERMUSE_DOCUMENT_CONFIRMATIONBOOLEAN
ORGANISATION_TERMEXTERNAL_INTEGRATIONSTEXT
ORGANISATION_TERMUSE_MULTIPLE_PROJECTSBOOLEAN
ORGANISATION_TERMCREATOR_USER_IDTEXT
ORGANISATION_TERMCREATE_DATETIMEDATE
ORGANISATION_TERMMOD_USER_IDTEXT
ORGANISATION_TERMMOD_DATETIMEDATE
ORGANISATION_TERMDEL_USER_IDTEXT
ORGANISATION_TERMDEL_DATETIMEDATE
USER_ORGANISATION_ROLEIDTEXT
USER_ORGANISATION_ROLEUSER_IDTEXT
USER_ORGANISATION_ROLEORGANISATION_IDTEXT
USER_ORGANISATION_ROLEORGANISATION_ROLE_CODEORG_ROLE
USER_ORGANISATION_ROLEPROJECT_IDPROJECT
USER_ORGANISATION_ROLECREATOR_USER_IDTEXT
USER_ORGANISATION_ROLECREATE_DATETIMEDATE
USER_ORGANISATION_ROLEMOD_USER_IDTEXT
USER_ORGANISATION_ROLEMOD_DATETIMEDATE
USER_ORGANISATION_ROLEDEL_USER_IDTEXT
USER_ORGANISATION_ROLEDEL_DATETIMEDATE
CURRENCY_RATEIDTEXT
CURRENCY_RATECURRENCY_CODECURRENCY
CURRENCY_RATEBASE_CURRENCY_CODECURRENCY
CURRENCY_RATERATE_VALUETEXT
CURRENCY_RATECREATOR_USER_IDTEXT
CURRENCY_RATECREATE_DATETIMEDATE
CURRENCY_RATEMOD_USER_IDTEXT
CURRENCY_RATEMOD_DATETIMEDATE
CURRENCY_RATEDEL_USER_IDTEXT
CURRENCY_RATEDEL_DATETIMEDATE