Partner payouts - Creates a new payments export request

Service:

Partner Center Rest

API Version:

1.0

Questa API consente di creare una nuova richiesta di esportazione dei pagamenti. È consigliabile usare $filter param per ogni richiesta. Vedere di seguito l'uso dei filtri e tutti i filtri disponibili nell'interfaccia della pagina di esportazione (UX) sono disponibili anche tramite questa API, offrendo flessibilità e coerenza nei filtri dei dati.

POST https://api.partnercenter.microsoft.com/v{version}/payouts/payments

With optional parameters:

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}

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
version	path	True	string
$filter	query		string	Il parametro di query $filter è un parametro facoltativo per la creazione di un'operazione di esportazione. È tuttavia consigliabile usare $filter per ottenere prestazioni migliori e una maggiore disponibilità del report di esportazione. Di seguito sono riportati alcuni dei filtri degli attributi chiave che possono essere usati come parte dell'operazione di esportazione
enrollmentParticipantId	query		int	Filtro ID MPN registrato per una richiesta di esportazione. Utilizzo: {baseUrl}/payouts/payments?$filter=enrollmentParticipantId=12345
Multiple filters	query		string	Ecco una query di esempio con più filtri per una richiesta di esportazione. Utilizzo: {baseUrl}/payouts/payments?$filter=payoutStatusUpdateTS ge 2023-01-01 e payoutStatusUpdateTS le 2023-05-31 and (enrollmentParticipantId eq 'XXXXXXX') e (programName eq 'CSP Direct Bill Partner') e (payoutOrderType eq 'REBATE') e (paymentId eq 'xxxxxxx')
paymentAmount	query		double	Importo del pagamento per filtrare i pagamenti per una richiesta di esportazione. Utilizzo: {baseUrl}/payouts/payments?$filter=paymentAmount ge 2000 e paymentAmount le 5000
paymentId	query		int	Filtro PaymentId per una richiesta di esportazione. Utilizzo: {baseUrl}/payouts/payments?$filter=paymentId=123456
payoutOrderType	query		string	Tipo di ordine proventi (Sconto, coop, Fee, Sell) per filtrare i pagamenti per una richiesta di esportazione. Utilizzo: {baseUrl}/payouts/payments?$filter=?$filter=payoutOrderType='REBATE'
payoutStatusUpdateTS	query		string	Data stato proventi per filtrare i pagamenti per una richiesta di esportazione. Utilizzo: {baseUrl}/payouts/transactionhistory?$filter=payoutStatusUpdateTS ge 2023-03-01 e payoutStatusUpdateTS le 2023-04-12

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
Authorization	True	string	Token di connessione dell'autorizzazione
Client-Request-ID		string	ID della richiesta fornita dall'utente

Risposte

Nome	Tipo	Descrizione
202 Accepted	Microsoft.Partner.Service.PartnerPayout.Contracts.V1.Export	La richiesta è stata accettata correttamente per l'elaborazione. Headers Request-ID: string
400 Bad Request		È presente un input mancante o non valido. Il corpo della risposta fornirà i dettagli dell'errore.
401 Unauthorized		La richiesta non è stata autenticata. Il client deve prima eseguire l'autenticazione con il servizio API partner.
403 Forbidden		La richiesta è stata autenticata ma è stata rifiutata perché il chiamante non dispone dei diritti per richiamarlo.
404 Not Found		La risorsa non viene trovata.
429 Too Many Requests		Numero eccessivo di richieste.
500 Internal Server Error		Il servizio API partner o una delle relative dipendenze non è riuscito a soddisfare la richiesta. I chiamanti potrebbero riprovare.

Definizioni

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

Nome	Tipo	Descrizione
blobLocation	string
processingStartDateTime	string
requestDateTime	string
requestId	string
requestPath	string
requestQueryString	string
status	enum: Completed Failed Processing Queued