This s a documentation page for our shiny new REST API - you weren't meant to find it. This API isn't ready for public use yet. We're chopping and changing it a LOT as we grow it. So if you build something that uses it then it's very likely to break in a future update. Don't say you weren't warned!




Response Formats:



This method allows you to retrieve the user account’s state information

Response elements

TotalProductCountNumericCount of the total number of products in the account.
TotalNominalCountNumericCount of the total number of nominals in the account.
TotalCustomerCountNumericCount of the total number of customers in the account.
TotalInvoiceCountNumericCount of the total number of invoices in the account.
TotalBankBalanceNumericBank balance in the account.
TotalLoginCountNumericCount of the total number of logins into the account since its creation.
UserHasAmazonFilesBooleanIndicates whether user has amazon files or not.
AmazonFilesMarkedforMigrationBooleanIndicates whether amazon files migration is started or not.
PayrollProvisioningStatusStringStatus of Payroll provisioning. The possible values “NotInitiated”, “Queued” (Lined up for the request to be sent) and “RequestSent” (Provisioning request sent)
TotalSupplierCountNumericCount of the total number of suppliers in the account.

GET Operation

To get the metadata

URL : /metadata

Example response for GET of metadata

    "TotalBankBalance": 0.0000,
    "TotalCustomerCount": 1002,
    "TotalInvoiceCount": 1084,
    "TotalLoginCount": 2421,
    "TotalNominalCount": 15,
    "TotalProductCount": 1280,
    "UserHasAmazonFiles": true,
    "AmazonFilesMarkedforMigration" : false,
    "TotalSupplierCount": 68,
    "PayrollProvisioningStatus": "NotInitiated"

See how IRIS KashFlow works with your business and your books