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 参数

名称 必需 类型 说明
filter.operator
query

string

invoiceType
query

string

发票类型。

offset
query

integer

int32

页面偏移量。

size
query

integer

int32

页面大小。

请求头

名称 必需 类型 说明
Authorization True

string

授权持有者令牌

ms-correlationid

string

用于在内部跟踪请求。 如果未提供 ms-correlationid,则服务器将为每个请求生成一个新请求

ms-cv

string

用于在内部跟踪请求。 如果未提供 ms-cv,服务器将为每个请求生成一个新请求

ms-requestid

string

用于请求的幂等性。 如果未提供 ms-requestid,服务器将为每个请求生成一个新请求

响应

名称 类型 说明
200 OK

Collections.PagedResourceCollection[Invoice]

请求成功。 响应正文包含所请求发票的集合。

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"

定义

名称 说明
Collections.PagedResourceCollection[Invoice]
Invoice
InvoiceDetail
Link
ResourceAttributes
ResourceLinks
System.Collections.Generic.KeyValuePair[System.String,System.String]
TaxReceipt

Collections.PagedResourceCollection[Invoice]

名称 类型 说明
attributes

ResourceAttributes

continuationToken

string

items

Invoice[]

links

ResourceLinks

totalCount

integer

Invoice

名称 类型 说明
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

名称 类型 说明
attributes

ResourceAttributes

billingProvider enum:
  • all
  • azure
  • marketplace
  • none
  • office
  • oneTime
invoiceLineItemType enum:
  • billingLineItems
  • none
  • usageLineItems
links

ResourceLinks

名称 类型 说明
headers

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

method

string

uri

string

ResourceAttributes

名称 类型 说明
etag

string

objectType

string

名称 类型 说明
next

Link

previous

Link

self

Link

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

名称 类型 说明
key

string

value

string

TaxReceipt

名称 类型 说明
createdDate

string

id

string

receiptType

string

taxReceiptPdfDownloadLink

string