Bagikan melalui


Partner payouts - Creates a new payments export request

API ini memungkinkan untuk membuat permintaan ekspor pembayaran baru. Sebaiknya gunakan $filter param untuk setiap permintaan. Silakan lihat di bawah ini tentang penggunaan filter dan semua filter yang tersedia di antarmuka halaman ekspor (UX) juga tersedia melalui API ini, memberikan fleksibilitas dan konsistensi dalam memfilter data.

POST https://api.partnercenter.microsoft.com/v{version}/payouts/payments
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}

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
version
path True

string

$filter
query

string

Param kueri $filter adalah parameter opsional untuk membuat operasi ekspor. Namun, kami sangat menyarankan untuk menggunakan $filter untuk performa yang lebih baik dan ketersediaan laporan ekspor yang lebih cepat. Di bawah ini adalah beberapa filter atribut utama yang dapat digunakan sebagai bagian dari operasi ekspor

enrollmentParticipantId
query

int

Filter Id MPN terdaftar untuk permintaan ekspor. Penggunaan: {baseUrl}/pembayaran/pembayaran?$filter=enrollmentParticipantId=12345

Multiple filters
query

string

Berikut adalah kueri sampel dengan beberapa filter untuk permintaan ekspor. Penggunaan: {baseUrl}/pembayaran/pembayaran?$filter=payoutStatusUpdateTS ge 2023-01-01 dan payoutStatusUpdateTS le 2023-05-31 dan (enrollmentParticipantId eq 'XXXXXXX') dan (programName eq 'CSP Direct Bill Partner') dan (payoutOrderType eq 'REBATE') dan (paymentId eq 'xxxxxxx')

paymentAmount
query

double

Jumlah pembayaran untuk memfilter pembayaran untuk permintaan ekspor. Penggunaan: {baseUrl}/pembayaran/pembayaran?$filter=paymentAmount ge 2000 dan paymentAmount le 5000

paymentId
query

int

Filter PaymentId untuk permintaan ekspor. Penggunaan: {baseUrl}/payouts/payments?$filter=paymentId=123456

payoutOrderType
query

string

Jenis pesanan pembayaran (Rebate, coop, Fee, Sell) untuk memfilter pembayaran untuk permintaan ekspor. Penggunaan: {baseUrl}/payouts/payments?$filter=?$filter=payoutOrderType='REBATE'

payoutStatusUpdateTS
query

string

Tanggal status pembayaran untuk memfilter pembayaran untuk permintaan ekspor. Penggunaan: {baseUrl}/payouts/transactionhistory?$filter=payoutStatusUpdateTS ge 2023-03-01 dan payoutStatusUpdateTS le 2023-04-12

Header Permintaan

Nama Diperlukan Jenis Deskripsi
Authorization True

string

Token Pembawa Otorisasi

Client-Request-ID

string

ID permintaan yang disediakan oleh pengguna

Respons

Nama Jenis Deskripsi
202 Accepted

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

Permintaan berhasil diterima untuk diproses.

Headers

Request-ID: string

400 Bad Request

Ada input yang hilang atau tidak valid. Isi respons akan memberikan detail kesalahan.

401 Unauthorized

Permintaan tidak diautentikasi. Klien perlu mengautentikasi dengan layanan API mitra terlebih dahulu.

403 Forbidden

Permintaan diautentikasi tetapi ditolak karena penelepon tidak memiliki hak untuk memanggilnya.

404 Not Found

Sumber daya tidak ditemukan.

429 Too Many Requests

Terlalu banyak permintaan.

500 Internal Server Error

Layanan API mitra atau salah satu dependensinya gagal memenuhi permintaan. Penelepon dapat mencoba kembali ini.

Definisi

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

Nama Jenis Deskripsi
blobLocation

string

processingStartDateTime

string

requestDateTime

string

requestId

string

requestPath

string

requestQueryString

string

status enum:
  • Completed
  • Failed
  • Processing
  • Queued