Share via


Partner payouts - Create a new transaction history export request

Ez az API lehetővé teszi egy új tranzakciós előzmények exportálási kérésének létrehozását. Javasoljuk, hogy minden kéréshez használjon $filter paramétert. Tekintse meg alább a szűrők használatát, és az exportálási oldal felületén (UX) elérhető összes szűrő is elérhető ezen az API-n keresztül, ami rugalmasságot és konzisztenciát biztosít az adatok szűrésében.

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

URI-paraméterek

Name In Kötelező Típus Description
version
path True

string

$filter
query

string

A $filter lekérdezésparaméter egy nem kötelező paraméter egy exportálási művelet létrehozásához. Javasoljuk azonban a $filter használatát az exportálási jelentés jobb teljesítménye és gyorsabb rendelkezésre állása érdekében. Az alábbiakban néhány olyan kulcsattribútum-szűrőt talál, amelyek az exportálási művelet részeként használhatók

earningAmount
query

double

A bevételi összeg szűrője egy exportálási kérelemhez. Használat: {baseUrl}/payouts/transactionhistory?$filter=earningAmount ge 2000 és earningAmount le 5000

earningForDate
query

string

A bevételi időszak dátumszűrője egy exportálási kérelemhez. Használat: {baseUrl}/payouts/transactionhistory?$filter=earningForDate ge 2023-03-01 és earningForDate le 2023-04-12

engagementName
query

string

Egy exportálási kérelem előjegyzési névszűrője. Használat: {baseUrl}/payouts/transactionhistory?$filter=engagementName='Azure CSP mozgásösztönzők'

enrollmentParticipantId
query

int

Regisztrált MPN-azonosító szűrő egy exportálási kérelemhez. Használat: {baseUrl}/payouts/transactionhistory?$filter=enrollmentParticipantId=12345

Multiple filters
query

string

Íme egy mintalekérdezés, amely több szűrőt tartalmazó exportálási kérést hoz létre. Használat: {baseUrl}/payouts/transactionhistory?$filter=earningForDate ge 2023-01-01 and earningForDate le 2023-05-31 and (enrollmentParticipantId eq 'XXXXXXX " és (programName eq "Microsoft Commerce Incentives") és (payableSubType eq 'VISSZATÉRÍTÉS' ) és (paymentId eq 'xxxxxxx') és (engagementName eq 'Azure Enterprise and Self-Service Incentive' or engagementName eq 'Azure CSP motion incentives - Indirect Provider')"

transactionAmount
query

double

Egy exportálási kérelem tranzakciómennyiség-szűrője. Használat: {baseUrl}/payouts/transactionhistory?$filter=transactionAmount ge 2000 és transactionAmount le 5000

Kérelem fejléce

Name Kötelező Típus Description
Authorization True

string

Engedélyezési tulajdonos jogkivonata

Client-Request-ID

string

A felhasználó által megadott kérés azonosítója

Válaszok

Name Típus Description
202 Accepted

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

A kérelem feldolgozása sikeresen megtörtént.

Headers

Request-ID: string

400 Bad Request

Hiányzó vagy érvénytelen bemenet történt. A válasz törzse adja meg a hiba részleteit.

401 Unauthorized

A kérés hitelesítése nem történt meg. Az ügyfélnek először a partner API szolgáltatással kell hitelesítenie magát.

403 Forbidden

A kérés hitelesítése megtörtént, de a rendszer elutasította, mivel a hívónak nincs jogosultsága meghívni.

404 Not Found

Az erőforrás nem található.

429 Too Many Requests

Túl sok kérés.

500 Internal Server Error

A partner API-szolgáltatás vagy annak egyik függősége nem tudta teljesíteni a kérést. Előfordulhat, hogy a hívó fél újrapróbálkozhat ezzel.

Definíciók

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

Name Típus Description
blobLocation

string

processingStartDateTime

string

requestDateTime

string

requestId

string

requestPath

string

requestQueryString

string

status enum:
  • Completed
  • Failed
  • Processing
  • Queued