List billing details | emnify Documentation

curl https://cdn.emnify.net/api/v1/organisation/6797/billing/202203 \
     -H "Authorization: Bearer <token>"

{
  "sub_total": {
    "cost": 532530.506327,
    "currency": {
      "currency_id": "1",
      "code": "EUR",
      "symbol": "€"
    }
  },
  "customer_org": {
    "name": "org6797",
    "id": 6797
  },
  "issuer_org": {
    "name": "org2",
    "id": 2
  },
  "vat": {
    "rate": "19.000000",
    "cost": 101180.79620213,
    "currency": {
      "currency_id": "1",
      "code": "EUR",
      "symbol": "€"
    }
  },
  "total": {
    "cost": 633711.30252913,
    "currency": {
      "currency_id": "1",
      "code": "EUR",
      "symbol": "€"
    }
  },
  "period": "March 1 - March 31, 2022",
  "sim_items": {
    "total": {
      "number_of_active_sims_chargeable": 3,
      "cost": 3.3,
      "sim_activation_fees": 0,
      "sim_hosting_fees": 0.6
    },
    "data": [
      {
        "description": "SIM Hosting Fees",
        "comment": "Fee per active SIM",
        "settlement": "Monthly Payment",
        "volume": "3 SIM(s)",
        "amount": 0.6
      },
      {
        "description": "Inclusive Data Volume",
        "comment": "Included per active SIM",
        "settlement": "Monthly Payment",
        "volume": "3000 MB",
        "amount": 2.7
      }
    ]
  },
  "traffic": {
    "data": {
      "tariff": [
        {
          "id": 557,
          "name": "Regional Pro",
          "ratezone": [
            {
              "id": 3519,
              "name": "Africa",
              "rate": "1.000000",
              "tariff": "Regional Pro",
              "countries": [
                {
                  "ratezone": "Africa",
                  "ratezone_id": "3519",
                  "rate": "1.000000",
                  "rate_volume": 1,
                  "country": {
                    "name": "Nigeria"
                  },
                  "volume": "12939.462934",
                  "cost": 12939.462934,
                  "currency": {
                    "code": "EUR"
                  }
                }
              ],
              "volume": 12939.462934,
              "cost": 9939.462934,
              "data_package_volume": 0,
              "currency": {
                "code": "EUR"
              },
              "inclusive_volume": 3000
            }
          ],
          "volume": 142125.158983,
          "cost": 82945.866327,
          "currency": {
            "code": "EUR"
          }
        }
      ],
      "total": {
        "volume": 142125.158983,
        "cost": 82945.866327,
        "currency": {
          "code": "EUR"
        }
      }
    },
    "sms": {
      "tariff": [
        {
          "id": 557,
          "name": "Regional Pro",
          "ratezone": [
            {
              "id": 3519,
              "name": "Africa",
              "tariff": "Regional Pro",
              "countries": [
                {
                  "ratezone": "Africa",
                  "ratezone_id": "3519",
                  "country": {
                    "name": "Nigeria"
                  },
                  "volume": "94916.000000",
                  "cost": "40010.3700000000",
                  "tariff": "Regional Pro",
                  "tariff_id": "557",
                  "currency": {
                    "code": "EUR"
                  }
                }
              ],
              "volume": 94916,
              "cost": 40010.37,
              "currency": {
                "code": "EUR"
              }
            }
          ],
          "volume": 1043384,
          "cost": 449581.34,
          "currency": {
            "code": "EUR"
          }
        }
      ],
      "total": {
        "volume": 1043384,
        "cost": 449581.34,
        "currency": {
          "code": "EUR"
        }
      }
    }
  }
}

You can retrieve the full billing details for an organization 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

You can retrieve the full billing details for an organization 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

trafficobject

mrcobject

Monthly recurring charges

invoiceobject

Only available if the bill has been persisted to the database

payment_optionobject

The payment option used to pay the bill. Only available for paid bills.

refresh_allowedboolean

Whether the invoice can be regenerated using the force_refresh flag

invoice_itemslist of objects

tariff_planlist of objects