Partner payouts - Create a new transaction history export request
Questa API consente di creare una nuova richiesta di esportazione della cronologia delle transazioni. È 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/transactionhistory
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}
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 |
|
earning
|
query |
double |
Filtro dell'importo degli utili per una richiesta di esportazione. Utilizzo: {baseUrl}/payouts/transactionhistory?$filter=earningAmount ge 2000 e guadagnareAmount le 5000 |
|
earning
|
query |
string |
Filtro data periodo di guadagno per una richiesta di esportazione. Utilizzo: {baseUrl}/payouts/transactionhistory?$filter=earningForDate ge 2023-03-01 e utiliForDate le 2023-04-12 |
|
engagement
|
query |
string |
Filtro dei nomi di engagement per una richiesta di esportazione. Utilizzo: {baseUrl}/payouts/transactionhistory?$filter=engagementName='Azure CSP motion incentives' |
|
enrollment
|
query |
int |
Filtro ID MPN registrato per una richiesta di esportazione. Utilizzo: {baseUrl}/payouts/transactionhistory?$filter=enrollmentParticipantId=12345 |
|
Multiple filters
|
query |
string |
Ecco una query di esempio per creare una richiesta di esportazione con più filtri. Utilizzo: {baseUrl}/payouts/transactionhistory?$filter=earningForDate ge 2023-01-01 e guadagniForDate 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' o engagementName eq 'Azure CSP motion incentives - Indirect Provider')" |
|
transaction
|
query |
double |
Filtro della quantità di transazione per una richiesta di esportazione. Utilizzo: {baseUrl}/payouts/transactionhistory?$filter=transactionAmount ge 2000 e transactionAmount le 5000 |
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 |
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:
|