Manage billing - Get invoice line items

Service:

Partner Center Rest

API Version:

v1

Gets line items for GTM scenarios. First and Third party unbilled daily rated usage for current and previous months. First and Third party billed daily rated usage for an invoceid. First and Third party unbilled recon for current and previous months.

GET https://api.partnercenter.microsoft.com/v1/invoices/{invoice_id}/lineitems

With optional parameters:

GET https://api.partnercenter.microsoft.com/v1/invoices/{invoice_id}/lineitems?provider={provider}&invoiceLineItemType={invoiceLineItemType}&hasPartnerEarnedCredit={hasPartnerEarnedCredit}&currencyCode={currencyCode}&period={period}&size={size}&offset={offset}&seekOperation={seekOperation}

URI Parameters

Name	In	Required	Type	Description
invoice_id	path	True	string	The invoice id. For unbilled line items invoiceId is set to "unbilled".
currencyCode	query		string	The currency code.
hasPartnerEarnedCredit	query		boolean	The value indicating if to return the line items with partner earned credit applied.
invoiceLineItemType	query		string	The invoice line item. example: BillingLineItems, UsageLineItems.
offset	query		integer int32	The page offset.
period	query		string	The period for unbilled recon. example: current, previous.
provider	query		string	The provider type. example: All, Marketplace.
seekOperation	query		string	The seek operation to perform. Only Next is supported.
size	query		integer int32	The page size.

Request Header

Name	Required	Type	Description
Authorization	True	string	Authorization Bearer token
ms-correlationid		string	Used for tracking requests internally. If a ms-correlationid is not provided, the server will generate a new one for each request
ms-cv		string	Used for tracking requests internally. If a ms-cv is not provided, the server will generate a new one for each request
ms-requestid		string	Used for idempotency of requests. If a ms-requestid is not provided, the server will generate a new one for each request

Responses

Name	Type	Description
200 OK	Collections.PagedResourceCollection[InvoiceLineItem]	The request was successful. The response body contains the requested recon line items. Media Types: "application/json", "text/json"
400 Bad Request		There was a missing or an invalid input. The response body will provide the error details. Media Types: "application/json", "text/json"
401 Unauthorized		The request was not authenticated. The client needs to authenticate with the partner API service first. Media Types: "application/json", "text/json"
403 Forbidden		The request was authenticated but was refused since the caller does not have the rights to invoke it. Media Types: "application/json", "text/json"
404 Not Found		The resource is not found or not available with the given input parameters. Media Types: "application/json", "text/json"
500 Internal Server Error		The partner API service or one of its dependencies failed to fulfill the request. Callers may retry this. Media Types: "application/json", "text/json"

Definitions

Name	Description
Collections.PagedResourceCollection[InvoiceLineItem]
InvoiceLineItem
Link
ResourceAttributes
ResourceLinks
System.Collections.Generic.KeyValuePair[System.String,System.String]

Collections.PagedResourceCollection[InvoiceLineItem]

Name	Type	Description
attributes	ResourceAttributes
continuationToken	string
items	InvoiceLineItem[]
links	ResourceLinks
totalCount	integer

InvoiceLineItem

Name	Type	Description
attributes	ResourceAttributes
billingProvider	enum: all azure marketplace none office oneTime
invoiceLineItemType	enum: billingLineItems none usageLineItems

Link

Name	Type	Description
headers	System.Collections.Generic.KeyValuePair[System.String,System.String][]
method	string
uri	string

ResourceAttributes

Name	Type	Description
etag	string
objectType	string

ResourceLinks

Name	Type	Description
next	Link
previous	Link
self	Link

System.Collections.Generic.KeyValuePair[System.String,System.String]

Name	Type	Description
key	string
value	string