Manage billing - Get invoice by ID
Obtém a fatura por identificador para o parceiro.
GET https://api.partnercenter.microsoft.com/v1/invoices/{invoice_id}
Parâmetros do URI
Name | Em | Necessário | Tipo | Description |
---|---|---|---|---|
invoice_id
|
path | True |
string |
O ID da fatura. |
Cabeçalho do Pedido
Name | Necessário | Tipo | Description |
---|---|---|---|
Authorization | True |
string |
Token de portador de autorização |
ms-correlationid |
string |
Usado para rastrear 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 rastrear 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 idempotência de solicitações. Se um ms-requestid não for fornecido, o servidor gerará um novo para cada solicitação |
Respostas
Name | Tipo | Description |
---|---|---|
200 OK |
O pedido foi bem-sucedido. O corpo da resposta contém a fatura solicitada. Media Types: "application/json", "text/json", "application/xml", "text/xml" |
|
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", "application/xml", "text/xml" |
|
401 Unauthorized |
O pedido não foi autenticado. O cliente precisa se autenticar com o serviço de API do parceiro primeiro. Media Types: "application/json", "text/json", "application/xml", "text/xml" |
|
403 Forbidden |
O pedido foi autenticado, mas foi recusado, uma vez que o autor da chamada não tem o direito de o invocar. Media Types: "application/json", "text/json", "application/xml", "text/xml" |
|
404 Not Found |
O recurso não é encontrado ou não está disponível com os parâmetros de entrada fornecidos. Media Types: "application/json", "text/json", "application/xml", "text/xml" |
|
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 tentar novamente. Media Types: "application/json", "text/json", "application/xml", "text/xml" |
Definições
Name | Description |
---|---|
Invoice | |
Invoice |
|
Link | |
Resource |
|
Resource |
|
System. |
|
Tax |
Invoice
Name | Tipo | Description |
---|---|---|
amendments |
Invoice[] |
|
amendsOf |
string |
|
attributes | ||
billingPeriodEndDate |
string |
|
billingPeriodStartDate |
string |
|
currencyCode |
string |
|
currencySymbol |
string |
|
documentType |
enum:
|
|
id |
string |
|
invoiceDate |
string |
|
invoiceDetails | ||
invoiceType |
string |
|
links | ||
paidAmount |
number |
|
pdfDownloadLink |
string |
|
programName |
string |
|
state |
string |
|
taxReceipts | ||
totalCharges |
number |
InvoiceDetail
Name | Tipo | Description |
---|---|---|
attributes | ||
billingProvider |
enum:
|
|
invoiceLineItemType |
enum:
|
|
links |
Link
Name | Tipo | Description |
---|---|---|
headers |
System. |
|
method |
string |
|
uri |
string |
ResourceAttributes
Name | Tipo | Description |
---|---|---|
etag |
string |
|
objectType |
string |
ResourceLinks
Name | Tipo | Description |
---|---|---|
next | ||
previous | ||
self |
System.Collections.Generic.KeyValuePair[System.String,System.String]
Name | Tipo | Description |
---|---|---|
key |
string |
|
value |
string |
TaxReceipt
Name | Tipo | Description |
---|---|---|
createdDate |
string |
|
id |
string |
|
receiptType |
string |
|
taxReceiptPdfDownloadLink |
string |