Manage billing - Get a collection of invoices

Служба:

Partner Center Rest

Версия API:

v1

Возвращает счета для партнера.

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

Link

Имя	Тип	Описание
headers	System.Collections.Generic.KeyValuePair[System.String,System.String][]
method	string
uri	string

ResourceAttributes

Имя	Тип	Описание
etag	string
objectType	string

ResourceLinks

Имя	Тип	Описание
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