Manage billing - Get a collection of invoices

Tjänst:

Partner Center Rest

API-version:

v1

Hämtar fakturorna för partnern.

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

Med valfria parametrar:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
filter.operator	query		string
invoiceType	query		string	Fakturatypen.
offset	query		integer int32	Sidförskjutning.
size	query		integer int32	Sidstorleken.

Begärandehuvud

Name	Obligatorisk	Typ	Description
Authorization	True	string	Token för auktoriseringsbärare
ms-correlationid		string	Används för att spåra begäranden internt. Om ett ms-correlationid inte anges genererar servern en ny för varje begäran
ms-cv		string	Används för att spåra begäranden internt. Om en ms-cv inte tillhandahålls genererar servern en ny för varje begäran
ms-requestid		string	Används för idempotens för begäranden. Om ett ms-requestid inte har angetts genererar servern en ny för varje begäran

Svar

Name	Typ	Description
200 OK	Collections.PagedResourceCollection[Invoice]	Begäran lyckades. Svarstexten innehåller samlingen med begärda fakturor. Media Types: "application/json", "text/json"
400 Bad Request		Det saknades eller ogiltiga indata. Svarstexten innehåller felinformationen. Media Types: "application/json", "text/json"
401 Unauthorized		Begäran autentiserades inte. Klienten måste autentisera med partner-API-tjänsten först. Media Types: "application/json", "text/json"
403 Forbidden		Begäran autentiserades men nekades eftersom anroparen inte har behörighet att anropa den. Media Types: "application/json", "text/json"
404 Not Found		Resursen hittades inte eller är inte tillgänglig med de angivna indataparametrarna. Media Types: "application/json", "text/json"
500 Internal Server Error		Partner-API-tjänsten eller något av dess beroenden kunde inte uppfylla begäran. Anropare kan försöka igen. Media Types: "application/json", "text/json"

Definitioner

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