اصلاحات صورتحساب را انجام دهید

شما در حال مشاهده مستندات 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

شما می‌توانید با ارسال درخواست حذف به آدرس /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

تنظیمات پیکربندی تنظیم صورتحساب برای API

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

مراحل بعدی

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