Внесите корректировки в платежные данные

Вы просматриваете документацию 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, к которому вы хотите применить корректировку.

Полный список свойств корректировки счетов, которые можно указать в запросе на корректировку, см. в разделе Параметры конфигурации корректировки счетов .

Если необязательное свойство не указано, корректировка документа фактуры будет включать все для этого свойства. Например, если тип транзакции не указан, корректировка платежа будет применяться ко всем типам транзакций.

В следующем примере выполняется корректировка выставления счетов за открытый месяц выставления счетов, июнь 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

Для корректировки выставления счетов доступны следующие параметры конфигурации:

Следующие шаги

Монетизация дает вам возможность выдавать кредиты разработчику. Это может потребоваться, если разработчик не удовлетворен услугой и запрашивает частичный или полный возврат средств за использование за определенный период. Узнайте, как выдать кредит в разделе «Выдача кредитов» .