Membuat permintaan ekspor penghasilan

Gunakan API ini untuk mengantrekan permintaan ekspor data penghasilan dan transaksi/pembayaran terkait baru dengan filter opsional untuk memotong dan menganalisis data penghasilan dan transaksi. Ini mengembalikan status HTTP 202 dan ID permintaan, yang dapat digunakan untuk melakukan pengecekan ulang untuk memeriksa status permintaan ekspor transaksi yang sedang dalam antrian.

Kirim permintaan POST ke titik akhir API untuk mengantrekan permintaan ekspor baru untuk transaksi/penghasilan.

Permintaan REST

Metode Meminta URI
POST https://api.partner.microsoft.com/v1.0/payouts/transactionhistory?$filter={$filter}&fileformat=csv

Parameter permintaan

Nama Di Diperlukan Jenis Deskripsi
$filter Kueri Tidak String Meskipun ini adalah filter opsional, kami sangat menyarankan penggunaan filter untuk performa yang lebih cepat dan membatasi data ekspor Anda alih-alih mengekspor data tiga tahun terakhir. Lihat tabel berikut untuk sekumpulan opsi $filter lengkap.
fileFormat Pertanyaan Tidak String Nilai-nilai yang didukung adalah .csvdan /.tsv. Secara otomatis akan menjadi .csv jika tidak ada nilai yang diberikan.

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

Nama Deskripsi Jenis Contoh
enrollmentParticipantId ID MPN organisasi yang terdaftar secara resmi. Integer {baseUrl}/v1.0/payouts/transactionhistory?$filter= enrollmentParticipantId=12345
EarningForDate Tanggal periode penghasilan untuk operasi ekspor. TanggalWaktu {baseUrl}/v1.0/payouts/transactionhistory?$filter=earningForDate ge 2023-03-01 and earningForDate le 2023-04-12
transactionAmount Jumlah transaksi. Dobel {baseUrl}/v1.0/payouts/transactionhistory?$filter=?$filter=transactionAmount ge 2000 and transactionAmount le 5000
earningAmount Jumlah penghasilan dalam mata uang transaksi. Dobel {baseUrl}/v1.0/payouts/transactionhistory?$filter=?$filter=earningAmount ge 2000 and earningAmount le 5000
engagementName Hanya berlaku untuk Insentif Perdagangan Microsoft. Contoh nilai - 'Azure CSP motion incentives - Indirect Provider'. String {baseUrl}/v1.0/payouts/transactionhistory?$filter=?$filter=engagementName=’Azure CSP motion incentives’
payableSubType Filter menurut jenis penghasilan. Contoh nilai - 'REBATE', 'COOP', 'FEE', 'SELL' String {baseUrl}/v1.0/payouts/transactionhistory?$filter=?$filter=payableSubType=’REBATE’ or payableSubType=’FEE’
payoutStatus Memfilter transaksi menurut status pembayaran. Contoh nilai - 'SENT', 'UPCOMING', 'IN PROGRESS'. String {baseUrl}/v1.0/payouts/transactionhistory?$filter=?$filter=payoutStatus=’IN PROGRESS’

Sampel filter riwayat transaksi dengan beberapa parameter permintaan:

”?$filter=earningForDate ge 2019-01-27T23:16:31.009Z and earningForDate le 2019-09-25T23:16:31.009Z and (enrollmentParticipantId eq 'XXXXXXX') and (programName eq ‘Microsoft Commerce Incentives’) and (payableSubType eq 'REBATE') and (paymentId eq '000000000000') and (engagementName eq 'Azure Enterprise and Self-Service Incentive' or engagementName eq 'Azure CSP motion incentives - Indirect Provider') and (leverCode eq ‘Azure Enterprise and Self-Service Motion’) and (payoutStatus eq 'SENT')”

Header permintaan

Nama Diperlukan Jenis Deskripsi
Otorisasi Ya String Token pembawa otorisasi.
ms-correlationid Tidak String Pelacak permintaan internal. Setiap permintaan menghasilkan pelacak baru (GUID).
ms-requestid Tidak String ID idempoten permintaan.

Untuk mempelajari selengkapnya, lihat header REST dari Pusat Mitra

Isi permintaan

N/A.

Respons API

HTTP/1.1 202 Accepted

Payload respons API mengembalikan atribut berikut:

Nama Fakultatif Deskripsi
Nilai palsu Lihat tabel berikut untuk kemungkinan nilai dan tindakan.

Kemungkinan nilai dan tindakan

Nilai Tindakan klien
ID permintaan ID permintaan permintaan ekspor
tanggal waktu permintaan Tanggalwaktu inisiasi permintaan ekspor
requestPath Jalur kueri untuk permintaan ekspor.
requestQueryString Filter yang digunakan sebagai bagian dari permintaan ekspor.
blobLocation Sumber daya blob dengan token ketika file ekspor sudah siap
Keadaan Status operasi ekspor. Lihat daftar nilai yang mungkin berikut untuk status.

Nilai yang mungkin untuk status

  • Antrean: Operasi ekspor belum dimulai
  • Pemrosesan: Operasi ekspor sedang berlangsung
  • Gagal: Operasi ekspor gagal setelah beberapa kali mencoba ulang, coba mengantrekan permintaan baru
  • Selesai: Operasi ekspor selesai, dan file ekspor siap diunduh.

Contoh respons

{
    "value": [
        {
            "requestId": "93c2b3cf-c6d8-4e7e-ade1-007768a6eba4",
            "requestDateTime": "2023-05-25T21:20:46.3727561Z",
            "requestPath": "/v1.0/payouts/transactionhistory",
            "requestQueryString": "earningForDate ge 2023-03-01 and earningForDate le 2023-04-12",
            "blobLocation": "",
            "status": "Queued"
        }
    ],
    "nextLink": null,
    "totalCount": 1
}

API mengembalikan status HTTP 202.

Nama Deskripsi
202 Diterima Permintaan diterima. Periksa status permintaan melalui URL permintaan GET.

Bergantung pada permintaan, API dapat mengembalikan status standar lainnya:

Nama Deskripsi
400 Permintaan Tidak Valid Ada data yang hilang atau salah.
401 Tidak Sah Pemanggil tidak diautentikasi dan harus mengautentikasi dengan layanan API mitra sebelum melakukan panggilan pertama.
403 Terlarang Pemanggil tidak berwenang untuk membuat permintaan.
Kesalahan Server Internal 500 API atau salah satu dependensinya tidak dapat memenuhi permintaan. Coba lagi nanti.
404 Tidak Ditemukan Sumber daya tidak tersedia dengan parameter input yang diberikan.
Pembatasan laju 429 Terlalu banyak permintaan dengan jenis yang sama. Coba setelah beberapa saat.
  • Last updated on