Manage billing - Get a collection of invoices

Služba:

Partner Center Rest

Verze rozhraní API:

v1

Získá faktury pro partnera.

GET https://api.partnercenter.microsoft.com/v1/invoices

S volitelnými parametry:

GET https://api.partnercenter.microsoft.com/v1/invoices?size={size}&offset={offset}&invoiceType={invoiceType}&filter.operator={filter.operator}

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
filter.operator	query		string
invoiceType	query		string	Typ faktury.
offset	query		integer int32	Posun stránky
size	query		integer int32	Velikost stránky.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
Authorization	True	string	Autorizační nosný token
ms-correlationid		string	Používá se pro interní sledování požadavků. Pokud není zadaný parametr ms-correlationid, server pro každý požadavek vygeneruje nový.
ms-cv		string	Používá se pro interní sledování požadavků. Pokud není zadaný ms-cv, server pro každý požadavek vygeneruje nový.
ms-requestid		string	Používá se k idempotenci požadavků. Pokud není zadaný identifikátor ms-requestid, server pro každý požadavek vygeneruje nový.

Odpovědi

Name	Typ	Description
200 OK	Collections.PagedResourceCollection[Invoice]	Požadavek byl úspěšný. Text odpovědi obsahuje kolekci požadovaných faktur. Media Types: "application/json", "text/json"
400 Bad Request		Došlo k chybě nebo neplatnému vstupu. Text odpovědi poskytne podrobnosti o chybě. Media Types: "application/json", "text/json"
401 Unauthorized		Požadavek nebyl ověřen. Klient se musí nejprve ověřit ve službě partnerského rozhraní API. Media Types: "application/json", "text/json"
403 Forbidden		Žádost byla ověřena, ale byla odmítnuta, protože volající nemá práva k jeho vyvolání. Media Types: "application/json", "text/json"
404 Not Found		Prostředek nebyl nalezen nebo není k dispozici s danými vstupními parametry. Media Types: "application/json", "text/json"
500 Internal Server Error		Službě partnerského rozhraní API nebo některé z jejích závislostí se nepodařilo splnit požadavek. Volající to možná zkusí znovu. Media Types: "application/json", "text/json"

Definice

Name	Description
Collections.PagedResourceCollection[Invoice]
Invoice
InvoiceDetail
Link
ResourceAttributes
ResourceLinks
System.Collections.Generic.KeyValuePair[System.String,System.String]
TaxReceipt

Collections.PagedResourceCollection[Invoice]

Name	Typ	Description
attributes	ResourceAttributes
continuationToken	string
items	Invoice[]
links	ResourceLinks
totalCount	integer

Invoice

Name	Typ	Description
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

Name	Typ	Description
attributes	ResourceAttributes
billingProvider	enum: all azure marketplace none office oneTime
invoiceLineItemType	enum: billingLineItems none usageLineItems
links	ResourceLinks

Link

Name	Typ	Description
headers	System.Collections.Generic.KeyValuePair[System.String,System.String][]
method	string
uri	string

ResourceAttributes

Name	Typ	Description
etag	string
objectType	string

ResourceLinks

Name	Typ	Description
next	Link
previous	Link
self	Link

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

Name	Typ	Description
key	string
value	string

TaxReceipt

Name	Typ	Description
createdDate	string
id	string
receiptType	string
taxReceiptPdfDownloadLink	string