Billing Data Overview #
The Billing resource provides access to download invoices and billing data from ~.Dimensions.~.
/{VERSION}/billingdata
Invoice Details Schema #
Customers represent a tenant on the system that end Users can be assigned to via the API.
| Key | Description | Type | Availability |
|---|---|---|---|
| tenantid | The id for the parent reseller account | string | All |
| invoiceid | A unique number to identify a particular invoice | string | All |
| invoicenumber | The invoice number displayed on the PDF invoice | string | All |
| accountname | The company name for the parent reseller account | string | All |
| billingperiodstart | The date the billing period starts | string | All |
| billingperiodend | The date the billing period ends | string | All |
| invoicevalue | The total value of the invoice | double | All |
| invoiceitems | A collection of invoice items | array(Invoice Item | Get Invoice Detail Only |
Invoice Item Schema #
Each entry in the billing data provides the parameters listed below.
| Key | Description | Type |
|---|---|---|
| id | The id for the parent reseller account | string |
| quantity | The quantity used | double |
| value | The cost of the item | double |
| fromdate | The date from which the item is being billed for | string |
| todate | The date from which the item is being billed to | string |
| calculationorder | Sequential number indicating the order in which the Invoice Items should be processed | int |
| operatorused | Indicates how the value of the Invoice Item is being applied to the invoice | Invoice Item Operator |
| operatorvalueused | Indicates the value of the ADJUSTPERCENTAGE operator | double |
| producttagname | The name of the feature/product the Invoice Item is for. This will be in the format '{PRODUCT_NAME} #{PART_NUMBER}' | string |
| billingoutputtags | Indication of whether the Invoice Item is for a purchase or is a summary field | array(string) |
| stringvalues | Provides information on the customer and end user the purchase is for | KeyValuePair<string,string> |
| numericvalues | Provides information on the customer and end user the purchase is for | KeyValuePair<string,double> |
Invoice Item Operators #
The operator for each item indicates how the item is being applied to the bill. PurchaseResult will have a PRICE to identify the cost of the item.Items with other output tags will indicate if they are summing up the value of the bill or applying a percentage value to previous items such as sales tax.
| Items | Description |
|---|---|
| PRICE | Indicates the Invoice Item is showing the unit price of an item |
| SUM | Indicates the Invoice Item is showing a total of multiple items |
| ADJUSTPERCENTAGE | Indicates the Invoice Item is showing a percentage adjustment to the SUM, this usually indicates VAT is being applied |
Billing Output Tag Items #
Billing output tags are used to indicate if the data entry relates to a purchase or is a summary entry providing information about the whole invoice.
| Items | Description |
|---|---|
| PurchaseResult | Indicates the Invoice Item is a chargeable purchase |
| Summary | Indicates the Invoice Item is a summary of purchases, providing information on the total of the invoice. When on its own without the 'TotalVAT' or 'TotalInclVAT' tags then it indicates the bill total before VAT is added. |
| TotalInclVAT | Indicates the Invoice Item is showing the invoice total including any applicable VAT |
| TotalVAT | Indicates the Invoice Item is showing the total applicable VAT for the invoice |
String Value Items #
The string value items provide information specific to the customer and end user of the purchased item.
| Key | Description |
|---|---|
| TenantCode1 | The customer tenant id |
| TenantCodeext1 | The reseller's reference for the customer |
| TenantName1 | The name of customer |
| ResellerCode | The reseller's tenant id |
| ResellerCodeExt2 | The extended reference for the reseller |
| ResellerName | The name of the reseller |
| UserId | The id of the user |
| Username | The username of the user |
| role | The role key for the billed item |
Numeric Value Items #
The numeric value items provide information specific to the customer and end user of the purchased item.
| Key | Description |
|---|---|
| customer_licence_count | The total number of these licenses the customer has |
Available Interfaces #
| Interface | Description |
|---|---|
| Get All | Returns a collection of all invoices. |
| Get Invoice | Returns the details of a specific invoice. |
| Get Invoice Detail | Returns JSON & CSV data output of a specific invoice in a ZIP file. |
| Get Invoice Summary | Returns the PDF data output of a specific invoice. |
-
The 'TenantCode', 'TenantCodeExt' and 'TenantName' fields are populated with information about the customer's account. ↩︎
-
The ResellerCodeExt will be populated with the Reference number that has been configured against the reseller. This can be updated as required through the Enterprise Portal or through the Customer API, to allow linking of reseller records to external systems. ↩︎