Knowledgebase AccountingSuite Reports Tools External Tools

            Data Mapping


            Dashboard Web Services – Data Mapping


            AccountingSuite provides HTTP (RESTful) services to get common financial and statistical data. You can use these services to work with external BI/Analytics Dashboards, like Zoho Reports, eazyBI, Knowi, Klipfolio etc.
            We provide the following web services:
            1. The service daily_snap provides statistical information like ending balances (count) for a specific date.
            2. The service financial_performance provides financial information as turnovers for a specific date.

            Technical Details about the Services


            The following URLs (endpoints) are available to access data:


            Replace {account_number} in the URL with your AccountingSuite Account Number.  Your account number may be found in the upper left corner of the application when logged in.  It is a 7 digit number starting with 110

            These services use Basic HTTP Authentication. This ensures that the data feed URLs are secure and passwords transmitted are encrypted and safe.


            Request Details


            The services use GET methods with two optional parameters: BeginOfPeriod and EndOfPeriod. The format of the parameters is yyyyMMdd (four digits of year two digits of the month (from 01 to 12) and two digits of the day (from 01 to 31)).

            A query string looks like “?BeginOfPeriod=20160101&EndOfPeriod=20161231”.

            Example: https://apps7.accountingsuite.com/a/1100000/hs/data_mart/financial_performance/?BeginOfPeriod=20160101&EndOfPeriod=20161231

            You can use parameters in the following ways:

            • If a query string has both parameters, service will return data for the selected period.
            • If a query string only has BeginOfPeriod, service will return data from BeginOfPeriod to the current date.
            • If a query string only has EndOfPeriod, service will return data from the beginning of the time to EndOfPeriod;
            • If a query string is empty (no parameter specified), service will return all data for the Account.

            Response Details

            1. financial_performance:

            Name

            Type

            Description

            Example

            TenantID

            Text (10)

            Current account number

            1100000

            CompanyName

            Text (200)

            Name of company

            MyCompany Inc.

            APIKEY

            Text (50)

            Your API key (found in Settings → Integrations

            ZGVtb0BhY2NvdW50aW5

            Year

            Date

            Year of the data

            01/01/2017

            Month

            Date

            Month of the data

            06/01/2017

            Date

            Date

            Date of the data

            06/21/2017

            Income

            Number (17.2)

            Daily income amount for the following account types (accrual basis): Income, Other Income

            3850.00

            Expense

            Number (17.2)

            Daily expenses amount for the following account types (accrual basis): Cost of sales, Expense, Other expense, and Income tax expense

            986.00

            For updates, prospective key fields are TenantID and Date.

            2. daily_snap:

            Name

            Type

            Description

            Example

            TenantID

            Text (10)

            Current account number

            1100000

            CompanyName

            Text (200)

            Name of  company 

            MyCompany Inc.

            APIKEY

            Text (50)

            Your API key

            ZGVtb0BhY2NvdW50aW5

            Year

            Date

            Year of the data

            01/01/2017

            Month

            Date

            Month of the data

            06/01/2017

            Date

            Date

            Date of the data

            06/21/2017

            ActiveUsersCount

            Number (10)

            Count of active users for the day 

            10

            DisabledUsersCount

            Number (10)

            Count of disabled users for the day 

            5

            TransactionsCount

            Number (10)

            Count of all posting transactions by the end of the day

            35,850

            SalesOrdersOpen

            Number (10)

            Count of all open sales orders by the end of the day

            9

            SalesOrdersClosed

            Number (10)

            Count of all closed sales orders by the end of the day

            150

            PurchaseOrdersOpen

            Number (10)

            Count of all open purchase orders by the end of the day

            2

            PurchaseOrdersClosed

            Number (10)

            Count of all closed purchase orders by the end of the day

            95

            SalesInvoicesOpen

            Number (10)

            Count of all open sales invoices by the end of the day

            4

            SalesInvoicesPaid

            Number (10)

            Count of all paid sales invoices by the end of the day

            250

            BillsOpen

            Number (10)

            Count of all open bills by the end of the day

            0

            BillsPaid

            Number (10)

            Count of all paid bills by the end of the day

            80

            BankingConnections

            Number (10)

            Count of active banking connections at the day

            3

            For updates, prospective key fields are TenantID and Date.


            Example Response

            Response from the HTTP services are JSON Arrays with structured data:

            Example

            Request: https://apps7.accountingsuite.com/a/1100000/hs/data_mart/daily_statistic/?BeginOfPeriod=20170629

            Response:

            [

            {

            “TenantID”: “1100000”,

            “Date”: “2017-06-29T00:00:00”,

            “APIKEY”: ” ZGVtb0BhY2NvdW50aW5n”,

            “Year”: “2017-01-01T00:00:00”,

            “Month”: “2017-06-01T00:00:00”,

            “ActiveUsersCount”: 15,

            “DisabledUsersCount”: 2,

            “TransactionsCount”: 3121,

            “SalesOrdersOpen”: 10,

            “SalesOrdersClosed”: 250,

            “PurchaseOrdersOpen”: 5,

            “PurchaseOrdersClosed”: 120,

            “SalesInvoicesOpen”: 9,

            “SalesInvoicesPaid”: 495,

            “BillsOpen”: 2,

            “BillsPaid”: 90,

            “BankingConnections”: 5

            },

            {

            “TenantID”: “1100000”,

            “Date”: “2017-06-30T00:00:00”,

            “APIKEY”: ” ZGVtb0BhY2NvdW50aW5n”,

            “Year”: “2017-01-01T00:00:00”,

            “Month”: “2017-06-01T00:00:00”,

            “ActiveUsersCount”: 15,

            “DisabledUsersCount”: 2,

            “TransactionsCount”: 3125,

            “SalesOrdersOpen”: 10,

            “SalesOrdersClosed”: 250,

            “PurchaseOrdersOpen”: 5,

            “PurchaseOrdersClosed”: 120,

            “SalesInvoicesOpen”: 9,

            “SalesInvoicesPaid”: 495,

            “BillsOpen”: 2,

            “BillsPaid”: 90,

            “BankingConnections”: 5


            Updated: 02 Apr 2019 10:18 AM
            Helpful?  
            Help us to make this article better
            0 0