Partner payouts - Create a new transaction history export request

  • Referência
Service:
Partner Center Rest
API Version:
1.0

Essa API permite criar uma nova solicitação de exportação de histórico de transações. Recomendamos usar $filter parâmetro para cada solicitação. Veja abaixo sobre o uso dos filtros e todos os filtros disponíveis na interface de página de exportação (UX) também estão disponíveis por meio dessa API, fornecendo flexibilidade e consistência na filtragem de dados.

POST https://api.partnercenter.microsoft.com/v{version}/payouts/transactionhistory
With optional parameters: 
POST https://api.partnercenter.microsoft.com/v{version}/payouts/transactionhistory?$filter={$filter}&enrollmentParticipantId={enrollmentParticipantId}&earningForDate={earningForDate}&transactionAmount={transactionAmount}&earningAmount={earningAmount}&engagementName={engagementName}&Multiple filters={Multiple filters}

Parâmetros de URI

Nome Em Obrigatório Tipo Description
version
 path True

string

$filter
 query

string

O $filter parâmetro de consulta é um parâmetro opcional para criar uma operação de exportação. No entanto, é altamente recomendável usar $filter para melhor desempenho e disponibilidade mais rápida do relatório de exportação. Abaixo estão alguns dos principais filtros de atributo que podem ser usados como parte da operação de exportação
earningAmount
 query

double

Filtro de valor de ganho para uma solicitação de exportação. Uso: {baseUrl}/payments/transactionhistory?$filter=earningAmount ge 2000 e earningAmount le 5000
earningForDate
 query

string

Filtro de data de período de ganho para uma solicitação de exportação. Uso: {baseUrl}/payments/transactionhistory?$filter=earningForDate ge 2023-03-01 e earningForDate le 2023-04-12
engagementName
 query

string

Filtro de nome de participação para uma solicitação de exportação. Uso: {baseUrl}/payments/transactionhistory?$filter=engagementName='Incentivos de movimento do CSP do Azure'
enrollmentParticipantId
 query

int

Filtro de ID do MPN registrado para uma solicitação de exportação. Uso: {baseUrl}/payments/transactionhistory?$filter=enrollmentParticipantId=12345
Multiple filters
 query

string

Aqui está uma consulta de exemplo para criar uma solicitação de exportação com vários filtros. Uso: {baseUrl}/payments/transactionhistory?$filter=earningForDate ge 2023-01-01 e earningForDate le 2023-05-31 e (enrollmentParticipantId eq 'XXXXXXX') e (programName eq 'Microsoft Commerce Incentives') e (payableSubType eq 'REBATE') e (paymentId eq 'xxxxxxx') e (engagementName eq 'Azure Enterprise and Self-Service Incentive' ou engagementName eq 'Azure CSP motion incentives - Indirect Provider')"
transactionAmount
 query

double

Filtro de valor da transação para uma solicitação de exportação. Uso: {baseUrl}/payments/transactionhistory?$filter=transactionAmount ge 2000 e transactionAmount le 5000

Cabeçalho da solicitação

Nome Obrigatório Tipo Description
Authorization True

string

Token de portador de autorização
Client-Request-ID

string

ID da solicitação fornecida pelo usuário

Respostas

Nome Tipo Description
202 Accepted

Microsoft.Partner.Service.PartnerPayout.Contracts.V1.Export

A solicitação foi aceita com êxito para processamento.

Headers

Request-ID: string
400 Bad Request

Havia uma entrada ausente ou inválida. O corpo da resposta fornecerá os detalhes do erro.
401 Unauthorized

A solicitação não foi autenticada. O cliente precisa se autenticar com o serviço de API do parceiro primeiro.
403 Forbidden

A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la.
404 Not Found

O recurso não foi encontrado.
429 Too Many Requests

Solicitações demais.
500 Internal Server Error

O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem repetir isso.

Definições

Microsoft.Partner.Service.PartnerPayout.Contracts.V1.Export

Nome Tipo Description
blobLocation

string

processingStartDateTime

string

requestDateTime

string

requestId

string

requestPath

string

requestQueryString

string

status enum:
  • Completed
  • Failed
  • Processing
  • Queued