Partager via


Manage billing - Get a collection of invoices

Obtient les factures du partenaire.

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}

Paramètres URI

Nom Dans Obligatoire Type Description
filter.operator
query

string

invoiceType
query

string

Type de facture.

offset
query

integer

int32

Décalage de page.

size
query

integer

int32

Taille de la page.

En-tête de la demande

Nom Obligatoire Type Description
Authorization True

string

Jeton du porteur d’autorisation

ms-correlationid

string

Utilisé pour le suivi des demandes en interne. Si un ms-correlationid n’est pas fourni, le serveur en génère un nouveau pour chaque requête

ms-cv

string

Utilisé pour le suivi des demandes en interne. Si un ms-cv n’est pas fourni, le serveur en génère un nouveau pour chaque requête

ms-requestid

string

Utilisé pour l’idempotency des requêtes. Si un ms-requestid n’est pas fourni, le serveur en génère un nouveau pour chaque requête

Réponses

Nom Type Description
200 OK

Collections.PagedResourceCollection[Invoice]

La requête a réussi. Le corps de la réponse contient la collecte des factures demandées.

Media Types: "application/json", "text/json"

400 Bad Request

Une entrée est manquante ou non valide. Le corps de la réponse fournit les détails de l’erreur.

Media Types: "application/json", "text/json"

401 Unauthorized

La demande n’a pas été authentifiée. Le client doit d’abord s’authentifier auprès du service d’API partenaire.

Media Types: "application/json", "text/json"

403 Forbidden

La demande a été authentifiée, mais a été refusée, car l’appelant n’a pas les droits de l’appeler.

Media Types: "application/json", "text/json"

404 Not Found

La ressource est introuvable ou non disponible avec les paramètres d’entrée donnés.

Media Types: "application/json", "text/json"

500 Internal Server Error

Le service d’API partenaire ou l’une de ses dépendances n’a pas pu répondre à la demande. Les appelants peuvent réessayer.

Media Types: "application/json", "text/json"

Définitions

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

Collections.PagedResourceCollection[Invoice]

Nom Type Description
attributes

ResourceAttributes

continuationToken

string

items

Invoice[]

links

ResourceLinks

totalCount

integer

Invoice

Nom Type 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

Nom Type Description
attributes

ResourceAttributes

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

ResourceLinks

Nom Type Description
headers

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

method

string

uri

string

ResourceAttributes

Nom Type Description
etag

string

objectType

string

Nom Type Description
next

Link

previous

Link

self

Link

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

Nom Type Description
key

string

value

string

TaxReceipt

Nom Type Description
createdDate

string

id

string

receiptType

string

taxReceiptPdfDownloadLink

string