Manage billing - Get a collection of invoices
取得夥伴的發票。
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}
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
filter.
|
query |
string |
||
invoice
|
query |
string |
發票類型。 |
|
offset
|
query |
integer int32 |
頁面位移。 |
|
size
|
query |
integer int32 |
頁面大小。 |
要求標頭
名稱 | 必要 | 類型 | Description |
---|---|---|---|
Authorization | True |
string |
授權持有人令牌 |
ms-correlationid |
string |
用於在內部追蹤要求。 如果未提供 ms-correlationid,伺服器會為每個要求產生新的要求 |
|
ms-cv |
string |
用於在內部追蹤要求。 如果未提供 ms-cv,伺服器將會為每個要求產生新的要求 |
|
ms-requestid |
string |
用於要求等冪性。 如果未提供 ms-requestid,伺服器將會為每個要求產生新的要求 |
回應
名稱 | 類型 | Description |
---|---|---|
200 OK |
要求成功。 回應本文包含要求的發票集合。 Media Types: "application/json", "text/json" |
|
400 Bad Request |
輸入遺失或無效。 回應本文會提供錯誤詳細數據。 Media Types: "application/json", "text/json" |
|
401 Unauthorized |
要求未通過驗證。 客戶端必須先向合作夥伴 API 服務進行驗證。 Media Types: "application/json", "text/json" |
|
403 Forbidden |
要求已通過驗證,但因為呼叫端沒有叫用要求的許可權而遭到拒絕。 Media Types: "application/json", "text/json" |
|
404 Not Found |
找不到資源,或無法使用指定的輸入參數。 Media Types: "application/json", "text/json" |
|
500 Internal Server Error |
合作夥伴 API 服務或其其中一個相依性無法滿足要求。 來電者可能會重試此狀況。 Media Types: "application/json", "text/json" |
定義
名稱 | Description |
---|---|
Collections. |
|
Invoice | |
Invoice |
|
Link | |
Resource |
|
Resource |
|
System. |
|
Tax |
Collections.PagedResourceCollection[Invoice]
名稱 | 類型 | Description |
---|---|---|
attributes | ||
continuationToken |
string |
|
items |
Invoice[] |
|
links | ||
totalCount |
integer |
Invoice
名稱 | 類型 | 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
名稱 | 類型 | Description |
---|---|---|
attributes | ||
billingProvider |
enum:
|
|
invoiceLineItemType |
enum:
|
|
links |
Link
名稱 | 類型 | Description |
---|---|---|
headers |
System. |
|
method |
string |
|
uri |
string |
ResourceAttributes
名稱 | 類型 | Description |
---|---|---|
etag |
string |
|
objectType |
string |
ResourceLinks
名稱 | 類型 | Description |
---|---|---|
next | ||
previous | ||
self |
System.Collections.Generic.KeyValuePair[System.String,System.String]
名稱 | 類型 | Description |
---|---|---|
key |
string |
|
value |
string |
TaxReceipt
名稱 | 類型 | Description |
---|---|---|
createdDate |
string |
|
id |
string |
|
receiptType |
string |
|
taxReceiptPdfDownloadLink |
string |