Partner payouts - Creates a new payments export request

Referencia

Szolgáltatás:: Partner Center Rest

API-verzió:: 1.0

Ez az API lehetővé teszi egy új fizetési exportálási kérelem létrehozását. Javasoljuk, hogy minden kéréshez használjon $filter paramot. 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, rugalmasságot és konzisztenciát biztosítva az adatok szűrésében.

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

Opcionális paraméterekkel:

POST https://api.partner.microsoft.com/v{version}/payouts/payments?$filter={$filter}&enrollmentParticipantId={enrollmentParticipantId}&paymentId={paymentId}&payoutStatusUpdateTS={payoutStatusUpdateTS}&paymentAmount={paymentAmount}&payoutOrderType={payoutOrderType}&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 nem kötelező paraméter az exportálási művelet létrehozásához. Javasoljuk azonban, hogy $filter használjon az exportálási jelentés jobb teljesítménye és gyorsabb rendelkezésre állása érdekében. Az alábbiakban néhány, az exportálási művelet részeként használható kulcsattribútum-szűrőt láthat
enrollmentParticipantId	query		int	Regisztrált MPN-azonosító szűrő egy exportálási kérelemhez. Használat: {baseUrl}/payouts/payments?$filter=enrollmentParticipantId=12345
Multiple filters	query		string	Íme egy minta lekérdezés, amely több szűrőt is használ egy exportálási kérelemhez. Használat: {baseUrl}/payouts/payments?$filter=payoutStatusUpdateTS ge 2023-01-01 és payoutStatusUpdateTS le 2023-05 -31 és (enrollmentParticipantId eq 'XXXXXXX') és (programName eq 'CSP Direct Bill Partner') és (payoutOrderType eq 'REBATE') és (paymentId eq 'xxxxxxx')
paymentAmount	query		double	Az exportkérelmek kifizetéseinek szűréséhez szükséges fizetési összeg. Használat: {baseUrl}/payouts/payments?$filter=paymentAmount ge 2000 és paymentAmount le 5000
paymentId	query		int	PaymentId-szűrő egy exportálási kérelemhez. Használat: {baseUrl}/payouts/payments?$filter=paymentId=123456
payoutOrderType	query		string	Kifizetési rendelés típusa (visszatérítés, coop, díj, értékesítés) az exportkérelmek kifizetéseinek szűréséhez. Használat: {baseUrl}/payouts/payments?$filter=?$filter=payoutOrderType='REBATE'
payoutStatusUpdateTS	query		string	Kifizetési állapot dátuma az exportálási kérelem kifizetéseinek szűréséhez. Használat: {baseUrl}/payouts/transactionhistory?$filter=payoutStatusUpdateTS ge 2023-03-01 és payoutStatusUpdateTS le 2023-04-12

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érést sikeresen elfogadták feldolgozásra. Fejlécek Request-ID: string
400 Bad Request		Hiányzó vagy érvénytelen bemenet volt. A válasz törzse adja meg a hiba részleteit.
401 Unauthorized		A kérés nem lett hitelesítve. 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 joga 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. A hívók újra megpróbálhatják ezt.

Definíciók

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

Objektum

Name	Típus	Description
blobLocation	string
processingStartDateTime	string
requestDateTime	string
requestId	string
requestPath	string
requestQueryString	string
status	enum: Completed Failed Processing Queued