Manage billing - Get a collection of invoices

Serviço:

Partner Center Rest

Versão da API:

v1

Obtém as faturas do parceiro.

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

Com parâmetros opcionais:

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
filter.operator	query		string
invoiceType	query		string	O tipo de fatura.
offset	query		integer int32	O deslocamento de página.
size	query		integer int32	O tamanho da página.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	True	string	Token de portador de autorização
ms-correlationid		string	Usado para acompanhar solicitações internamente. Se um ms-correlationid não for fornecido, o servidor gerará um novo para cada solicitação
ms-cv		string	Usado para acompanhar solicitações internamente. Se um ms-cv não for fornecido, o servidor gerará um novo para cada solicitação
ms-requestid		string	Usado para idempotency de solicitações. Se uma ms-requestid não for fornecida, o servidor gerará uma nova para cada solicitação

Respostas

Nome	Tipo	Description
200 OK	Collections.PagedResourceCollection[Invoice]	A solicitação foi bem-sucedida. O corpo da resposta contém a coleção de faturas solicitadas. Media Types: "application/json", "text/json"
400 Bad Request		Havia uma entrada ausente ou inválida. O corpo da resposta fornecerá os detalhes do erro. Media Types: "application/json", "text/json"
401 Unauthorized		A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro. Media Types: "application/json", "text/json"
403 Forbidden		A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la. Media Types: "application/json", "text/json"
404 Not Found		O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados. Media Types: "application/json", "text/json"
500 Internal Server Error		O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem repetir isso. Media Types: "application/json", "text/json"

Definições

Nome	Description
Collections.PagedResourceCollection[Invoice]
Invoice
InvoiceDetail
Link
ResourceAttributes
ResourceLinks
System.Collections.Generic.KeyValuePair[System.String,System.String]
TaxReceipt

Collections.PagedResourceCollection[Invoice]

Nome	Tipo	Description
attributes	ResourceAttributes
continuationToken	string
items	Invoice[]
links	ResourceLinks
totalCount	integer

Invoice

Nome	Tipo	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

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

Link

Nome	Tipo	Description
headers	System.Collections.Generic.KeyValuePair[System.String,System.String][]
method	string
uri	string

ResourceAttributes

Nome	Tipo	Description
etag	string
objectType	string

ResourceLinks

Nome	Tipo	Description
next	Link
previous	Link
self	Link

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

Nome	Tipo	Description
key	string
value	string

TaxReceipt

Nome	Tipo	Description
createdDate	string
id	string
receiptType	string
taxReceiptPdfDownloadLink	string