Manage billing - Get a collection of invoices

Service:

Partner Center Rest

API Version:

v1

Gets the invoices for the partner.

GET https://api.partnercenter.microsoft.com/v1/invoices

With optional parameters:

GET https://api.partnercenter.microsoft.com/v1/invoices?size={size}&offset={offset}&invoiceType={invoiceType}&filter.operator={filter.operator}

URI Parameters

Name	In	Required	Type	Description
filter.operator	query		string
invoiceType	query		string	The invoice type.
offset	query		integer int32	The page offset.
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[Invoice]	The request succeeded. The response body contains the collection of requested invoices. 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[Invoice]
Invoice
InvoiceDetail
Link
ResourceAttributes
ResourceLinks
System.Collections.Generic.KeyValuePair[System.String,System.String]
TaxReceipt

Collections.PagedResourceCollection[Invoice]

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

Invoice

Name	Type	Description
amendments	Invoice[]
amendsOf	string
attributes	ResourceAttributes
billingPeriodEndDate	string
billingPeriodStartDate	string
currencyCode	string
currencySymbol	string
documentType	enum: adjustmentNote invoice none reconciliation voidNote
id	string
invoiceDate	string
invoiceDetails	InvoiceDetail[]
invoiceType	string
links	ResourceLinks
paidAmount	number
pdfDownloadLink	string
programName	string
state	string
taxReceipts	TaxReceipt[]
totalCharges	number

InvoiceDetail

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

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

TaxReceipt

Name	Type	Description
createdDate	string
id	string
receiptType	string
taxReceiptPdfDownloadLink	string