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

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

مقدمه

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

کاوش در صفحه تنظیمات صورت‌حساب

همانطور که در زیر توضیح داده شده است، به صفحه تنظیمات صورتحساب دسترسی پیدا کنید.

یک تنظیم صورتحساب اضافه کنید

برای افزودن تنظیم صورتحساب:

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

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

4. روی ایجاد تنظیم کلیک کنید.

ویرایش یک تنظیم صورتحساب

برای ویرایش تنظیم صورت‌حساب:

1. به صفحه تنظیمات صورتحساب دسترسی پیدا کنید .
2. مکان نما را روی تنظیم صورت حسابی که می خواهید ویرایش کنید قرار دهید و کلیک کنید در منوی اقدامات
3. در صورت لزوم، تنظیم صورت‌حساب را به‌روزرسانی کنید.
4. روی Update Adjustment کلیک کنید.

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

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

تنظیم صورتحساب با استفاده از API

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

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

همچنین می توانید ویژگی های دیگری مانند:

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

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

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

مثال زیر تعدیل صورت‌حساب را برای ماه صورت‌حساب باز، ژوئن 2013، انجام می‌دهد. این تعدیل باعث کاهش ضریب 3 درصدی می‌شود و برای تراکنش‌های خرید، محصول پرداخت و توسعه‌دهندگان پس‌پرداخت اعمال می‌شود. از آنجایی که ویژگی های شناسایی یک توسعه دهنده یا بسته 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

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

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

مراحل بعدی

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