Billing Line Details API Details

GET /api/resellers/{resellerId}/billing/reports/BillingLineDetails

Returns detailed, paginated billing lines.

resellerId

path

GUID

Yes

Reseller identifier.

startDate

query

date

Yes

• Start of billing period (inclusive).

  • YYYY-MM-DD

endDate

query

date

Yes

• End of billing period (inclusive).

  • YYYY-MM-DD

organizationIds

query

GUID[]

No

Filter by organization. Repeatable.

organizationGroupIds

query

GUID[]

No

Filter by organization group. Repeatable.

serviceIds

query

GUID[]

No

Filter by service. Repeatable.

splitByCostCenter

query

boolean

No

When true, populates the costCenters breakdown per line. Default is false.

convertToCurrency

query

string

No

If convertToCurrency is omitted, amounts are returned in the default sales/cost currency. If supplied, it must be a valid 3-letter ISO 4217 code.

pageToken

header

string

No

Page token from a previous response's nextPageToken header. See pagination section for more details in the API Guide for Billing Integration.

billingLineId

GUID

Unique identifier of the billing line.

billingDate

date

Date the billing was generated for this line (varies by service).

serviceId

GUID

Identifier of the service the line belongs to.

serviceName

string

Name of the service.

organizationId

GUID

Identifier of the end-customer organization being billed.

organizationName

string

Display name of the organization being billed.

customerNumber

string

Reseller assigned customer number for the organization.

productId

string

The product identifier.

productName

string

Name of the product.

itemCode

string

Vendor item/SKU code for the billed item.

quantity

decimal

Number of units / licenses / seats billed on this line.

unitCostPrice

decimal

Cost price per unit.

unitSalesPrice

decimal

Sales price per unit.

unitRecommendedPrice

decimal

The recommended sales price per unit.

totalCost

decimal

Total reseller cost for the line (quantity × unitCostPrice).

totalSales

decimal

Total customer price for the line (quantity × unitSalesPrice).

totalRecommendedPrice

decimal

Total recommended price (quantity × unitRecommendedPrice).

totalDifferenceFromRecommended

decimal

How far the actual sales price deviates from the recommended (totalSales − totalRecommendedPrice).

marginAmount

decimal

Gross margin (totalSales − totalCost).

marginPercentage

decimal

Margin as a percentage of sales ((totalSales − totalCost) / totalSales × 100).

priceLevel

int

Pricing level applied to the line from the Cloudmore pricing configuration.

priceRuleType

int

Type of pricing rule that produced the price.

costCurrencyCode

string

Currency of the cost price.

salesCurrencyCode

string

Currency of the sales price.

subscriptionPeriod

string

• Term/commitment length of the subscription.

  • 1 Month

  • 3 Months

  • 1 Year

  • 3 Years

  • 4 Years

  • 5 Years

paymentFrequency

string

• How often the subscription is billed

  • One-time

  • Monthly

  • Every 3 months

  • Every 6 months

  • Annual

  • Every 2 years

  • Every 3 years

  • Every 4 years

  • Every 5 years

purchaseOrderNumber

string

Optional purchase order number set by the reseller on the subscription.

subscriptionId

GUID

Identifier of the subscription the line belongs to.

subscriptionName

string

Friendly name of the subscription.

billingLineDetails

string

Human readable description of the charge.

organizationGroups

string[]

Names of the organization groups the organization belongs to.

organizationRegistrationNumber

string

Company registration number of the organization.

primaryDomain

string

Primary domain of the organization.

chargeType

string

Type of charge that generated the line (e.g. new, addQuantity, cycleCharge).

chargeStartDate

date

Start of the period the charge covers.

chargeEndDate

date

End of the period the charge covers.

tenantId

string

Vendor tenant identifier (e.g. the Microsoft tenant) associated with the line.

invoiceId

string

Vendor invoice identifier the line originated from.

invoiceDate

date

Date of the vendor invoice.

vendorPricingTags

string[]

Human readable tags explaining how the price was derived (discounts, FX conversion, price guarantees, term pricing, etc.).

customProperties

object[]

Custom name/value properties defined on the subscription.

costCenters

object[]

Per-cost-center breakdown of this line. null unless splitByCostCenter=true.

costCenterId

GUID

Identifier of the cost center.

costCenterName

string

Name of the cost center.

quantity

decimal

Portion of the line's quantity attributed to this cost center.

totalCost

decimal

Cost attributed to this cost center.

totalSales

decimal

Sales attributed to this cost center.

totalMarginAmount

decimal

Margin (totalSales − totalCost) for this cost center.

totalRecommendedPrice

decimal

Recommended price for the attributed portion.

totalDifferenceFromRecommended

decimal

Difference from recommended for the attributed portion.