Microsoft Billed Invoice - Version 16.0

Modified on Mon, 19 Oct at 1:23 PM

Overview

The Microsoft Billed Invoice collector retrieves billed invoice reconciliation data from the Microsoft Partner Center API, providing detailed visibility into invoiced charges across managed customer tenants for a given billing period.

This collector produces a single record type representing invoiced line items for license-based, one-time, and recurring charges. Each record includes the subscription, product, quantity, and pre-tax billing totals for a specific charge period.

The collector retrieves rated data, meaning monetary values (cost and total) are supplied by the source system and included in each record submitted to Varibill.

This collector retrieves invoice data for a configurable billing period, with an offset parameter that controls which invoice month to collect. The data reflects charges as they appear on finalised Microsoft Partner Center invoices.

For general instructions on creating and running Source Collectors, see: Configuring a New Cloud Source Collector

Collector Summary

Field Value
Source Collector Name Microsoft Billed Invoice - Version 16.0
Collection Behavior Period-Based (Invoice Month)
Rating Model Rated
Vendor Name Microsoft
Product Microsoft Partner Center (Billed Invoice Reconciliation)
Purpose Retrieves billed invoice line items from Microsoft Partner Center for billing reconciliation within Varibill

About Microsoft Partner Center

Microsoft Partner Center is the platform through which Cloud Solution Provider (CSP) partners manage their customers’ Microsoft cloud subscriptions and services. Partner Center provides APIs for programmatic access to billing, usage, and reconciliation data across the partner’s managed customer base.

The Billed Invoice Reconciliation API returns detailed line-item data for charges that have been finalised and invoiced. Each line item includes the customer, subscription, product, SKU, quantity, and pre-tax billing totals for a specific charge period.

Access to the Partner Center API requires an Entra ID (formerly Azure Active Directory) application registration with the appropriate Partner Center API permissions.

Data Collected

The Microsoft Billed Invoice - Version 16.0 collector retrieves rated invoice reconciliation data from the Microsoft Partner Center Billed Invoice Reconciliation API. The collector downloads invoice data for the configured billing period, extracts individual invoice line items, and aggregates them before submission.

Invoice Line Items (Per Record)

For each billed invoice line item returned by the API: - A record representing an invoiced charge, with a quantity reflecting the number of units and cost values reflecting the pre-tax billing totals

If Bill Azure Portal Price is enabled, the cost and total values are calculated as the unit price multiplied by the billable quantity. Otherwise, the subtotal from the invoice is used directly.

The Cost and Total values are always equal for this collector (no markup is applied).

For credit line items (where the subtotal is negative), the quantity is negated to reflect the credit adjustment.

Records are aggregated by Client Identifier, Product Identifier, Record Identifier, Unique Identifier, Last Seen Date, and Tag. When multiple line items share these values, their Cost, Quantity, and Total values are summed.

The identifiers submitted to Varibill for each record are constructed as follows:

  • Client Identifier — a composite of the Tier 2 MPN ID, Customer ID, and Subscription ID, separated by #
  • Product Identifier — a composite of the Product ID, SKU ID, term and billing cycle, and billing frequency, separated by # (for example, CFQ7TTC0LH18#0001#One-Year commitment for monthly/yearly billing#Monthly)
  • Record Identifier — a description in the format {product description} ({charge start date} - {charge end date}), where the product description is the Meter Description if available, otherwise the SKU Name (for example, Microsoft 365 Business Basic (2026-09-06 - 2026-10-05))
  • Unique Identifier — a composite of the Subscription ID, Reference ID, and Charge Start Date, separated by #
  • Tag — a multi-line value containing the customer name, subscription description, and product description
  • Last Seen Date — the order date from the invoice line item, capped at the last day of the billing period if the order date exceeds it
  • Cost — the pre-tax subtotal (or unit price multiplied by billable quantity when Bill Azure Portal Price is enabled)
  • Total — equal to Cost

Azure Record Filtering

By default, the collector excludes invoice line items where the Product Category is “Azure” and the Subscription Description is “Azure plan”. These records represent Azure consumption charges that are typically collected separately by an Azure-specific usage collector.

To include Azure plan records in the billed invoice collection, enable the Include Azure parameter.

Note: If you are also running the Microsoft Unbilled Usage collector, leaving Include Azure disabled avoids collecting Azure consumption data from both the invoice and usage APIs.

Prerequisites

Before configuring this collector, ensure that:

  • You are a Microsoft Cloud Solution Provider (CSP) partner with access to Partner Center
  • You have an Entra ID (Azure AD) application registration with Partner Center API permissions
  • You have obtained the Tenant ID, Client ID, and Client Secret for the application
  • You know the currency code for your billing region
  • You have access to the Varibill Source Collector configuration screen

Warning! The Microsoft Client Secret grants API access to your Partner Center billing data. Store it securely and do not share it. This value is masked in the Varibill UI once saved. If it is compromised, rotate the secret in your Entra ID application registration immediately.

Configuration Parameters

The parameters below are entered when configuring the collector in Varibill. They are grouped by function.

Connection Parameters

These parameters authenticate against the Microsoft Partner Center API using an Entra ID application registration.

Parameter What it is Where to find it
Microsoft Tenant ID The GUID identifying your Microsoft Entra ID tenant Entra ID portal > Tenant properties
Microsoft Client ID The GUID identifying your registered application Entra ID > App registrations > your app > Application (client) ID
Microsoft Secret Key The client secret for your registered application Entra ID > App registrations > your app > Certificates & secrets

Warning! The Microsoft Secret Key is a sensitive credential. It is masked in the Varibill UI once saved. If it is compromised, rotate the secret in your Entra ID application registration immediately.

Invoice Parameters

These parameters control which invoice data the collector retrieves from the Partner Center API.

Parameter What it is Example
Invoice Month Offset The number of months back from the current month to retrieve invoice data for. A value of 1 retrieves the previous month’s invoice. 1
Currency Code The ISO currency code for the billing data to retrieve USD
Billing Period The billing period identifier for the invoice data one_time
Attribute Set The attribute set that determines the level of detail returned by the API full

Data Filter Parameters

Parameter What it is Default
Include Azure When enabled, includes Azure plan line items in the collection. When disabled, Azure plan records are excluded. See Azure Record Filtering. false

Pricing Parameters

Parameter What it is Default
Bill Azure Portal Price When enabled, the Cost and Total values are calculated as the unit price multiplied by the billable quantity (reflecting the Azure portal price) instead of using the invoice subtotal. false

Output Parameters

Parameter What it is Default
Generate Invoice CSV File When enabled, the collector generates an additional CSV file containing the full raw invoice data alongside the standard JSON output. false

API Parameters

These parameters control the API request behavior and retry logic.

Parameter What it is Default
Http API Prefix The protocol prefix for the API endpoint https://
Number of Invoice File Retrieval Retries The number of times the collector retries retrieving invoice data if the initial request does not return results immediately 8
Retry Interval in Seconds The number of seconds to wait between retry attempts 900

Note: The Microsoft Partner Center API may take time to prepare large invoice data files. The retry parameters allow the collector to wait and re-request the data until it is available. The default configuration retries up to 8 times at 15-minute intervals (up to 2 hours total).

Operational Parameters

These parameters control file management behavior.

Parameter What it is Default
Delete data files older than The number of days after which locally stored collection files are automatically deleted. Must be at least 1. 62
Maximum number of records per file The maximum number of records written to a single output file before a new file is started. Must be between 1,000 and 50,000. 10000

Configuration Steps

Step 1: Register an Application in Microsoft Entra ID

  1. Sign in to the Entra ID portal.
  2. Navigate to App registrations and register a new application (or use an existing one with Partner Center API permissions).
  3. Note the Tenant ID and Client ID (Application ID).
  4. Under Certificates & secrets, create a new client secret and note the Secret Value immediately — it is only shown once.

Step 2: Ensure Partner Center API Permissions

  1. Ensure the application has the necessary permissions to access the Partner Center API for billed invoice reconciliation data.
  2. Refer to the Microsoft Partner Center API documentation for the required permissions and setup steps.

Step 3: Configure the Collector in Varibill

  1. In the Varibill User Interface, open the Source Collector configuration screen.

  2. Enter the required field values under the Details tab:

    • Hosting Provider: Select Varibill Cloud
    • Source Collector Name: Select Microsoft Billed Invoice - Version 16.0
  3. Enter the connection parameters:

    • Microsoft Tenant ID: The Entra ID tenant GUID
    • Microsoft Client ID: The application (client) ID GUID
    • Microsoft Secret Key: The client secret value
  4. Configure the invoice parameters:

    • Invoice Month Offset: The number of months back to retrieve (for example, 1 for the previous month)
    • Currency Code: The ISO currency code (for example, USD)
    • Billing Period: The billing period identifier (for example, one_time)
    • Attribute Set: The level of detail (for example, full)
  5. Configure the data filter and pricing parameters as needed:

    • Include Azure: Enable if you want to include Azure plan charges in this collection
    • Bill Azure Portal Price: Enable if you want to use Azure portal pricing instead of the invoice subtotal
  6. Optionally enable CSV output:

    • Generate Invoice CSV File: Enable if you need a raw CSV export of the invoice data
  7. Save the collector configuration.

Step 4: Run the Collector

Run or schedule the collector according to your standard Source Collector execution process.

For detailed instructions, see: Configuring a New Cloud Source Collector

Note: The collector may take a significant amount of time to complete for large invoice data sets, as the Microsoft Partner Center API can require multiple retries before the invoice data file is available. Monitor the collector’s execution status and adjust the retry parameters if needed.

Troubleshooting

If the collector fails to connect to Microsoft Partner Center, verify that:

  • The Microsoft Tenant ID is correct and matches your Entra ID tenant.
  • The Microsoft Client ID is correct and matches your registered application.
  • The Microsoft Secret Key is valid and has not expired. Client secrets have configurable expiration dates in Entra ID.
  • The application has the required Partner Center API permissions.

If the collector connects successfully but returns no data, verify that:

  • The Invoice Month Offset is set correctly for the billing month you want to retrieve.
  • The Currency Code matches the currency used in your Partner Center billing configuration.
  • There are invoiced charges for the specified billing period under your managed customer subscriptions.
  • The Number of Invoice File Retrieval Retries and Retry Interval in Seconds values are sufficient — large invoice data sets may need more retries or longer intervals.

If the collector returns data but expected records are missing, verify that:

  • The Include Azure parameter is configured correctly. Azure plan records are excluded by default.
  • The billing period and invoice month offset combination targets the correct invoice month.

If the Cost and Total values do not match expectations, verify that:

  • The Bill Azure Portal Price parameter reflects your intended pricing source. When enabled, it uses the unit price multiplied by the billable quantity; when disabled, it uses the invoice subtotal directly.

Microsoft References

The following resources may assist with locating values or configuring your Microsoft Partner Center API access.

Microsoft Documentation (External)

Note: Microsoft documentation is provided for reference. Interface labels and available features may vary depending on your Partner Center agreement type and Entra ID configuration.

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article