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

يتم الآن عرض مستندات Apigee Edge.
انتقِل إلى مستندات Apigee X. المعلومات

مقدمة

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

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

ادخل إلى صفحة تسويات الفوترة، كما هو موضّح أدناه.

إضافة تسوية فوترة

لإضافة تسوية فوترة:

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

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

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

الاسم	الوصف	تلقائي	مطلوب؟
name	اسم وصفي لتسوية الفوترة.	لا ينطبق	نعم
adjustmentPercentageFactor	مبلغ التسوية كنسبة مئوية رقمية موجبة أو سالبة. ويتم تعديل حصة الأرباح أو الرسوم في المعاملة وفقًا للنسبة المئوية الموجبة. ويتم تعديل حصة الأرباح أو الرسوم في المعاملة وفقًا للنسبة المئوية السالبة. يمكن أن تتراوح القيم بين -100 و999.9999.	لا ينطبق	نعم
billingMonth	شهر الفوترة لتسوية الفوترة، ويتم تحديده كعدد صحيح. على سبيل المثال، 11 لشهر كانون الأول (ديسمبر).	لا ينطبق	نعم
billingYear	سنة الفوترة لتسوية الفوترة، والتي يتم تحديدها باستخدام التنسيق التالي: YYYY. على سبيل المثال، 2017.	لا ينطبق	نعم
organization	المؤسسة التي تنطبق عليها تسوية الفوترة.	لا ينطبق	نعم
isPublished	علامة تحدد ما إذا كان يجب نشر التعديل. يمكن أن تكون القيمة واحدة مما يلي: true. يجب نشر تسوية الفوترة. false. يجب عدم نشر تسوية الفوترة.	لا ينطبق	لا
transactionType	نوع المعاملات التي تسري عليها تسوية الفوترة. ويمكن أن يكون النوع واحدًا مما يلي: PURCHASE CHARGE REFUND CREDIT BALANCE SETUPFEES TERMINATIONFEES RECURRINGFEES TRUEUPS. هذه هي المعاملات التي تُستخدَم لإعادة ضبط المعاملات المقيّمة. ويتم استدعاءها عند إجراء تغييرات على الضرائب في شهر الفوترة السابق.	لا ينطبق	لا
developerBillingType	نوع الفوترة الخاص بالمطوّر الذي تنطبق عليه تسوية الفوترة يمكن أن تكون القيمة واحدة مما يلي: PREPAID.. مطوّرو البرامج المدفوعة مسبقًا POSTPAID. المطوِّرون الذين يستخدمون نظام الدفع الآجل. BOTH. مطوّرو البرامج المدفوعة مسبقًا والدفع الآجل.	لا ينطبق	لا
product	منتج واجهة برمجة التطبيقات الذي تنطبق عليه تسوية الفوترة. وإذا لم تحدّد هذه السمة، سيتم تطبيق تعديل الفوترة على جميع منتجات واجهة برمجة التطبيقات.	لا ينطبق	لا
monetizationPackage	حزمة واجهة برمجة التطبيقات التي تنطبق عليها تسوية الفوترة. إذا لم تحدّد هذه السمة، سيتم تطبيق تعديل الفوترة على جميع حِزم واجهة برمجة التطبيقات.	لا ينطبق	لا
developer	المطوّر الذي تسري عليه تسوية الفوترة إذا لم تحدّد هذه السمة، ستنطبق تسوية الفوترة على جميع المطوّرين.	لا ينطبق	لا

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

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