Partner payouts - Creates a new payments export request

Referência

Serviço:: Partner Center Rest

Versão da API:: 1.0

Essa API permite criar uma nova solicitação de exportação de pagamentos. É recomendável 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/payments

Com parâmetros opcionais:

POST https://api.partnercenter.microsoft.com/v{version}/payouts/payments?$filter={$filter}&enrollmentParticipantId={enrollmentParticipantId}&paymentId={paymentId}&payoutStatusUpdateTS={payoutStatusUpdateTS}&paymentAmount={paymentAmount}&payoutOrderType={payoutOrderType}&Multiple filters={Multiple filters}

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
version	path	True	string
$filter	query		string	O parâmetro de consulta $filter é um parâmetro opcional para a criação de 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
enrollmentParticipantId	query		int	Filtro de ID do MPN registrado para uma solicitação de exportação. Uso: {baseUrl}/payments/payments?$filter=enrollmentParticipantId=12345
Multiple filters	query		string	Aqui está uma consulta de exemplo com vários filtros para uma solicitação de exportação. Uso: {baseUrl}/payments/payments?$filter=paymentStatusUpdateTS ge 2023-01-01 e paymentStatusUpdateTS le 2023-05-31 e (enrollmentParticipantId eq 'XXXXXXX') e (programName eq 'CSP Direct Bill Partner') e (paymentOrderType eq 'REBATE') e (paymentId eq 'xxxxxxx')
paymentAmount	query		double	Valor de pagamento para filtrar os pagamentos de uma solicitação de exportação. Uso: {baseUrl}/payments/payments?$filter=paymentAmount ge 2000 e paymentAmount le 5000
paymentId	query		int	Filtro PaymentId para uma solicitação de exportação. Uso: {baseUrl}/payments/payments?$filter=paymentId=123456
payoutOrderType	query		string	Tipo de pedido de pagamento (Desconto, coop, Taxa, Venda) para filtrar os pagamentos de uma solicitação de exportação. Uso: {baseUrl}/payments/payments?$filter=?$filter=paymentOrderType='REBATE'
payoutStatusUpdateTS	query		string	Data do status do pagamento para filtrar os pagamentos de uma solicitação de exportação. Uso: {baseUrl}/payments/transactionhistory?$filter=paymentStatusUpdateTS ge 2023-03-01 e paymentStatusUpdateTS le 2023-04-12

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. Cabeçalhos 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. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro.
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		Muitas solicitações.
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

Compartilhar via