List Billing Details

You can retrieve the full billing details for an organisation within a specific billing period. This includes monthly recurring fees (MRCs) such as a basic charge for the tariff plan, possible fees per activated SIM and accumulated usage fees for teleservices. In a multi-inclusive-volume scenario (multiple inclusive volumes active for an enterprise during the billing period) the data traffic will be split by tariff profiles attached to the endpoints at the point of the invoice creation or preview generation. The `sim_items` will list the charges for the inclusive volumes by tariff profile with respect to the assigned endpoints with active SIMs, and the `traffic.data` will have a shallow grouping with the `tariff_profile` object. * `period` (String) Textual representation of billing period | "October 1 - October 31, 2017" * `total` (Object) | | * `total.cost` (Number) Total invoice amount | 389.21 * `total.currency` (Object) Currency of invoice amount * `total.currency.code` (String) ISO4217 Currency code | EUR * `sub_total` (Object) * `sub_total.cost` (Number) Sub-Total invoice amount before any VAT calculation | 389.21 * `sub_total.currency` (Object) Currency of invoice amount * `vat` (Object) * `vat.rate` (Number) Applicable VAT rate in percentage | 19.000000 * `vat.cost` (Number) Calculated VAT amount | 118.21 * `vat.currency` (Object) Currency of VAT amount * `mrc` (Object) Monthly Recurring Revenues * `traffic` (Object) Usage fees for tele-services * `traffic.data` (Object) Mobile Data Charges * `traffic.data.tariff` (Array) Charges per Usage Tariff * `traffic.data.tariff[].ratezone` (Array) Charges per Ratezone * `traffic.data.tariff[].tariff_profile` (Object) The tariff_profile if charges get split by tariff profile * `traffic.data.tariff[].ratezone[].countries` (Array) Charges per Country * `sms.data` (Object) SMS Charges * `traffic.sms.tariff` (Object) Charges per Usage Tariff * `issuer_org` (Object) Issuing Company Identity * `customer_org` (Object) Customer Identity

Authentication

AuthorizationBearer

An auth_token should be provided to authenticate a session.

To obtain an auth_token, see the POST request to /api/v1/authenticate.

Path parameters

org_iddoubleRequired
Numerical ID of an organization
billing_periodstringRequiredformat: "^\d{6}$"

The billing period in the format YYYYMM

Response

Success
sub_totalobject
customer_orgobject
issuer_orgobject
vatobject
totalobject
periodstring
sim_itemsobject or null
trafficobject or null
mrcobject or null
Monthly recurring charges
invoiceobject or null
Only available if the bill has been persisted to the database
payment_optionobject or null
The payment option used to pay the bill. Only available for paid bills.
refresh_allowedboolean or null

Whether the invoice can be regenerated using the force_refresh flag

invoice_itemslist of objects or null
tariff_planlist of objects or null