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!
URL: | https://api.kashflow.com/v2/metadata |
Method(s): | get |
Response Formats: | JSON, XML |
Description: | This method allows you to retrieve the user account’s state information |
Response elements
| Name | Type | Description |
|---|---|---|
| TotalProductCount | Numeric | Count of the total number of products in the account. |
| TotalNominalCount | Numeric | Count of the total number of nominals in the account. |
| TotalCustomerCount | Numeric | Count of the total number of customers in the account. |
| TotalInvoiceCount | Numeric | Count of the total number of invoices in the account. |
| TotalBankBalance | Numeric | Bank balance in the account. |
| TotalLoginCount | Numeric | Count of the total number of logins into the account since its creation. |
| UserHasAmazonFiles | Boolean | Indicates whether user has amazon files or not. |
| AmazonFilesMarkedforMigration | Boolean | Indicates whether amazon files migration is started or not. |
| PayrollProvisioningStatus | String | Status of Payroll provisioning. The possible values “NotInitiated”, “Queued” (Lined up for the request to be sent) and “RequestSent” (Provisioning request sent) |
| TotalSupplierCount | Numeric | Count 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"
}