Manage billing - Get a collection of invoices
Obtiene las facturas del asociado.
GET https://api.partnercenter.microsoft.com/v1/invoices
GET https://api.partnercenter.microsoft.com/v1/invoices?size={size}&offset={offset}&invoiceType={invoiceType}&filter.operator={filter.operator}
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
filter.
|
query |
string |
||
invoice
|
query |
string |
Tipo de factura. |
|
offset
|
query |
integer int32 |
Desplazamiento de página. |
|
size
|
query |
integer int32 |
Tamaño de página. |
Encabezado de la solicitud
Nombre | Requerido | Tipo | Description |
---|---|---|---|
Authorization | True |
string |
Token de portador de autorización |
ms-correlationid |
string |
Se usa para realizar el seguimiento de las solicitudes internamente. Si no se proporciona un ms-correlationid, el servidor generará uno nuevo para cada solicitud. |
|
ms-cv |
string |
Se usa para realizar el seguimiento de las solicitudes internamente. Si no se proporciona un ms-cv, el servidor generará uno nuevo para cada solicitud. |
|
ms-requestid |
string |
Se usa para la idempoencia de las solicitudes. Si no se proporciona un ms-requestid, el servidor generará uno nuevo para cada solicitud. |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
La solicitud se realizó correctamente. El cuerpo de la respuesta contiene la colección de facturas solicitadas. Media Types: "application/json", "text/json" |
|
400 Bad Request |
Faltaba o faltaba una entrada no válida. El cuerpo de la respuesta proporcionará los detalles del error. Media Types: "application/json", "text/json" |
|
401 Unauthorized |
La solicitud no se autenticó. El cliente debe autenticarse primero con el servicio de API del asociado. Media Types: "application/json", "text/json" |
|
403 Forbidden |
La solicitud se autenticó pero se rechazó, ya que el autor de la llamada no tiene los derechos para invocarla. Media Types: "application/json", "text/json" |
|
404 Not Found |
El recurso no se encuentra o no está disponible con los parámetros de entrada especificados. Media Types: "application/json", "text/json" |
|
500 Internal Server Error |
El servicio de API del asociado o una de sus dependencias no pudieron cumplir la solicitud. Los autores de llamadas pueden volver a intentarlo. Media Types: "application/json", "text/json" |
Definiciones
Collections.PagedResourceCollection[Invoice]
Nombre | Tipo | Description |
---|---|---|
attributes | ||
continuationToken |
string |
|
items |
Invoice[] |
|
links | ||
totalCount |
integer |
Invoice
Nombre | 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
Nombre | Tipo | Description |
---|---|---|
attributes | ||
billingProvider |
enum:
|
|
invoiceLineItemType |
enum:
|
|
links |
Link
Nombre | Tipo | Description |
---|---|---|
headers |
System. |
|
method |
string |
|
uri |
string |
ResourceAttributes
Nombre | Tipo | Description |
---|---|---|
etag |
string |
|
objectType |
string |
ResourceLinks
Nombre | Tipo | Description |
---|---|---|
next | ||
previous | ||
self |
System.Collections.Generic.KeyValuePair[System.String,System.String]
Nombre | Tipo | Description |
---|---|---|
key |
string |
|
value |
string |
TaxReceipt
Nombre | Tipo | Description |
---|---|---|
createdDate |
string |
|
id |
string |
|
receiptType |
string |
|
taxReceiptPdfDownloadLink |
string |