انجام اصلاحات صورت‌حساب

درحال مشاهده اسناد Apigee Edge هستید.
به اسناد Apigee X بروید. اطلاعات

مقدمه

کسب درآمد به شما امکان می‌دهد جزئیات صورت‌حساب را اصلاح کنید. برای مثال، ممکن است به‌دلیل اختلاف در سوابق خود نیاز داشته باشید که سهم درآمد یا کارمزدهای یک ماه صورت‌حساب معین را افزایش یا کاهش دهید.

کاوش صفحه «اصلاحات صورت‌حساب»

طبق توضیحات زیر، به صفحه «اصلاحات صورت‌حساب» دسترسی پیدا کنید.

افزودن تعدیل صورت‌حساب

برای افزودن اصلاح صورت‌حساب:

1. به صفحه «تعدیل‌های صورت‌حساب» دسترسی پیدا کنید.
2. روی + اصلاح کلیک کنید.
3. اطلاعات زیر را وارد کنید:

   فیلد	شرح
   نام	نامی توصیفی که در سند صورت‌حساب نشان داده می‌شود.
   درصد تعدیل	مقدار اصلاح، به‌صورت درصد مثبت یا منفی. درصد مثبت سهم درآمد یا کارمزدهای تراکنش را به همان درصد افزایش می‌دهد. تعدیل منفی سهم درآمد یا کارمزدهای تراکنش را به همان درصد کاهش می‌دهد. عدد اعشاری مثبت یا منفی (با حداکثر دو رقم اعشار) وارد کنید.
   ماه صورت‌حساب	ماه صورت‌حساب برای تعدیل. ماهی را از فهرست کرکره‌ای انتخاب کنید.
   نوع تراکنش	نوع تراکنشی که می‌خواهید تعدیل را برای آن اعمال کنید. مقدار موردنظر را از منوِ کرکره‌ای انتخاب کنید: همه تراکنش‌ها کارمزد (تراکنش‌های مدل کارمزد) خرید (تراکنش‌های مدل توزیع سهم درآمد) استرداد مبلغ (تراکنش‌های مدل توزیع سهم درآمد)
   محصول	محصول API که می‌خواهید اصلاح را برای آن اعمال کنید. نمی‌توانید یک اصلاح واحد را برای چند محصول API اعمال کنید. اگر نیاز دارید اصلاحی را برای چند محصول API اعمال کنید، برای هر محصول اصلاحی ایجاد کنید. محصول API را از منوِ کرکره‌ای انتخاب کنید.
   توسعه‌دهنده	توسعه‌دهنده‌ای که می‌خواهید اصلاح را برای او اعمال کنید. می‌توانید این اصلاح را برای همه توسعه‌دهندگان (به‌طور پیش‌فرض) یا برای توسعه‌دهنده خاصی اعمال کنید. «همه توسعه‌دهندگان» یا توسعه‌دهنده خاصی را از منوِ کرکره‌ای انتخاب کنید.

4. روی ایجاد اصلاح کلیک کنید.

ویرایش کردن تعدیل صورت‌حساب

برای ویرایش کردن تعدیل صورت‌حساب:

1. به صفحه «تعدیل‌های صورت‌حساب» دسترسی پیدا کنید.
2. مکان‌نما را روی اصلاح صورت‌حساب موردنظر برای ویرایش قرار دهید و روی در منو کنش‌ها کلیک کنید.
3. تعدیل صورت‌حساب را درصورت نیاز به‌روز کنید.
4. روی به‌روزرسانی اصلاح کلیک کنید.

انجام اصلاحات صورت‌حساب بااستفاده از API

بخش‌های زیر نحوه انجام اصلاحات صورت‌حساب بااستفاده از API را شرح می‌دهد.

انجام تعدیل صورت‌حساب بااستفاده از API

با صدور درخواست POST به /organizations/{org_name}/billing-adjustments می‌توانید جزئیات صورت‌حساب را اصلاح کنید. وقتی درخواست را ارسال می‌کنید، در بدنه درخواست مشخص می‌کنید:

• نام برای اصلاح صورت‌حساب.
• درصد اصلاح، یعنی مقدار درصد مثبت یا منفی که به‌ترتیب صورت‌حساب را افزایش یا کاهش می‌دهد.
• ماه صورت‌حساب.
• سال صورت‌حساب.
• سازمانی که اصلاح صورت‌حساب به آن اعمال می‌شود.

همچنین می‌توانید دارایی‌های دیگری را مشخص کنید، مثلاً:

• نوع تراکنشی که می‌خواهید تعدیل را برای آن اعمال کنید (مثلاً تراکنش خرید).
• توسعه‌دهنده‌ای که می‌خواهید اصلاح را برای او اعمال کنید.
• می‌خواهید این اصلاح را برای توسعه‌دهندگان پیش‌پرداخت، توسعه‌دهندگان پس‌پرداخت، یا هر دو اعمال کنید.
• بسته API که می‌خواهید اصلاح را برای آن اعمال کنید.
• محصول API که می‌خواهید اصلاح را برای آن اعمال کنید.

برای مشاهده فهرست کامل دارایی‌های اصلاح صورت‌حساب که می‌توانید در درخواست اصلاح مشخص کنید، تنظیمات پیکربندی اصلاح صورت‌حساب را ببینید.

اگر دارایی اختیاری مشخص نشده باشد، اصلاح سند صورت‌حساب برای آن دارایی شامل همه موارد خواهد بود. برای مثال، اگر نوع تراکنشی مشخص نشده باشد، اصلاح صورت‌حساب برای همه انواع تراکنش اعمال خواهد شد.

مثال زیر اصلاح صورت‌حساب برای ماه صورت‌حساب باز، ژوئن ۲۰۱۳، را انجام می‌دهد. این اصلاح با ضریب ۳٪ کاهش می‌یابد و بر تراکنش‌های خرید، محصول پرداخت، و توسعه‌دهندگان پس‌پرداخت اعمال می‌شود. ازآنجایی‌که دارایی‌های مربوط به شناسایی توسعه‌دهنده یا بسته API خاصی مشخص نشده است، این تعدیل برای همه توسعه‌دهندگان (که توسعه‌دهندگان پس‌پرداخت هستند) و محصول پرداخت در همه بسته‌های API اعمال خواهد شد.

$ 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"
}

مشاهده کردن تعدیل‌های صورت‌حساب بااستفاده از API

می‌توانید یک تعدیل صورت‌حساب خاص یا همه تعدیل‌های صورت‌حساب را برای یک سازمان مشاهده کنید. برای مشاهده یک اصلاح صورت‌حساب خاص، یک درخواست 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
}

به‌روزرسانی اصلاح صورت‌حساب بااستفاده از API

می‌توانید اصلاح صورت‌حساب را با صدور درخواست PUT به /organizations/{org_name}/billing-adjustments/{billing_adjustment_id} به‌روز کنید، که در آن {billing_adjustment_id} شناسه اصلاح صورت‌حساب خاص است. وقتی به‌روزرسانی را انجام می‌دهید، باید در بدنه درخواست، دارایی‌های به‌روزشده و شناسایی اصلاح صورت‌حساب را که باید به‌روز شود مشخص کنید. همچنین باید دارایی‌های اجباری برای اصلاح صورت‌حساب را مشخص کنید، یعنی دارایی‌های مربوط به نام، درصد اصلاح، ماه صورت‌حساب، سال صورت‌حساب، و سازمان.

برای مثال، فراخوانی API زیر عامل درصد اصلاح و نام را به‌روز می‌کند (در مثال، دارایی‌های به‌روزشده برجسته شده‌اند):

$ 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

حذف اصلاح صورت‌حساب بااستفاده از API

می‌توانید با صدور درخواست 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

تنظیمات پیکربندی اصلاح صورت‌حساب برای «میانای برنامه‌سازی کاربردی»

گزینه‌های پیکربندی زیر برای اصلاحات صورت‌حساب دردسترس است:

مراحل بعدی

«درآمدزایی» به شما این انعطاف‌پذیری را می‌دهد که به توسعه‌دهنده اعتبار بدهید. ممکن است لازم باشد این کار را انجام دهید اگر توسعه‌دهنده‌ای از سرویسی ناراضی باشد و درخواست استرداد مبلغ جزئی یا کامل برای استفاده در یک دوره را داشته باشد. در صدور اعتبار، با نحوه صدور اعتبار آشنا شوید.