Kazanç dışarı aktarma isteği oluşturma

Makale
12/19/2023

Kazanç ve işlem verilerini dilimleyip parçalara ayıracak isteğe bağlı filtrelerle yeni kazançları ve temel alınan işlemleri/ödeme verilerini dışarı aktarma isteğini kuyruğa almak için bu API'yi kullanın. Kuyruğa alınan işlem dışarı aktarma isteğinin durumunu denetlemek için yeniden yoklama yapmak için kullanılabilen 202 HTTP durumunu ve istek kimliğini döndürür.

İşlemler/kazançlar için yeni bir dışarı aktarma isteğini kuyruğa almak için API uç noktasına bir POST isteği gönderin.

REST isteği

Metot	İstek URI'si
POST	`https://api.partner.microsoft.com/v1.0/payouts/transactionhistory?$filter={$filter}&fileformat=csv`

İstek parametreleri

Adı	In	Zorunlu	Türü	Açıklama
$filter	Query	No	String	İsteğe bağlı bir filtre olsa da, son üç yıllık verileri dışarı aktarmak yerine daha hızlı performans için filtreleri kullanmanızı ve dışarı aktarma verilerinizi sınırlamanızı kesinlikle öneririz. Tüm $filter seçenekleri için aşağıdaki tabloya bakın.
Fileformat	Query	No	String	Desteklenen değerler .csv/.tsv'dir. Değer sağlanmazsa varsayılan olarak .csv olur.

$filter sorgu parametresi, dışarı aktarma işlemi oluşturmak için isteğe bağlı bir parametredir. Ancak, dışarı aktarma raporunun daha iyi performans ve daha hızlı kullanılabilirliği için $filters kullanmanızı kesinlikle öneririz. Dışarı aktarma işleminin bir parçası olarak kullanılabilecek anahtar öznitelik filtrelerinden bazıları şunlardır:

Adı	Açıklama	Türü	Örnek
`enrollmentParticipantId`	Kuruluşun kayıtlı MPN kimliği.	Int	{baseUrl}`/v1.0/payouts/transactionhistory?$filter= enrollmentParticipantId=12345`
`EarningForDate`	Dışarı aktarma işlemi için kazanç dönemi tarihi.	DateTime	{baseUrl}`/v1.0/payouts/transactionhistory?$filter=earningForDate ge 2023-03-01 and earningForDate le 2023-04-12`
`transactionAmount`	İşlem tutarı.	Çift	{baseUrl}`/v1.0/payouts/transactionhistory?$filter=?$filter=transactionAmount ge 2000 and transactionAmount le 5000`
`earningAmount`	İşlem para birimi cinsinden kazanç tutarı.	Çift	{baseUrl}`/v1.0/payouts/transactionhistory?$filter=?$filter=earningAmount ge 2000 and earningAmount le 5000`
`engagementName`	Yalnızca Microsoft Ticaret Teşvikleri için geçerlidir. Örnek değerler - `'Azure CSP motion incentives - Indirect Provider'`.	String	{baseUrl}`/v1.0/payouts/transactionhistory?$filter=?$filter=engagementName=’Azure CSP motion incentives’`
`payableSubType`	Kazanç türüne göre filtreleyin. Örnek değerler - `'REBATE'`, `'COOP'`, `'FEE'`, `'SELL'`	String	{baseUrl}`/v1.0/payouts/transactionhistory?$filter=?$filter=payableSubType=’REBATE’ or payableSubType=’FEE’`
`payoutStatus`	İşlemleri ödeme durumuna göre filtreleyin. Örnek değerler - `'SENT'`, `'UPCOMING'`, `'IN PROGRESS'`.	String	{baseUrl}`/v1.0/payouts/transactionhistory?$filter=?$filter=payoutStatus=’IN PROGRESS’`

Birden çok istek parametresiyle örnek işlem geçmişi filtresi:

”?$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')”

İstek üst bilgisi

Adı	Zorunlu	Türü	Açıklama
Yetkilendirme	Evet	String	Yetkilendirme taşıyıcı belirteci.
ms-correlationid	No	String	bir iç istek izleyicisi. Her istek yeni bir izleyici (GUID) oluşturur.
ms-requestid	No	String	İstek eşzamanlılık kimliği.

Daha fazla bilgi edinmek için bkz. İş Ortağı Merkezi REST üst bilgileri

Request body

Yok.

API yanıtı

HTTP/1.1 202 Accepted

API yanıt yükü aşağıdaki öznitelikleri döndürür:

Adı	İsteğe bağlı	Açıklama
Değer	yanlış	Olası değerler ve eylemler için aşağıdaki tabloya bakın.

Olası değerler ve eylemler

Değer	İstemci eylemi
requestId	Dışarı aktarma isteğinin istek kimliği
requestDateTime	Dışarı aktarma isteğinin başlatma tarih saati
requestPath	Dışarı aktarma isteğinin sorgu yolu.
requestQueryString	Dışarı aktarma isteğinin bir parçası olarak kullanılan filtre.
blobLocation	Dışarı aktarma dosyası hazır olduğunda belirteci olan blob kaynağı
Durum	dışarı aktarma işlemi durumu. Durum için olası değerlerin aşağıdaki listesine bakın.

Durum için olası değerler

Kuyruğa alındı: Dışarı aktarma işlemi başlatılmadı
İşleme: Dışarı aktarma işlemi devam ediyor
Başarısız: Yeniden denemeler sonrasında dışarı aktarma işlemi başarısız oldu, yeni bir isteği kuyruğa almayı deneyin
Tamamlandı: Dışarı aktarma işlemi tamamlandı ve dışarı aktarma dosyası indirilme için hazır.

Örnek yanıt

{
    "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, HTTP durumu 202'i döndürür.

Adı	Açıklama
202 Kabul Edildi	İstek kabul edildi. İstek durumu için GET isteği URL'sini sorgula.

İsteğe bağlı olarak, API diğer standart durumları döndürebilir:

Adı	Açıklama
400 Hatalı İstek	Eksik veya yanlış veriler vardı.
401 Yetkisiz	Arayan kimliği doğrulanmamıştır ve ilk çağrıyı yapmadan önce iş ortağı API hizmetiyle kimlik doğrulaması yapmalıdır.
403 Yasak	Arayan, isteği yapma yetkisine sahip değil.
500 İç Sunucu Hatası	API veya bağımlılıklarından biri isteği karşılayamıyor. Daha sonra tekrar deneyin.
404 Bulunamadı	Kaynak giriş parametreleriyle kullanılamaz.
429 Hız sınırlama	Aynı türde çok fazla istek var. Bir süre sonra deneyin.

Aracılığıyla paylaş