إجراء تسويات في الفوترة

أنت الآن بصدد الاطّلاع على مستندات Apigee Edge.
انتقِل إلى مستندات Apigee X. info

مقدمة

تتيح لك ميزة تحقيق الربح إجراء تعديلات على تفاصيل الفوترة. على سبيل المثال، قد تحتاج إلى زيادة أو خفض حصة الإيرادات أو الرسوم لشهر فوترة معيّن بسبب تفاوت في سجلاتك.

استكشاف صفحة "تسويات الفوترة"

انتقِل إلى صفحة "تعديلات الفوترة"، كما هو موضّح أدناه.

إضافة تسوية رصيد الحساب

لإضافة تسوية رصيد الحساب، اتّبِع الخطوات التالية:

1. الوصول إلى صفحة "تعديلات الفوترة"
2. انقر على + تسوية.
3. أدخل المعلومات التالية:

   الحقل	الوصف
   الاسم	اسم وصفي سيظهر في مستند الفوترة
   نسبة التسوية	مبلغ التسوية، كنسبة مئوية موجبة أو سالبة تؤدي النسبة المئوية الموجبة إلى زيادة حصة الإيرادات أو الرسوم في المعاملة بهذه النسبة المئوية. يؤدي التعديل السلبي إلى خفض حصة الإيرادات أو الرسوم في المعاملة بالنسبة المئوية المحدّدة. أدخِل رقمًا عشريًا موجبًا أو سالبًا (يتضمّن علامتَين عشريتَين كحدّ أقصى).
   شهر الفوترة	شهر الفوترة الذي سيتم فيه إجراء التسوية اختَر شهرًا من القائمة المنسدلة.
   نوع المعاملة	نوع المعاملة التي تريد تطبيق التسوية عليها اختَر قيمة من القائمة المنسدلة: كل المعاملات الرسوم (معاملات نموذج الشحن) عملية الشراء (المعاملات التي تستخدم نموذج مشاركة الإيرادات) ردّ الأموال (معاملات نموذج مشاركة الإيرادات)
   المنتج	منتج واجهة برمجة التطبيقات الذي تريد تطبيق التعديل عليه لا يمكنك تطبيق تعديل واحد على منتجات متعددة من واجهة برمجة التطبيقات. إذا كنت بحاجة إلى تطبيق تعديل على منتجات متعددة في واجهة برمجة التطبيقات، عليك إنشاء تعديل لكل منتج. اختَر منتج واجهة برمجة تطبيقات من القائمة المنسدلة.
   المطوّر	المطوِّر الذي تريد تطبيق التعديل عليه يمكنك تطبيق التعديل على جميع المطوّرين (تلقائيًا) أو على مطوّر محدّد. اختَر "جميع المطوّرين" أو مطوّرًا معيّنًا من القائمة المنسدلة.

4. انقر على إنشاء تسوية.

تعديل تسوية رصيد الحساب

لتعديل تسوية رصيد الحساب، اتّبِع الخطوات التالية:

1. الوصول إلى صفحة "تعديلات الفوترة"
2. ضَع المؤشر فوق تسوية رصيد الحساب الذي تريد تعديله وانقر على في قائمة الإجراءات.
3. عدِّل تسوية رصيد الحساب حسب الحاجة.
4. انقر على تعديل التسوية.

إجراء تعديلات على الفوترة باستخدام واجهة برمجة التطبيقات

توضّح الأقسام التالية كيفية إجراء تعديلات على الفوترة باستخدام واجهة برمجة التطبيقات.

إجراء تسوية رصيد الحساب باستخدام واجهة برمجة التطبيقات

يمكنك تعديل تفاصيل الفوترة من خلال إرسال طلب POST إلى /organizations/{org_name}/billing-adjustments. عند تقديم الطلب، عليك تحديد ما يلي في نص الطلب:

• اسم تسوية رصيد الحساب
• نسبة التعديل، أي قيمة نسبة مئوية موجبة أو سالبة تؤدي إلى زيادة الفاتورة أو خفضها على التوالي.
• شهر الفوترة
• عام الفوترة
• المؤسسة التي يتم تطبيق تسوية رصيد الحساب عليها

يمكنك أيضًا تحديد خصائص أخرى، مثل:

• نوع المعاملة التي تريد تطبيق التعديل عليها (مثل معاملة شراء)
• المطوِّر الذي تريد تطبيق التعديل عليه
• تحديد ما إذا كنت تريد تطبيق التعديل على المطوّرين الذين يستخدمون الدفع المُسبَق أو الدفع عند الاستخدام أو كليهما
• حزمة واجهة برمجة التطبيقات التي تريد تطبيق التعديل عليها
• منتج واجهة برمجة التطبيقات الذي تريد تطبيق التعديل عليه

راجِع إعدادات ضبط تسوية رصيد الحساب للاطّلاع على قائمة كاملة بخصائص تسوية رصيد الحساب التي يمكنك تحديدها في طلب تسوية رصيد الحساب.

في حال عدم تحديد خاصية اختيارية، سيشمل تعديل مستند الفوترة جميع القيم الخاصة بهذه الخاصية. على سبيل المثال، إذا لم يتم تحديد نوع المعاملة، سيتم تطبيق تسوية الفوترة على جميع أنواع المعاملات.

يقدم المثال التالي تسوية رصيد الحساب لشهر يونيو 2013، وهو شهر نظام الفوترة البديل. يؤدي التعديل إلى خفض الرسوم بنسبة %3، ويتم تطبيقه على معاملات الشراء ومنتج الدفع والمطوّرين الذين يستخدمون نظام الدفع الآجل. بما أنّه لم يتم تحديد خصائص لتعريف مطوّر معيّن أو حزمة واجهة برمجة تطبيقات معيّنة، سيتم تطبيق التسوية على جميع المطوّرين (الذين يستخدمون الدفع الآجل) ومنتج الدفع في جميع حِزم واجهات برمجة التطبيقات.

$ curl -H "Content-Type:application/json" -X POST -d \
'{
  "name": "Purchase Adjustment Negative3",
  "adjustmentPercentageFactor": -3,
  "billingMonth": 6,
  "billingYear": 2017,
  "isPublished": false,
  "transactionType": "PURCHASE",
  "developerBillingType": "POSTPAID",
  "organization": {
      "id": "{org_name}" 
  },
  "product": { "id": "payment" }
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/billing-adjustments" \
-u email:password

من المفترض أن يظهر الرد على النحو التالي (يتم عرض جزء من الرد فقط):

{
  "adjustmentPercentageFactor" : -3,
  "billingMonth" : 6,
  "billingYear" : 2017,
  "developerBillingType" : "POSTPAID",
  "id" : "511144db-7fb1-4c74-bafb-5bc7a6380c9c",
  "isPublished" : false,
  "name" : "Purchase Adjustment Negative3",
  "organization" : {
   ...
  },
  "product" : {
    "customAtt1Name" : "user",
    "description" : "Payment",
    "displayName" : "Payment",
    "id" : "payment",
    "name" : "payment",
    "organization" : {
      ...
    },
    "status" : "CREATED",
    "transactionSuccessCriteria" : "Status=='200 OK'"
  },
  "transactionType" : "PURCHASE"
}

عرض تسويات رصيد الحساب باستخدام واجهة برمجة التطبيقات

يمكنك الاطّلاع على تسوية رصيد حساب معيّنة أو جميع تسويات رصيد الحساب لمؤسسة. للاطّلاع على تسوية رصيد حساب معيّنة، أرسِل طلب استرداد بيانات باستخدام GET إلى /organizations/{org_name}/billing-adjustments/{billing_adjustment_id}، حيث {billing_adjustment_id} هو تعريف تسوية رصيد الحساب المحدّدة (يتم عرض المعرّف في الردّ عند إنشاء تسوية رصيد الحساب). على سبيل المثال:

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/billing-adjustments/511144db-7fb1-4c74-bafb-5bc7a6380c9c" \
-u email:password

للاطّلاع على جميع تسويات رصيد الحساب لمؤسسة، أرسِل طلب استرداد بيانات باستخدام GET إلى /organizations/{org_name}/billing-adjustments. على سبيل المثال:

$ curl -H "Accept:application/json" -X GET \ 
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/billing-adjustments" \ 
-u email:password

من المفترض أن يظهر الرد على النحو التالي (يتم عرض جزء من الرد فقط):

{
  "billingAdjustment" : [ {
    "adjustmentPercentageFactor" : -3,
    "billingMonth" : 6,
    "billingYear" : 2017,
    "developerBillingType" : "POSTPAID",
    "id" : "511144db-7fb1-4c74-bafb-5bc7a6380c9c",
    "isPublished" : false,
    "name" : "Purchase Adjustment Negative3",
    "organization" : {
      ...
    },
    "product" : {
      "customAtt1Name" : "user",
      "description" : "Payment",
      "displayName" : "Payment",
      "id" : "payment",
      "name" : "payment",
      "organization" : {
        ...
      },
      "status" : "CREATED",
      "transactionSuccessCriteria" : "Status=='200 OK'"
    },
    "transactionType" : "PURCHASE"
  }, {
    "adjustmentPercentageFactor" : 5.0000,
    "billingMonth" : 5,
    "billingYear" : 2017,
    "id" : "53c363c0-7e1d-4dc1-9392-cf86656225f2",
    "isPublished" : false,
    "monetizationPackage" : {
      "description" : "Communications",
      "displayName" : "Communications",
      "id" : "communications",
      "name" : "Communications",
      "organization" : {
       ...
      },
      "product" : [ {
        "customAtt1Name" : "user",
        "description" : "Messaging",
        "displayName" : "Messaging",
        "id" : "messaging",
        "name" : "messaging",
        "organization" : {
          ...
        },
        "status" : "CREATED"
      }, {
        ...
        },
        "status" : "CREATED",
        "transactionSuccessCriteria" : "Status=='200 OK'"
      } ],
      "status" : "CREATED"
    },
    "name" : "Test Package Adjustment",
    "organization" : {
     ...
    },
    "product" : {
      "customAtt1Name" : "user",
      "description" : "Location",
      "displayName" : "Location",
      "id" : "location",
      "name" : "location",
      "organization" : {
        ...
      },
      "status" : "CREATED",
      "transactionSuccessCriteria" : "Status=='200 OK'"
    }
  } ],
  "totalRecords" : 2
}

تحديث تسوية رصيد الحساب باستخدام واجهة برمجة التطبيقات

يمكنك تعديل تسوية رصيد الحساب عن طريق إرسال طلب PUT إلى /organizations/{org_name}/billing-adjustments/{billing_adjustment_id}، حيث {billing_adjustment_id} هو معرّف تسوية رصيد الحساب المحدّدة. عند إجراء التعديل، عليك تحديد الخصائص المعدَّلة ومعرّف تسوية رصيد الحساب المطلوب تعديله في نص الطلب. عليك أيضًا تحديد الخصائص الإلزامية لتسوية رصيد الحساب، أي خصائص الاسم ونسبة التسوية وشهر الفوترة وسنة الفوترة والمؤسسة.

على سبيل المثال، يعدّل طلب البيانات التالي من واجهة برمجة التطبيقات عامل النسبة المئوية للتسوية واسمها (تم تمييز الخصائص المعدَّلة في المثال):

$ curl -H "Content-Type: application/json" -X PUT -d \
'{
  "id" : "511144db-7fb1-4c74-bafb-5bc7a6380c9c ",
  "adjustmentPercentageFactor": -5,
  "name" : "Purchase Adjustment Negative5",
  "billingMonth": 6,
  "billingYear": 2017,
  "isPublished": false,
  "transactionType": "PURCHASE",
  "developerBillingType": "POSTPAID",
  "organization": {
      "id": "{org_name}" 
    },
  "product": { "id": "payment" }
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/billing-adjustments/511144db-7fb1-4c74-bafb-5bc7a6380c9c" \
-u email:password

حذف تسوية رصيد الحساب باستخدام واجهة برمجة التطبيقات

يمكنك حذف تسوية رصيد الحساب عن طريق إرسال طلب DELETE إلى /organizations/{org_name}/billing-adjustments/{billing_adjustment_id}، حيث يمثّل {billing_adjustment_id} معرّف تسوية رصيد الحساب المطلوب حذفه. على سبيل المثال:

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/billing-adjustments/511144db-7fb1-4c74-bafb-5bc7a6380c9c" \
-u email:password

إعدادات ضبط تسوية رصيد الحساب لواجهة برمجة التطبيقات

تتوفّر خيارات الإعداد التالية لتعديلات الفوترة:

الخطوات التالية

تتيح لك ميزة تحقيق الربح منح أرصدة للمطوّر. قد تحتاج إلى إجراء ذلك إذا لم يكن المطوّر راضيًا عن إحدى الخدمات وطلب استرداد جزء من الأموال أو ردّ الأموال بالكامل مقابل الاستخدام خلال فترة معيّنة. تعرَّف على كيفية إصدار رصيد في إصدار رصيد.