Partner payouts - Create a new transaction history export request
Toto rozhraní API umožňuje vytvořit nový požadavek na export historie transakcí. Pro každou žádost doporučujeme použít $filter param. Podívejte se prosím níže na použití filtrů a všechny filtry dostupné v rozhraní stránky exportu (UX) jsou také k dispozici prostřednictvím tohoto rozhraní API, což poskytuje flexibilitu a konzistenci při filtrování dat.
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}
Parametry identifikátoru URI
Name | V | Vyžadováno | Typ | Description |
---|---|---|---|---|
version
|
path | True |
string |
|
$filter
|
query |
string |
Parametr $filter dotazu je volitelný parametr pro vytvoření operace exportu. Důrazně ale doporučujeme použít $filter pro lepší výkon a rychlejší dostupnost sestavy exportu. Níže jsou uvedeny některé filtry klíčových atributů, které je možné použít jako součást operace exportu. |
|
earning
|
query |
double |
Filtr částky pro příjem pro žádost o export. Využití: {baseUrl}/payouts/transactionhistory?$filter=earningAmount ge 2000 a earningAmount le 5000 |
|
earning
|
query |
string |
Filtr data období získávání pro žádost o export. Využití: {baseUrl}/payouts/transactionhistory?$filter=earningForDate ge 2023-03-01 a earningForDate le 2023-04-12 |
|
engagement
|
query |
string |
Filtr názvu rezervace pro žádost o export Využití: {baseUrl}/payouts/transactionhistory?$filter=engagementName='Pohybové pobídky Azure CSP' |
|
enrollment
|
query |
int |
Zaregistrovaný filtr ID MPN pro žádost o export. Použití: {baseUrl}/payouts/transactionhistory?$filter=enrollmentParticipantId=12345 |
|
Multiple filters
|
query |
string |
Tady je ukázkový dotaz pro vytvoření žádosti o export s více filtry. Použití: {baseUrl}/payouts/transactionhistory?$filter=earningForDate ge 2023-01-01 a earningForDate le 2023-05-31 a (enrollmentParticipantId eq '. XXXXXXX) a (programName eq 'Microsoft Commerce Incentives') a (payableSubType eq 'RABAT') a (paymentId eq 'xxxxxxx') a (engagementName eq 'Azure Enterprise and Self-Service Incentives' nebo engagementName eq 'Azure CSP motion incentives - Indirect Provider')" |
|
transaction
|
query |
double |
Filtr množství transakcí pro žádost o export. Použití: {baseUrl}/payouts/transactionhistory?$filter=transactionAmount ge 2000 a transactionAmount le 5000 |
Hlavička požadavku
Name | Vyžadováno | Typ | Description |
---|---|---|---|
Authorization | True |
string |
Nosný token autorizace |
Client-Request-ID |
string |
ID požadavku poskytnutého uživatelem |
Odpovědi
Name | Typ | Description |
---|---|---|
202 Accepted |
Žádost byla úspěšně přijata ke zpracování. Headers Request-ID: string |
|
400 Bad Request |
Chybí nebo je neplatný vstup. Text odpovědi poskytne podrobnosti o chybě. |
|
401 Unauthorized |
Požadavek nebyl ověřen. Klient se musí nejprve ověřit ve službě partnerského rozhraní API. |
|
403 Forbidden |
Požadavek byl ověřen, ale byl odmítnut, protože volající nemá oprávnění k jejímu vyvolání. |
|
404 Not Found |
Prostředek nebyl nalezen. |
|
429 Too Many Requests |
Příliš mnoho požadavků. |
|
500 Internal Server Error |
Službě partnerského rozhraní API nebo některé z jejích závislostí se nepodařilo požadavek splnit. Volající to můžou zkusit znovu. |
Definice
Microsoft.Partner.Service.PartnerPayout.Contracts.V1.Export
Name | Typ | Description |
---|---|---|
blobLocation |
string |
|
processingStartDateTime |
string |
|
requestDateTime |
string |
|
requestId |
string |
|
requestPath |
string |
|
requestQueryString |
string |
|
status |
enum:
|