Manage billing - Get a collection of invoices
Pobiera faktury dla partnera.
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}
Parametry identyfikatora URI
Nazwa | W | Wymagane | Typ | Opis |
---|---|---|---|---|
filter.
|
query |
string |
||
invoice
|
query |
string |
Typ faktury. |
|
offset
|
query |
integer int32 |
Przesunięcie strony. |
|
size
|
query |
integer int32 |
Rozmiar strony. |
Nagłówek żądania
Nazwa | Wymagane | Typ | Opis |
---|---|---|---|
Authorization | True |
string |
Token elementu nośnego autoryzacji |
ms-correlationid |
string |
Służy do śledzenia żądań wewnętrznie. Jeśli nie podano identyfikatora ms-correlationid, serwer wygeneruje nowy dla każdego żądania |
|
ms-cv |
string |
Służy do śledzenia żądań wewnętrznie. Jeśli nie podano ms-cv, serwer wygeneruje nowy dla każdego żądania |
|
ms-requestid |
string |
Służy do idempotentności żądań. Jeśli nie podano identyfikatora ms-requestid, serwer wygeneruje nowy dla każdego żądania |
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
200 OK |
Żądanie zakończyło się pomyślnie. Treść odpowiedzi zawiera kolekcję żądanych faktur. Media Types: "application/json", "text/json" |
|
400 Bad Request |
Brak danych wejściowych lub nieprawidłowy. Treść odpowiedzi udostępni szczegóły błędu. Media Types: "application/json", "text/json" |
|
401 Unauthorized |
Żądanie nie zostało uwierzytelnione. Klient musi najpierw uwierzytelnić się za pomocą usługi interfejsu API partnera. Media Types: "application/json", "text/json" |
|
403 Forbidden |
Żądanie zostało uwierzytelnione, ale zostało odrzucone, ponieważ obiekt wywołujący nie ma praw do jego wywołania. Media Types: "application/json", "text/json" |
|
404 Not Found |
Zasób nie został znaleziony lub niedostępny z podanymi parametrami wejściowymi. Media Types: "application/json", "text/json" |
|
500 Internal Server Error |
Usługa interfejsu API partnera lub jedna z jego zależności nie spełniła żądania. Osoby wywołujące mogą ponowić próbę. Media Types: "application/json", "text/json" |
Definicje
Nazwa | Opis |
---|---|
Collections. |
|
Invoice | |
Invoice |
|
Link | |
Resource |
|
Resource |
|
System. |
|
Tax |
Collections.PagedResourceCollection[Invoice]
Nazwa | Typ | Opis |
---|---|---|
attributes | ||
continuationToken |
string |
|
items |
Invoice[] |
|
links | ||
totalCount |
integer |
Invoice
Nazwa | Typ | Opis |
---|---|---|
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
Nazwa | Typ | Opis |
---|---|---|
attributes | ||
billingProvider |
enum:
|
|
invoiceLineItemType |
enum:
|
|
links |
Link
Nazwa | Typ | Opis |
---|---|---|
headers |
System. |
|
method |
string |
|
uri |
string |
ResourceAttributes
Nazwa | Typ | Opis |
---|---|---|
etag |
string |
|
objectType |
string |
ResourceLinks
Nazwa | Typ | Opis |
---|---|---|
next | ||
previous | ||
self |
System.Collections.Generic.KeyValuePair[System.String,System.String]
Nazwa | Typ | Opis |
---|---|---|
key |
string |
|
value |
string |
TaxReceipt
Nazwa | Typ | Opis |
---|---|---|
createdDate |
string |
|
id |
string |
|
receiptType |
string |
|
taxReceiptPdfDownloadLink |
string |