Gets all the invoice one time line items of an invoice for resellers, using pagination.

GET /v1/Invoices/{id}/reseller-onetime-lineitems

Returns a subset of the invoice one time line items of an invoice on each request for reseller. Pass the continuation token in the headers to obtain the remaining items. Available to the roles: reseller

Headers

  • This header should not be set when the first page is desired. For the second page and onwards, pass the continuation token received in the response body.

  • X-Tenant string Required

    This header identifies which tenant to access with this request. This value should be an existent domain for the specified tenant.

  • Authorization string Required

    JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

    Default value is Bearer eyJ0eXAiO....

  • X-Correlation-Id string(UUID)

    This header is optional and by setting it you can correlate the audit logs made by this request.

Path parameters

  • id string(uuid) Required

    The id of the invoice.

Query parameters

  • pageSize integer(int32) Required

    The number of items to be returned at max per page. The size can range between 1 and 2000.

Responses

  • The request completed with success and returns the line items and the continuation token (if applicable).

    Hide response attributes Show response attributes object
    • items array[object] | null

      A model that represents a single charge of a one time invoice specific for Resellers. In the case of the Microsoft provider this charge can be an:

      • Azure Plan,
      • Azure Savings Plan,
      • Azure Reservation,
      • New Commerce License Subscription,
      • Software Subscription,
      • Perpetual Software Subscription,
      • Marketplace Subscription.
      Hide items attributes Show items attributes object
      • id string(uuid)

        The id that uniquely identifies a one time invoice line item.

      • The purchase order number of the subscription associated with this charge.

      • customerId string(uuid) | null

        The id of the customer associated to this charge. Can be null.

      • customerName string | null

        The company name of the customer.

      • customerInternalId string | null

        The internal id of the customer associated with this charge.

      • subscriptionId string(uuid) | null

        The id of the subscription associated to the charge. Can be null.

      • subscriptionName string | null

        The name of the subscription associated with the charge.

      • The internal id of the subscription associated with this charge.

      • offerProviderId string | null

        The offer id on the provider's side that identifies the subscription associated to the charge.

      • offerName string | null

        The name of the offer associated to the subscription.

      • The id of the subscription associated to this charge on the provider's side.

      • orderId string | null

        The id that identifies the order associated to the charge.

      • orderDate string(date-time) | null

        The date the order was placed.

      • customerCountry string | null

        The country in which the customer is located.

      • currency string | null

        The currency associated with the line item.

      • chargeType string | null

        The type of charge on this line item. Possible values for the Microsoft provider include:

        • new: When you buy a new subscription.
        • renew: When you renew your subscription.
        • cycleCharge: Regular recurring charges for your subscription.
        • addQuantity: Refunds and charges when you add seats.
        • removeQuantity: Refunds and charges when you remove seats.
        • moveQuantity: When you upgrade to an existing subscription.
        • cancelImmediate: When you cancel your subscription.
        • convert: When you change from a free trial to a paid subscription or upgrade to a new subscription.
        • changeBillingPlan: Changing from monthly to yearly billing or vice versa.
        • customerCredit: Credits for Azure, SLA, among others.
        • extendTerm: When you are given a longer trial period.
      • termAndBillingCycle string | null

        The term and billing cycle associated with this purchase.

      • chargeStartDate string(date-time)

        The billing start date for this charge.

      • chargeEndDate string(date-time)

        The billing end date for this charge.

      • unitType string | null

        The type of the unit.

      • unitPriceForReseller number(double) | null

        The unit price for reseller.

      • unitPriceForCustomer number(double) | null

        The unit price for customer.

      • quantity number(double)

        The quantity of the subscription associated to the charge.

      • subtotalForReseller number(double) | null

        The total before taxes for the reseller.

      • subtotalForCustomer number(double) | null

        The total before taxes for the customer.

      • taxForReseller number(double) | null

        The tax value for the reseller.

      • taxForCustomer number(double) | null

        The tax value for the customer.

      • totalForReseller number(double) | null

        The total for reseller after taxes.

      • totalForCustomer number(double) | null

        The total for customer after taxes.

      • customerProviderId string | null

        The id of customer on the provider's side associated to this charge.

      • pricingCurrency string | null

        The currency of the UnitPriceForReseller and UnitPriceForCustomer. This currency may differ from the invoice billing currency.

      • billingFrequency string | null

        The billing frequency of the subscription associated to the charge. Can also be empty.

      • billableQuantity number(double)

        The amount of units billed.

      • customerPriceMargin number(double) | null

        The customer price margin according to CustomerPriceMarginRule.

      • The customer price margin rule. The possible values are: markup, margin, grossmargin and erpminusdiscount.

      • subscriptionPriceMargin number(double) | null

        The subscription price margin according to SubscriptionPriceMarginRule.

      • The subscription price margin rule.

      • providerData object | null

        A dictionary that maps from strings to strings that contains specific provider invoice data.
        If this line item is associated to a Microsoft invoice then there are a set of properties that are common to each charge: CustomerDomainName: The domain of the customer. ProductId: The id of the product of the line item. SkuId: The id of the sku of the line item. AvailabilityId: The id of the availability of the line item. ProductName: The name of the product. SkuName: The name of the sku. PublisherName: The name of the publisher of the sku. PublisherId: The id of the publisher of the sku. AlternateId: The alternate id. MeterDescription: The description of the meter of the line item.
        The following properties only appear in some types of charges, see below: ReservationOrderId: For Azure Savings Plan this property corresponds to the savings plan order id on the Azure platform, example: "2D0D3389-D0D9-44D2-8BB4-441F5CD6D8CC". For Azure reservations this is the reservation order id, example: "8A05BC26-0542-4B6F-B97F-ECA5BAC54E9E".
        For Azure savings plan the properties are: ReservationOrderId. For Azure reservation the properties are: ReservationOrderId.

        Hide providerData attribute Show providerData attribute
      • subscriptionStartDate string(date-time) | null

        The start date of billing for the subscription. This value can change once a subscription renews. If it renews, then on the next invoice this property is updated too.

      • subscriptionEndDate string(date-time) | null

        The end date of the term of the subscription.

      • productType string | null

        The type of the offer associated with this charge. Possible values:

        • license.
        • softwaresubscription.
        • perpetualsoftware.
        • azureplan.
        • azurereservation.
        • azurelegacy.
        • azuresavingsplan.
    • continuationToken string | null

      The token to continue to retrieve the paginated items. Should not be set if the first page of items is desired.

    Hide response attributes Show response attributes object
    • items array[object] | null

      A model that represents a single charge of a one time invoice specific for Resellers. In the case of the Microsoft provider this charge can be an:

      • Azure Plan,
      • Azure Savings Plan,
      • Azure Reservation,
      • New Commerce License Subscription,
      • Software Subscription,
      • Perpetual Software Subscription,
      • Marketplace Subscription.
      Hide items attributes Show items attributes object
      • id string(uuid)

        The id that uniquely identifies a one time invoice line item.

      • The purchase order number of the subscription associated with this charge.

      • customerId string(uuid) | null

        The id of the customer associated to this charge. Can be null.

      • customerName string | null

        The company name of the customer.

      • customerInternalId string | null

        The internal id of the customer associated with this charge.

      • subscriptionId string(uuid) | null

        The id of the subscription associated to the charge. Can be null.

      • subscriptionName string | null

        The name of the subscription associated with the charge.

      • The internal id of the subscription associated with this charge.

      • offerProviderId string | null

        The offer id on the provider's side that identifies the subscription associated to the charge.

      • offerName string | null

        The name of the offer associated to the subscription.

      • The id of the subscription associated to this charge on the provider's side.

      • orderId string | null

        The id that identifies the order associated to the charge.

      • orderDate string(date-time) | null

        The date the order was placed.

      • customerCountry string | null

        The country in which the customer is located.

      • currency string | null

        The currency associated with the line item.

      • chargeType string | null

        The type of charge on this line item. Possible values for the Microsoft provider include:

        • new: When you buy a new subscription.
        • renew: When you renew your subscription.
        • cycleCharge: Regular recurring charges for your subscription.
        • addQuantity: Refunds and charges when you add seats.
        • removeQuantity: Refunds and charges when you remove seats.
        • moveQuantity: When you upgrade to an existing subscription.
        • cancelImmediate: When you cancel your subscription.
        • convert: When you change from a free trial to a paid subscription or upgrade to a new subscription.
        • changeBillingPlan: Changing from monthly to yearly billing or vice versa.
        • customerCredit: Credits for Azure, SLA, among others.
        • extendTerm: When you are given a longer trial period.
      • termAndBillingCycle string | null

        The term and billing cycle associated with this purchase.

      • chargeStartDate string(date-time)

        The billing start date for this charge.

      • chargeEndDate string(date-time)

        The billing end date for this charge.

      • unitType string | null

        The type of the unit.

      • unitPriceForReseller number(double) | null

        The unit price for reseller.

      • unitPriceForCustomer number(double) | null

        The unit price for customer.

      • quantity number(double)

        The quantity of the subscription associated to the charge.

      • subtotalForReseller number(double) | null

        The total before taxes for the reseller.

      • subtotalForCustomer number(double) | null

        The total before taxes for the customer.

      • taxForReseller number(double) | null

        The tax value for the reseller.

      • taxForCustomer number(double) | null

        The tax value for the customer.

      • totalForReseller number(double) | null

        The total for reseller after taxes.

      • totalForCustomer number(double) | null

        The total for customer after taxes.

      • customerProviderId string | null

        The id of customer on the provider's side associated to this charge.

      • pricingCurrency string | null

        The currency of the UnitPriceForReseller and UnitPriceForCustomer. This currency may differ from the invoice billing currency.

      • billingFrequency string | null

        The billing frequency of the subscription associated to the charge. Can also be empty.

      • billableQuantity number(double)

        The amount of units billed.

      • customerPriceMargin number(double) | null

        The customer price margin according to CustomerPriceMarginRule.

      • The customer price margin rule. The possible values are: markup, margin, grossmargin and erpminusdiscount.

      • subscriptionPriceMargin number(double) | null

        The subscription price margin according to SubscriptionPriceMarginRule.

      • The subscription price margin rule.

      • providerData object | null

        A dictionary that maps from strings to strings that contains specific provider invoice data.
        If this line item is associated to a Microsoft invoice then there are a set of properties that are common to each charge: CustomerDomainName: The domain of the customer. ProductId: The id of the product of the line item. SkuId: The id of the sku of the line item. AvailabilityId: The id of the availability of the line item. ProductName: The name of the product. SkuName: The name of the sku. PublisherName: The name of the publisher of the sku. PublisherId: The id of the publisher of the sku. AlternateId: The alternate id. MeterDescription: The description of the meter of the line item.
        The following properties only appear in some types of charges, see below: ReservationOrderId: For Azure Savings Plan this property corresponds to the savings plan order id on the Azure platform, example: "2D0D3389-D0D9-44D2-8BB4-441F5CD6D8CC". For Azure reservations this is the reservation order id, example: "8A05BC26-0542-4B6F-B97F-ECA5BAC54E9E".
        For Azure savings plan the properties are: ReservationOrderId. For Azure reservation the properties are: ReservationOrderId.

        Hide providerData attribute Show providerData attribute
      • subscriptionStartDate string(date-time) | null

        The start date of billing for the subscription. This value can change once a subscription renews. If it renews, then on the next invoice this property is updated too.

      • subscriptionEndDate string(date-time) | null

        The end date of the term of the subscription.

      • productType string | null

        The type of the offer associated with this charge. Possible values:

        • license.
        • softwaresubscription.
        • perpetualsoftware.
        • azureplan.
        • azurereservation.
        • azurelegacy.
        • azuresavingsplan.
    • continuationToken string | null

      The token to continue to retrieve the paginated items. Should not be set if the first page of items is desired.

    Hide response attributes Show response attributes object
    • items array[object] | null

      A model that represents a single charge of a one time invoice specific for Resellers. In the case of the Microsoft provider this charge can be an:

      • Azure Plan,
      • Azure Savings Plan,
      • Azure Reservation,
      • New Commerce License Subscription,
      • Software Subscription,
      • Perpetual Software Subscription,
      • Marketplace Subscription.
      Hide items attributes Show items attributes object
      • id string(uuid)

        The id that uniquely identifies a one time invoice line item.

      • The purchase order number of the subscription associated with this charge.

      • customerId string(uuid) | null

        The id of the customer associated to this charge. Can be null.

      • customerName string | null

        The company name of the customer.

      • customerInternalId string | null

        The internal id of the customer associated with this charge.

      • subscriptionId string(uuid) | null

        The id of the subscription associated to the charge. Can be null.

      • subscriptionName string | null

        The name of the subscription associated with the charge.

      • The internal id of the subscription associated with this charge.

      • offerProviderId string | null

        The offer id on the provider's side that identifies the subscription associated to the charge.

      • offerName string | null

        The name of the offer associated to the subscription.

      • The id of the subscription associated to this charge on the provider's side.

      • orderId string | null

        The id that identifies the order associated to the charge.

      • orderDate string(date-time) | null

        The date the order was placed.

      • customerCountry string | null

        The country in which the customer is located.

      • currency string | null

        The currency associated with the line item.

      • chargeType string | null

        The type of charge on this line item. Possible values for the Microsoft provider include:

        • new: When you buy a new subscription.
        • renew: When you renew your subscription.
        • cycleCharge: Regular recurring charges for your subscription.
        • addQuantity: Refunds and charges when you add seats.
        • removeQuantity: Refunds and charges when you remove seats.
        • moveQuantity: When you upgrade to an existing subscription.
        • cancelImmediate: When you cancel your subscription.
        • convert: When you change from a free trial to a paid subscription or upgrade to a new subscription.
        • changeBillingPlan: Changing from monthly to yearly billing or vice versa.
        • customerCredit: Credits for Azure, SLA, among others.
        • extendTerm: When you are given a longer trial period.
      • termAndBillingCycle string | null

        The term and billing cycle associated with this purchase.

      • chargeStartDate string(date-time)

        The billing start date for this charge.

      • chargeEndDate string(date-time)

        The billing end date for this charge.

      • unitType string | null

        The type of the unit.

      • unitPriceForReseller number(double) | null

        The unit price for reseller.

      • unitPriceForCustomer number(double) | null

        The unit price for customer.

      • quantity number(double)

        The quantity of the subscription associated to the charge.

      • subtotalForReseller number(double) | null

        The total before taxes for the reseller.

      • subtotalForCustomer number(double) | null

        The total before taxes for the customer.

      • taxForReseller number(double) | null

        The tax value for the reseller.

      • taxForCustomer number(double) | null

        The tax value for the customer.

      • totalForReseller number(double) | null

        The total for reseller after taxes.

      • totalForCustomer number(double) | null

        The total for customer after taxes.

      • customerProviderId string | null

        The id of customer on the provider's side associated to this charge.

      • pricingCurrency string | null

        The currency of the UnitPriceForReseller and UnitPriceForCustomer. This currency may differ from the invoice billing currency.

      • billingFrequency string | null

        The billing frequency of the subscription associated to the charge. Can also be empty.

      • billableQuantity number(double)

        The amount of units billed.

      • customerPriceMargin number(double) | null

        The customer price margin according to CustomerPriceMarginRule.

      • The customer price margin rule. The possible values are: markup, margin, grossmargin and erpminusdiscount.

      • subscriptionPriceMargin number(double) | null

        The subscription price margin according to SubscriptionPriceMarginRule.

      • The subscription price margin rule.

      • providerData object | null

        A dictionary that maps from strings to strings that contains specific provider invoice data.
        If this line item is associated to a Microsoft invoice then there are a set of properties that are common to each charge: CustomerDomainName: The domain of the customer. ProductId: The id of the product of the line item. SkuId: The id of the sku of the line item. AvailabilityId: The id of the availability of the line item. ProductName: The name of the product. SkuName: The name of the sku. PublisherName: The name of the publisher of the sku. PublisherId: The id of the publisher of the sku. AlternateId: The alternate id. MeterDescription: The description of the meter of the line item.
        The following properties only appear in some types of charges, see below: ReservationOrderId: For Azure Savings Plan this property corresponds to the savings plan order id on the Azure platform, example: "2D0D3389-D0D9-44D2-8BB4-441F5CD6D8CC". For Azure reservations this is the reservation order id, example: "8A05BC26-0542-4B6F-B97F-ECA5BAC54E9E".
        For Azure savings plan the properties are: ReservationOrderId. For Azure reservation the properties are: ReservationOrderId.

        Hide providerData attribute Show providerData attribute
      • subscriptionStartDate string(date-time) | null

        The start date of billing for the subscription. This value can change once a subscription renews. If it renews, then on the next invoice this property is updated too.

      • subscriptionEndDate string(date-time) | null

        The end date of the term of the subscription.

      • productType string | null

        The type of the offer associated with this charge. Possible values:

        • license.
        • softwaresubscription.
        • perpetualsoftware.
        • azureplan.
        • azurereservation.
        • azurelegacy.
        • azuresavingsplan.
    • continuationToken string | null

      The token to continue to retrieve the paginated items. Should not be set if the first page of items is desired.

  • There is an error in the parameters sent in the request.

    Hide response attributes Show response attributes object
    Hide response attributes Show response attributes object
    Hide response attributes Show response attributes object
  • 401

    Please use a valid authorization token.

  • 403

    You don't have enough permissions to access this information.

  • The requested onetime invoice does not exist. Any line items previously obtained should be discarded.

    Hide response attributes Show response attributes object
    Hide response attributes Show response attributes object
    Hide response attributes Show response attributes object
  • A server error has happened during the request. Please try again later or contact support.

    Hide response attributes Show response attributes object
    Hide response attributes Show response attributes object
    Hide response attributes Show response attributes object
GET /v1/Invoices/{id}/reseller-onetime-lineitems
curl \
 -X GET https://app-cloudcockpitapi-prod-01.azurewebsites.net/v1/Invoices/{id}/reseller-onetime-lineitems?pageSize=42 \
 -H "X-ContinuationToken: string" \
 -H "X-Tenant: string" \
 -H "Authorization: Bearer eyJ0eXAiO..." \
 -H "X-Correlation-Id: string"
Response examples (200)
{
  "items": [
    {
      "id": "7828D90D-2AC6-4F20-A95B-EE850BCD32A0",
      "subscriptionPONumber": "8543943821",
      "customerId": "2C741C83-E111-4A77-BC5F-C2F065275FA9",
      "customerName": "Customer name",
      "customerInternalId": "CustomerTest",
      "subscriptionId": "03DE5ECE-EC93-42A9-8F15-9A770AC1F832",
      "subscriptionName": "My friendly name",
      "subscriptionInternalId": "SubscriptionTest",
      "offerProviderId": "DZH318Z0BQJ7:01DJ",
      "offerName": "Azure Database for MySQL Single Server General Purpose - Compute Gen5, vCore, FR Central, 3 Years",
      "subscriptionProviderId": "FA2A91FD-7286-4DCD-9718-20048CCA832A",
      "orderId": "bhhVi9rL4_vCEmrrPdc",
      "orderDate": "2023-05-03T21:25:51.6916741",
      "customerCountry": "IE",
      "currency": "EUR",
      "chargeType": "cycleCharge",
      "termAndBillingCycle": "10K Read Operations",
      "chargeStartDate": "2023-04-01T00:00:00",
      "chargeEndDate": "2023-04-30T23:59:59",
      "unitType": "1 Hour",
      "unitPriceForReseller": 2.72,
      "unitPriceForCustomer": 2.72,
      "quantity": 4,
      "subtotalForReseller": 2.72,
      "subtotalForCustomer": 2.72,
      "taxForReseller": 0,
      "taxForCustomer": 0,
      "totalForReseller": 2.72,
      "totalForCustomer": 2.72,
      "customerProviderId": "CB0A371A-046A-46A9-A299-96BD755E67A8",
      "pricingCurrency": "USD",
      "billingFrequency": "Monthly",
      "billableQuantity": 1,
      "customerPriceMargin": 0,
      "customerPriceMarginRule": "erpminusdiscount",
      "subscriptionPriceMargin": 42.0,
      "subscriptionPriceMarginRule": "string",
      "providerData": {
        "ReservationOrderId": "A202A58B-7041-46EE-D5BC-2D0F6FD22106"
      },
      "subscriptionStartDate": "2023-04-01T00:00:00",
      "subscriptionEndDate": "2023-04-30T23:59:59",
      "productType": "license"
    }
  ],
  "continuationToken": "string"
}
Response examples (200)
{
  "items": [
    {
      "id": "7828D90D-2AC6-4F20-A95B-EE850BCD32A0",
      "subscriptionPONumber": "8543943821",
      "customerId": "2C741C83-E111-4A77-BC5F-C2F065275FA9",
      "customerName": "Customer name",
      "customerInternalId": "CustomerTest",
      "subscriptionId": "03DE5ECE-EC93-42A9-8F15-9A770AC1F832",
      "subscriptionName": "My friendly name",
      "subscriptionInternalId": "SubscriptionTest",
      "offerProviderId": "DZH318Z0BQJ7:01DJ",
      "offerName": "Azure Database for MySQL Single Server General Purpose - Compute Gen5, vCore, FR Central, 3 Years",
      "subscriptionProviderId": "FA2A91FD-7286-4DCD-9718-20048CCA832A",
      "orderId": "bhhVi9rL4_vCEmrrPdc",
      "orderDate": "2023-05-03T21:25:51.6916741",
      "customerCountry": "IE",
      "currency": "EUR",
      "chargeType": "cycleCharge",
      "termAndBillingCycle": "10K Read Operations",
      "chargeStartDate": "2023-04-01T00:00:00",
      "chargeEndDate": "2023-04-30T23:59:59",
      "unitType": "1 Hour",
      "unitPriceForReseller": 2.72,
      "unitPriceForCustomer": 2.72,
      "quantity": 4,
      "subtotalForReseller": 2.72,
      "subtotalForCustomer": 2.72,
      "taxForReseller": 0,
      "taxForCustomer": 0,
      "totalForReseller": 2.72,
      "totalForCustomer": 2.72,
      "customerProviderId": "CB0A371A-046A-46A9-A299-96BD755E67A8",
      "pricingCurrency": "USD",
      "billingFrequency": "Monthly",
      "billableQuantity": 1,
      "customerPriceMargin": 0,
      "customerPriceMarginRule": "erpminusdiscount",
      "subscriptionPriceMargin": 42.0,
      "subscriptionPriceMarginRule": "string",
      "providerData": {
        "ReservationOrderId": "A202A58B-7041-46EE-D5BC-2D0F6FD22106"
      },
      "subscriptionStartDate": "2023-04-01T00:00:00",
      "subscriptionEndDate": "2023-04-30T23:59:59",
      "productType": "license"
    }
  ],
  "continuationToken": "string"
}
Response examples (400)
{
  "statusCode": 400,
  "type": "ValidationException",
  "description": "Validation failed: \n -- PageSize: The page size must be between 1 and 2000 Severity: Error",
  "correlationId": "685043EA-6D49-4ACE-8BDB-CCE9D3E2DBD0"
}
Response examples (400)
{
  "statusCode": 400,
  "type": "ValidationException",
  "description": "Validation failed: \n -- PageSize: The page size must be between 1 and 2000 Severity: Error",
  "correlationId": "685043EA-6D49-4ACE-8BDB-CCE9D3E2DBD0"
}
Response examples (404)
{
  "statusCode": 404,
  "type": "EntityNotFoundException",
  "description": "No providers found for the tenant.",
  "correlationId": "685043EA-6D49-4ACE-8BDB-CCE9D3E2DBD0"
}
Response examples (404)
{
  "statusCode": 404,
  "type": "EntityNotFoundException",
  "description": "No providers found for the tenant.",
  "correlationId": "685043EA-6D49-4ACE-8BDB-CCE9D3E2DBD0"
}
Response examples (500)
{
  "statusCode": 500,
  "type": "NullReferenceException",
  "description": "An error happened processing your request. Please contact support.",
  "correlationId": "685043EA-6D49-4ACE-8BDB-CCE9D3E2DBD0"
}
Response examples (500)
{
  "statusCode": 500,
  "type": "NullReferenceException",
  "description": "An error happened processing your request. Please contact support.",
  "correlationId": "685043EA-6D49-4ACE-8BDB-CCE9D3E2DBD0"
}