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:

Table Description
DOCUMENT Invoices
PAYMENT Payments done on invoices
ARTICLE_ROW Rows on a single invoice (different items, for example)
ACCOUNT Bank accounts
ACCOUNT_ENTRY Transactions that affect a specific account.
TRANSACTION_ENTRY Complete transactions that usually contain several account entries.
ENTITY Customers, suppliers and other contacts
TAX_RATE Tax rates
PROJECT Projects
ARTICLE Articles
PARTNER_SYNC_HISTORY Synchronization history
ACTIVITY_ITEM Can contain various data, like integration settings and saved custom reports
ORGANISATION_TERM Contains info about the organisation
USER_ORGANISATION_ROLE Info about user roles

Operations

Supported Operations

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

Operation Description
IN Equals
NOT_IN Doesn’t equal
LIKE Contains
IS_NULL Is empty
NOT_NULL Is not empty
MORE_THAN Is More than
MORE_THAN_EQUAL Is more than or is equal
LESS_THAN Is less than
LESS_THAN_EQUAL Is 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

Table Field Datatype
DOCUMENT ID TEXT
DOCUMENT DOCUMENT_INFO_ID TEXT
DOCUMENT NUMBER TEXT
DOCUMENT CUSTOMER_ENTITY_ID CUSTOMER
DOCUMENT DATETIME DATE
DOCUMENT TYPE_CODE DOCUMENT_TYPE
DOCUMENT LANGUAGE_CODE LANGUAGE
DOCUMENT CURRENCY_CODE CURRENCY
DOCUMENT SUM_NO_VAT NUMBER
DOCUMENT SUM_WITH_VAT NUMBER
DOCUMENT SUM_PAID NUMBER
DOCUMENT ROUNDING_TRANSACTION_ENTRY_ID TEXT
DOCUMENT OWNER_ORGANISATION_ID TEXT
DOCUMENT VAT_PERCENT TEXT
DOCUMENT REFERENCE_NUMBER TEXT
DOCUMENT MAIN_DISCOUNT TEXT
DOCUMENT DEADLINE_DATE DATE
DOCUMENT PENALTY_PERCENT TEXT
DOCUMENT INFO TEXT
DOCUMENT HASH TEXT
DOCUMENT PRINTED_INFO TEXT
DOCUMENT PROJECT_ID PROJECT
DOCUMENT CODE TEXT
DOCUMENT REFERRING_IDENTIFIER TEXT
DOCUMENT TRANSACTION_DATETIME DATE
DOCUMENT PARTNER_DOCUMENT_ID TEXT
DOCUMENT VAT_TOTAL_ROUNDING_TRANSACTION_ENTRY_ID TEXT
DOCUMENT MAIN_PROJECT_ID PROJECT
DOCUMENT DOCUMENT_STATUS_TYPE_CODE DOCUMENT_STATUS_TYPE
DOCUMENT PROJECTS TEXT
DOCUMENT CREATOR_USER_ID TEXT
DOCUMENT CREATE_DATETIME DATE
DOCUMENT MOD_USER_ID TEXT
DOCUMENT MOD_DATETIME DATE
DOCUMENT DEL_USER_ID TEXT
DOCUMENT DEL_DATETIME DATE
PAYMENT ID TEXT
PAYMENT SUM_MOVED NUMBER
PAYMENT TYPE_CODE PAYMENT_TYPE
PAYMENT DATETIME DATE
PAYMENT TRANSACTION_ENTRY_ID TEXT
PAYMENT ACCOUNT_ID ACCOUNT
PAYMENT DOCUMENT_ID TEXT
PAYMENT CURRENCY_CODE CURRENCY
PAYMENT INFO TEXT
PAYMENT ARCHIVING_ID TEXT
PAYMENT PARTNER_PAYMENT_ID TEXT
PAYMENT ENTITY_ID CUSTOMER
PAYMENT IMPORTED BOOLEAN
PAYMENT ORIGINAL_SUM NUMBER
PAYMENT ORGANISATION_ID TEXT
PAYMENT PARTNER_DOCUMENT_ID TEXT
PAYMENT DOCUMENT_STATUS_TYPE_CODE DOCUMENT_STATUS_TYPE
PAYMENT CURRENCY_RATE TEXT
PAYMENT PROJECT_ID PROJECT
PAYMENT MAIN_PROJECT_ID PROJECT
PAYMENT STATUS_CHANGE_DATETIME DATE
PAYMENT ENTITY_NAME TEXT
PAYMENT PARENT_PAYMENT_ID TEXT
PAYMENT PROJECTS TEXT
PAYMENT CREATOR_USER_ID TEXT
PAYMENT CREATE_DATETIME DATE
PAYMENT MOD_USER_ID TEXT
PAYMENT MOD_DATETIME DATE
PAYMENT DEL_USER_ID TEXT
PAYMENT DEL_DATETIME DATE
ARTICLE_ROW ID TEXT
ARTICLE_ROW ARTICLE_ID TEXT
ARTICLE_ROW NAME TEXT
ARTICLE_ROW QUANTITY TEXT
ARTICLE_ROW DATETIME DATE
ARTICLE_ROW PRICE TEXT
ARTICLE_ROW VAT_PERCENT TEXT
ARTICLE_ROW TYPE_CODE ARTICLE_ROW_TYPE
ARTICLE_ROW EXTRA_CHARGE TEXT
ARTICLE_ROW DOCUMENT_ID TEXT
ARTICLE_ROW TRANSACTION_ENTRY_ID TEXT
ARTICLE_ROW DISCOUNT TEXT
ARTICLE_ROW UNIT_CODE UNIT
ARTICLE_ROW CODE TEXT
ARTICLE_ROW VAT_ACCOUNT_ID ACCOUNT
ARTICLE_ROW EXPENSE_ACCOUNT_ID ACCOUNT
ARTICLE_ROW REVENUE_ACCOUNT_ID ACCOUNT
ARTICLE_ROW PROJECT_ID PROJECT
ARTICLE_ROW RESIDUAL_VALUE TEXT
ARTICLE_ROW ORGANISATION_ID TEXT
ARTICLE_ROW TAX_RATE_ID TEXT
ARTICLE_ROW MAIN_PROJECT_ID PROJECT
ARTICLE_ROW ACTIVITY_ITEM_ID TEXT
ARTICLE_ROW PROJECTS TEXT
ARTICLE_ROW CREATOR_USER_ID TEXT
ARTICLE_ROW CREATE_DATETIME DATE
ARTICLE_ROW MOD_USER_ID TEXT
ARTICLE_ROW MOD_DATETIME DATE
ARTICLE_ROW DEL_USER_ID TEXT
ARTICLE_ROW DEL_DATETIME DATE
ACCOUNT ID TEXT
ACCOUNT ORGANISATION_ID TEXT
ACCOUNT NUMBER TEXT
ACCOUNT NAME TEXT
ACCOUNT SALDO_SUM NUMBER
ACCOUNT INCOME_TYPE_CODE INCOME_TYPE
ACCOUNT BALANCE_TYPE_CODE BALANCE_TYPE
ACCOUNT TYPE_CODE ACCOUNT_TYPE
ACCOUNT CASH_FLOW_TYPE_CODE CASH_FLOW_TYPE
ACCOUNT DESCRIPTION TEXT
ACCOUNT CURRENCY_CODE CURRENCY
ACCOUNT PARTNER_ACCOUNT_ID ACCOUNT
ACCOUNT TAX_RATE_ID TEXT
ACCOUNT CREATOR_USER_ID TEXT
ACCOUNT CREATE_DATETIME DATE
ACCOUNT MOD_USER_ID TEXT
ACCOUNT MOD_DATETIME DATE
ACCOUNT DEL_USER_ID TEXT
ACCOUNT DEL_DATETIME DATE
ACCOUNT_ENTRY ID TEXT
ACCOUNT_ENTRY ACCOUNT_ID ACCOUNT
ACCOUNT_ENTRY TRANSACTION_ENTRY_ID TEXT
ACCOUNT_ENTRY DEBIT_SUM NUMBER
ACCOUNT_ENTRY CREDIT_SUM NUMBER
ACCOUNT_ENTRY DESCRIPTION TEXT
ACCOUNT_ENTRY OP_DATE DATE
ACCOUNT_ENTRY CURRENCY_CODE CURRENCY
ACCOUNT_ENTRY ORGANISATION_ID TEXT
ACCOUNT_ENTRY PROJECT_ID PROJECT
ACCOUNT_ENTRY MAIN_PROJECT_ID PROJECT
ACCOUNT_ENTRY ACTIVITY_ITEM_ID TEXT
ACCOUNT_ENTRY PROJECTS TEXT
ACCOUNT_ENTRY CREATOR_USER_ID TEXT
ACCOUNT_ENTRY CREATE_DATETIME DATE
ACCOUNT_ENTRY MOD_USER_ID TEXT
ACCOUNT_ENTRY MOD_DATETIME DATE
TRANSACTION_ENTRY ID TEXT
TRANSACTION_ENTRY ORGANISATION_ID TEXT
TRANSACTION_ENTRY SUM NUMBER
TRANSACTION_ENTRY OP_DATE DATE
TRANSACTION_ENTRY DESCRIPTION TEXT
TRANSACTION_ENTRY TYPE_CODE TRANSACTION_TYPE
TRANSACTION_ENTRY CODE TEXT
TRANSACTION_ENTRY PERCENT TEXT
TRANSACTION_ENTRY PROJECT_ID PROJECT
TRANSACTION_ENTRY TAX_RATE_ID TEXT
TRANSACTION_ENTRY CURRENCY_RATE TEXT
TRANSACTION_ENTRY MAIN_PROJECT_ID PROJECT
TRANSACTION_ENTRY PROJECTS TEXT
TRANSACTION_ENTRY CREATOR_USER_ID TEXT
TRANSACTION_ENTRY CREATE_DATETIME DATE
TRANSACTION_ENTRY MOD_USER_ID TEXT
TRANSACTION_ENTRY MOD_DATETIME DATE
TRANSACTION_ENTRY DEL_USER_ID TEXT
TRANSACTION_ENTRY DEL_DATETIME DATE
ENTITY ID TEXT
ENTITY CODE TEXT
ENTITY BILLING_NAME TEXT
ENTITY ENTITY_TYPE_CODE ENTITY_TYPE
ENTITY REGISTRATION_CODE TEXT
ENTITY VAT_NUMBER TEXT
ENTITY INFO TEXT
ENTITY REFERENCE_NUMBER TEXT
ENTITY PENALTY_PERCENT TEXT
ENTITY DEADLINE_DAYS TEXT
ENTITY DISCOUNT TEXT
ENTITY CONTACT_ENTITY_ID TEXT
ENTITY CONTACT_LEGAL_ADDRESS TEXT
ENTITY CONTACT_LEGAL_POSTCODE TEXT
ENTITY CONTACT_EMAIL TEXT
ENTITY CONTACT_ACTUAL_COUNTRY_ISO2 COUNTRY_TYPE
ENTITY CONTACT_ACTUAL_POSTCODE TEXT
ENTITY CONTACT_MOBILE TEXT
ENTITY CONTACT_PHONE TEXT
ENTITY CONTACT_WEBSITE TEXT
ENTITY CONTACT_FAX TEXT
ENTITY CONTACT_ACTUAL_ADDRESS TEXT
ENTITY CONTACT_LEGAL_COUNTRY_ISO2 COUNTRY_TYPE
ENTITY IMAGE_FILENAME TEXT
ENTITY PARTNER_CUSTOMER_ID TEXT
ENTITY PARTNER_SUPPLIER_ID TEXT
ENTITY BANK_NAME TEXT
ENTITY BANK_ACCOUNT_NUMBER TEXT
ENTITY BANK_IBAN TEXT
ENTITY BANK_SWIFT TEXT
ENTITY BANK_IDENTIFICATOR TEXT
ENTITY ORGANISATION_ID TEXT
ENTITY CUSTOMER TEXT
ENTITY SUPPLIER TEXT
ENTITY CUSTOMER_DEBIT_ACCOUNT_ID ACCOUNT
ENTITY CUSTOMER_CREDIT_ACCOUNT_ID ACCOUNT
ENTITY SUPPLIER_DEBIT_ACCOUNT_ID ACCOUNT
ENTITY SUPPLIER_CREDIT_ACCOUNT_ID ACCOUNT
ENTITY CREATOR_USER_ID TEXT
ENTITY CREATE_DATETIME DATE
ENTITY MOD_USER_ID TEXT
ENTITY MOD_DATETIME DATE
ENTITY DEL_USER_ID TEXT
ENTITY DEL_DATETIME DATE
TAX_RATE ID TEXT
TAX_RATE ORGANISATION_ID TEXT
TAX_RATE PERCENT TEXT
TAX_RATE DESCRIPTION TEXT
TAX_RATE TYPE_CODE TAX_RATE_TYPE
TAX_RATE PARTNER_TAX_RATE_ID TEXT
TAX_RATE DEBIT_ACCOUNT_ID ACCOUNT
TAX_RATE CREDIT_ACCOUNT_ID ACCOUNT
TAX_RATE REVENUE_ACCOUNT_ID ACCOUNT
TAX_RATE COEFFICIENT TEXT
TAX_RATE CREATOR_USER_ID TEXT
TAX_RATE CREATE_DATETIME DATE
TAX_RATE MOD_USER_ID TEXT
TAX_RATE MOD_DATETIME DATE
TAX_RATE DEL_USER_ID TEXT
TAX_RATE DEL_DATETIME DATE
PROJECT ID TEXT
PROJECT ORGANISATION_ID TEXT
PROJECT NAME TEXT
PROJECT AFFIRMED BOOLEAN
PROJECT DESCRIPTION TEXT
PROJECT PARTNER_PROJECT_ID TEXT
PROJECT SYNC_ERPLY_USERS BOOLEAN
PROJECT MAIN_PROJECT_ID PROJECT
PROJECT CREATOR_USER_ID TEXT
PROJECT CREATE_DATETIME DATE
PROJECT MOD_USER_ID TEXT
PROJECT MOD_DATETIME DATE
PROJECT DEL_USER_ID TEXT
PROJECT DEL_DATETIME DATE
ARTICLE ID TEXT
ARTICLE ORGANISATION_ID TEXT
ARTICLE TYPE_CODE ARTICLE_TYPE
ARTICLE NAME TEXT
ARTICLE EXPENSE_ACCOUNT_ID ACCOUNT
ARTICLE ASSET_ACCOUNT_ID ACCOUNT
ARTICLE CODE TEXT
ARTICLE VAT_PERCENT TEXT
ARTICLE INFO TEXT
ARTICLE UNIT_CODE UNIT
ARTICLE PARTNER_ARTICLE_ID TEXT
ARTICLE REVENUE_ACCOUNT_ID ACCOUNT
ARTICLE TAX_RATE_ID TEXT
ARTICLE LIFESPAN TEXT
ARTICLE CREATOR_USER_ID TEXT
ARTICLE CREATE_DATETIME DATE
ARTICLE MOD_USER_ID TEXT
ARTICLE MOD_DATETIME DATE
ARTICLE DEL_USER_ID TEXT
ARTICLE DEL_DATETIME DATE
PARTNER_SYNC_HISTORY ID TEXT
PARTNER_SYNC_HISTORY ORGANISATION_ID TEXT
PARTNER_SYNC_HISTORY PARTNER_TYPE_CODE PARTNER_TYPE
PARTNER_SYNC_HISTORY TASK_NAME TEXT
PARTNER_SYNC_HISTORY START_TIME TEXT
PARTNER_SYNC_HISTORY STOP_TIME TEXT
PARTNER_SYNC_HISTORY SYNC_STATUS_TYPE_CODE SYNC_STATUS_TYPE
PARTNER_SYNC_HISTORY SYNC_FROM_TIME TEXT
PARTNER_SYNC_HISTORY CREATOR_USER_ID TEXT
PARTNER_SYNC_HISTORY CREATE_DATETIME DATE
PARTNER_SYNC_HISTORY MOD_USER_ID TEXT
PARTNER_SYNC_HISTORY MOD_DATETIME DATE
ACTIVITY_ITEM id TEXT
ACTIVITY_ITEM ACTIVITY_ID TEXT
ACTIVITY_ITEM TYPE_CODE ACTIVITY_ITEM_TYPE
ACTIVITY_ITEM DESCRIPTION TEXT
ACTIVITY_ITEM VALUE TEXT
ACTIVITY_ITEM NAME TEXT
ACTIVITY_ITEM ROW TEXT
ACTIVITY_ITEM COLUMN TEXT
ACTIVITY_ITEM TRANSACTION_ENTRY_ID TEXT
ACTIVITY_ITEM ORGANISATION_ID TEXT
ACTIVITY_ITEM ENTITY_ID CUSTOMER
ACTIVITY_ITEM DATE_FROM DATE
ACTIVITY_ITEM DATE_TO DATE
ACTIVITY_ITEM DECIMAL_VALUE TEXT
ACTIVITY_ITEM PROJECT_ID PROJECT
ACTIVITY_ITEM MAIN_PROJECT_ID PROJECT
ACTIVITY_ITEM ALTERNATIVE_VALUE TEXT
ACTIVITY_ITEM ALTERNATIVE_VALUE2 TEXT
ACTIVITY_ITEM ALTERNATIVE_VALUE3 TEXT
ACTIVITY_ITEM ALTERNATIVE_VALUE4 TEXT
ACTIVITY_ITEM ALTERNATIVE_VALUE5 TEXT
ACTIVITY_ITEM ALTERNATIVE_VALUE6 TEXT
ACTIVITY_ITEM ALTERNATIVE_VALUE7 TEXT
ACTIVITY_ITEM ALTERNATIVE_VALUE8 TEXT
ACTIVITY_ITEM ALTERNATIVE_VALUE9 TEXT
ACTIVITY_ITEM CREATOR_USER_ID TEXT
ACTIVITY_ITEM CREATE_DATETIME DATE
ACTIVITY_ITEM MOD_USER_ID TEXT
ACTIVITY_ITEM MOD_DATETIME DATE
ACTIVITY_ITEM DEL_USER_ID TEXT
ACTIVITY_ITEM DEL_DATETIME DATE
ORGANISATION_TERM ID TEXT
ORGANISATION_TERM ORGANISATION_ID TEXT
ORGANISATION_TERM PENALTY_PERCENT TEXT
ORGANISATION_TERM MAIN_LANGUAGE_CODE LANGUAGE
ORGANISATION_TERM MAIN_CURRENCY_CODE CURRENCY
ORGANISATION_TERM IF_VAT_LIABLE BOOLEAN
ORGANISATION_TERM FIRST_INVOICE_NUMBER TEXT
ORGANISATION_TERM DEADLINE_DAYS TEXT
ORGANISATION_TERM DIGITS_AFTER_ROUNDING TEXT
ORGANISATION_TERM DEFAULT_EXTRA_CHARGE TEXT
ORGANISATION_TERM DOC_EMAIL_TEXT TEXT
ORGANISATION_TERM REFERRAL_CODE TEXT
ORGANISATION_TERM REFERRED_REFERRAL_CODE TEXT
ORGANISATION_TERM DATE_FORMAT_CODE TEXT
ORGANISATION_TERM ERPLY_CLIENT_CODE TEXT
ORGANISATION_TERM ERPLY_LAST_SYNC_DATETIME DATE
ORGANISATION_TERM ERPLY_CUSTOMER_ENTITY_ID TEXT
ORGANISATION_TERM PRICEPLAN_TYPE_CODE PRICEPLAN_TYPE
ORGANISATION_TERM LOCKING_DATETIME DATE
ORGANISATION_TERM CREATE_TRANSACTIONS_BEFORE_LOCKED_DATE BOOLEAN
ORGANISATION_TERM RECONCILING_DATE DATE
ORGANISATION_TERM USE_ARTICLE_DESCRIPTION TEXT
ORGANISATION_TERM SYNC_WAYBILLS BOOLEAN
ORGANISATION_TERM AUTOMATIC_BANK_INTEGRATION BOOLEAN
ORGANISATION_TERM DASHBOARD_CODE TEXT
ORGANISATION_TERM USE_DOCUMENT_CONFIRMATION BOOLEAN
ORGANISATION_TERM EXTERNAL_INTEGRATIONS TEXT
ORGANISATION_TERM USE_MULTIPLE_PROJECTS BOOLEAN
ORGANISATION_TERM CREATOR_USER_ID TEXT
ORGANISATION_TERM CREATE_DATETIME DATE
ORGANISATION_TERM MOD_USER_ID TEXT
ORGANISATION_TERM MOD_DATETIME DATE
ORGANISATION_TERM DEL_USER_ID TEXT
ORGANISATION_TERM DEL_DATETIME DATE
USER_ORGANISATION_ROLE ID TEXT
USER_ORGANISATION_ROLE USER_ID TEXT
USER_ORGANISATION_ROLE ORGANISATION_ID TEXT
USER_ORGANISATION_ROLE ORGANISATION_ROLE_CODE ORG_ROLE
USER_ORGANISATION_ROLE PROJECT_ID PROJECT
USER_ORGANISATION_ROLE CREATOR_USER_ID TEXT
USER_ORGANISATION_ROLE CREATE_DATETIME DATE
USER_ORGANISATION_ROLE MOD_USER_ID TEXT
USER_ORGANISATION_ROLE MOD_DATETIME DATE
USER_ORGANISATION_ROLE DEL_USER_ID TEXT
USER_ORGANISATION_ROLE DEL_DATETIME DATE
CURRENCY_RATE ID TEXT
CURRENCY_RATE CURRENCY_CODE CURRENCY
CURRENCY_RATE BASE_CURRENCY_CODE CURRENCY
CURRENCY_RATE RATE_VALUE TEXT
CURRENCY_RATE CREATOR_USER_ID TEXT
CURRENCY_RATE CREATE_DATETIME DATE
CURRENCY_RATE MOD_USER_ID TEXT
CURRENCY_RATE MOD_DATETIME DATE
CURRENCY_RATE DEL_USER_ID TEXT
CURRENCY_RATE DEL_DATETIME DATE