In this topic:

Charge Info Types

Charge info transaction types provide a way to group the Gotransverse data. This section is an overview of all charge info types which includes the type of data each of them stands for and the general procedure of how it is collected.

You can retrieve a list of all charge info types by using the following endpoint:

GET /calypso/3/ledgers/chargeinfos/types

Charge Info Types Collecting Charge Info Data
Additional Fee

The data on additional fee applied to the specified product with recurring charge.

"key": "ADDITIONALFEE",
"label": "Additional Fee"

  1. Go to Quick Links>New Basic Product and create a subscription product with a positive charge.
  2. Go to Products>Additional Fees, and click Add to create a new additional fee with the Product Applicability Level.
  3. Associate the additional fee with a product:
    • On the Additional Fee Details page, next to Fee Contribution Criteria, click Add and select the following Criteria TypeProduct.
    • On the Additional Fee Details page, next to Assessment Criteria, click Add and select the following Criteria TypeProduct. Then, to select the products that you want to associate with this additional fee, double-click the desired product in the Available pane on the left. Now, the selected products appear in the Selected pane on the right.
  4. Create an order for this product.

  5. Run the associated bill cycle.

  6. Approve the invoice.

Additional Fee Negative

The data on negative additional fee applied to the specified product with recurring charge.

"key": "ADDITIONALFEENEGATIVE",
"label": "Additional Fee Negative"

  1. Go to Quick Links>New Basic Product and create a subscription product with a negative charge.
  2. Go to Products>Additional Fees, and click Add to create a new additional fee with the Product Applicability Level.
  3. Associate the additional fee with a product:
    • On the Additional Fee Details page, next to Fee Contribution Criteria, click Add and select the following Criteria TypeProduct.
    • On the Additional Fee Details page, next to Assessment Criteria, click Add and select the following Criteria TypeProduct. Then, to select the products that you want to associate with this additional fee, double-click the desired product in the Available pane on the left. Now, the products that you selected appear in the Selected pane on the right.
  4. Create an order for this product.
  5. Run the associated bill cycle.
  6. Approve the invoice.
Chargeback

The data on a payment reversal and cancel.

"key": "CHARGEBACK",
"label": "Chargeback"

  1. Go to Admin>Company>Payment Gateways and set the Stripe payment method.
  2. Go to Receivables>Accounting Transactions and process a Credit Card transaction.
  3. Go to Accounts>Account Search, find the needed account, click the account number. The Account Details page opens.
  4. In the Payments pane, next to the needed payment, click Change. The Add Payment Change window opens.
  5. In the Change field, select Cancel or Reverse.
Credit Adjustment Apply

The data on the credit adjustment applied to the invoice.

"key": "CREDITAPPLY",
"label": "Credit Adjustment Apply"

  1. Go to Accounts>Account Search, find the needed account and click the account number. The Account Details page opens.
  2. Scroll down to the Credit Adjustments pane, click Add, select the Adjustment Reason, enter the Amount of adjustment, Description, and the Effective Date, select the Manually Apply to Invoice check box, and then click Finish. You are redirected back to the Account Details page.
  3. In the Credit Adjustments pane, next to the needed adjustment, under Actions, click Post, and then click Yes to confirm posting the adjustment.
  4. Generate an invoice and approve it.
  5. On the Account Details page, in the Credit Adjustment pane, click the desired adjustment. On the Credit Adjustment page, click Add next to Applications, in the Add Application window, select the needed Invoice and Amount, and then click Finish.
  6. Now the credit adjustment is applied to the invoice. You can see in on the Account Details page, in the Invoices pane in the Amount To Pay column.
Credit Adjustment Negative

The data on the credit adjustment applied to the invoice resulting in a negative total.

"key": "CREDITNEGATIVE",
"label": "Credit Adjustment Negative"

  1. Go to Accounts>Account Search, find the needed account and click the account number. The Account Details page opens.
  2. Scroll down to the Credit Adjustments pane, click Add, select the Adjustment Reason, enter the negative Amount of adjustment, Description, and the Effective Date, do NOT select the Manually Apply to Invoice check box, and then click Finish. You are redirected back to the Account Details page. In the Credit Adjustment pane, next to the created adjustment, under Actions, click Post, and then click Yes to confirm posting the adjustment.
  3. Generate an invoice and approve it. Open the details on the invoice (PDF or HTML) and in the Credits Applied section see the amount of the adjustment applied.
Credit Adjustment One Time

The data on credit adjustment applied to the one-time product.

"key": "CREDITONETIME",
"label": "Credit Adjustment One Time"

  1. Go to Admin>Company>System Settings and set the Enable Service Adjustments in the UI parameter to true.
  2. Go to Quick Links>New Basic Product and create a one-time product.
  3. Create an order for this product and confirm it. The Account Details page opens.

  4. Scroll down to the One-Time Product Purchases pane and click the product name to display the One-Time Product Details page.

  5. Next to One-Time Product Adjustments, click Add and in the Add One-time Product Adjustment window, select the Adjustment Reason, enter One-Time Price Amount, enter the Description, Effective Date, and then click Finish.

 

Credit Adjustment Post

The data on the posted credit adjustment.

"key": "CREDITPOST",
"label": "Credit Adjustment Post"

 

  1. Go to Quick Links>New Basic Product and create a one-time or subscription product.
  2. Go to Accounts>Account Search, find the needed account and click the account number. The Account Details page opens.
  3. Scroll down to the Credit Adjustments pane, click Add, select the Adjustment Reason, enter the Amount, Description, select the Effective Date for the adjustment, and then click Finish. You are redirected back to the Account Details page.
  4. In the Credit Adjustment pane, next to the created adjustment, under Actions, click Post, and then click Yes to confirm posting the adjustment.
  5. The charge info data is collected once the adjustment is posted.
Credit Adjustment Recurring

The data on the recurring credit adjustment on a service.

"key": "CREDITRECURRING",
"label": "Credit Adjustment Recurring"

  1. Go to Admin>Company>System Settings and set the Enable Service Adjustments in the UI parameter to true.
  2. Go to Quick Links>New Basic Product and create a subscription product. Create an order for this product and confirm it. Now, you are redirected to the Account Details page.
  3. Scroll to the Services pane and click the name of the desired service. The Service Details page opens.
  4. Next to Service Adjustments, click Add and in the Add Service Adjustment window, select the Adjustment Reason, Service Price Amount, Description, Effective Date, and then click Finish.
Credit Adjustment Reverse

The data on the reversed credit adjustment.

"key": "CREDITREVERSE",
"label": "Credit Adjustment Reverse"

  1. Go to Accounts>Account Search, find the needed account and click the account number. The Account Details page opens.
  2. Scroll down to the Credit Adjustments pane, and click the number of the posted adjustment that you want to reverse. The Credit Adjustment page opens.
  3. Click Action and then click Reverse. In the Reverse Credit Adjustment window, select Adjustment Amount or Adjustment Unapplied Amount, and then click Finish.
  4. Once you reversed the applied balance of the credit, the collector creates the CreditReverse charge info data for the unapplied amount of the credit.
Credit Adjustment Tax

The data on tax applied to the credit adjustment on the invoice.

"key": "CREDITTAX",
"label": "Credit Adjustment Tax"

  1. Go to Admin>Company> System Settings and set the Enable Service Adjustment in the UI parameter to true.
  2. Go Setup>Charge Categories and make sure that the Adjustment category is taxable.

  3. Go to Setup>Reasons>Credit Adjustments Reasons and make sure the taxable Adjustment category is selected for Credit Adjustment Reason.

  4. Go to Accounts>Account Search, find the needed account and click the account number. The Account Details page opens.

  5. Scroll to the Services pane and click the name of the desired service. The Service Detail page opens.

  6. In the Service Adjustments pane, click Add, and in the Add Service Adjustment window, enter the Service Price Amount, click Calculate Tax, fill in the required fields, and then and click Finish.
  7. Note: Taxes are calculated according to the specified Effective Date on the Add Service Adjustment window.

  8. On the Service Detail page, in the Service Adjustment pane, click Post in the Actions column next to the created service adjustment.

Credit Adjustment Write Off

The data on the credit adjustment that was written off the invoice.

"key": "CREDITWRITEOFF",
"label": "Credit Adjustment Write Off"

  1. Go to Accounts>Account Search, find the needed account and click the account number. The Account Details page opens.
  2. Scroll down to the Credit Adjustments pane and click the number of the needed adjustment. In the Applications pane, find the credit adjustment that already has an invoice application. The Credit Adjustment page opens.
  3. Click Action and then click Reverse. In the Reverse Credit Adjustment window select Adjustment Amount and then click Finish.
  4. The collector creates the CreditWriteOff charge info data for the full amount of the credit and a CreditReverse charge info date for the amount of application that is being reversed.

Note: If you reverse the applied balance of the credit, the collector will create a CreditReverse charge info data for the unapplied amount of the credit.

Debit Adjustment

The data on the debit adjustment applied to the invoice.

"key": "DEBITADJUSTMENT",
"label": "Debit Adjustment"

  1. Go to Accounts>Account Search, find the needed account and click the account number. The Account Details page opens.
  2. Scroll down to the Debit Adjustments pane, click Add, select the Adjustment Reason, enter the Amount, Description, Effective Date for the adjustment, and then click Finish.
  3. Under Actions, click Post, and then click Yes to confirm posting the adjustment.
  4. The charge info data is collected once the adjustment is posted.
Debit Adjustment Reverse

The data on the debit adjustment applied to the invoice and then reversed.

"key": "DEBITADJUSTMENTREVERSE",
"label": "Debit Adjustment Reverse"

  1. Go to Accounts>Account Search, find the needed account and click the account number. The Account Details page opens.
  2. Scroll down to the Debit Adjustments pane and click the number of the posted adjustment that you want to reverse.
  3. To reverse the debit adjustment, under Actions, click Reverse next to the needed adjustment.
  4. The charge info data is collected once the adjustment is reversed.
Discount  

The data on the discount applied to the service.

"key": "DISCOUNT",
"label": "Discount"

  1. Go to Quick Links>New Basic Product and create a subscription product.
  2. Go to Products>Discounts>Discount Codes and click Add next to the Discount Code pane. The Add Discount Code window opens.
  3. Fill in the required fields and click Finish.
  4. To associate a discount code with a product:
    1. In the Discount Codes pane, next to the needed discount, under Actions, click Edit. The Edit Discount Code window opens.
    2. Scroll down and in the Products section, double-click the products that you want to associate with this discount code, and then click Finish.
  5. Create an order for this product including the discount code.
  6. The charge info data is collected once the order is confirmed.

Note: If the order has an approval action, the charge info record will be created when the order is approved (and therefore is active).

Discount Negative

The data on the discount applied to the negative recurring charge.

"key": "DISCOUNTNEGATIVE",
"label": "Discount Negative"

  1. Go to Quick Links>New Basic Product and create a subscription product with a negative charge.
  2. Go to Products>Discounts>Discount Codes and click Add next to the Discount Code pane. The Add Discount Code window opens.
  3. Fill in the required fields and click Finish.
  4. To associate a discount code with a product:
    1. In the Discount Codes pane, next to the needed discount, in the Actions column, click Edit. The Edit Discount Code window opens.

    2. Scroll down and in the Products section, double-click the products that you want to associate with this discount code, and then click Finish.

  5. Create an order for this product including the discount code.

  6. The charge info data is collected once the order is confirmed.

Note: If the order has an approval action, the charge info record will be created when the order is approved (and therefore is active).

Discount Negative

The data on the discount applied to the negative recurring charge.

"key": "DISCOUNTNEGATIVE",
"label": "Discount Negative"

  1. Go to Quick Links>New Basic Product and create a subscription product with a negative charge.
  2. Go to Products>Discounts>Discount Codes and click Add next to the Discount Code pane. The Add Discount Code window opens.
  3. Fill in the required fields and click Finish.
  4. To associate a discount code with a product:
    • In the Discount Codes pane, next to the needed discount, under Actions, click Edit. The Edit Discount Code window opens.
    • Scroll down and in the Products section, double-click the products that you want to associate with this discount code, and then click Finish.
  5. Create an order for this product including the discount code.
  6. The charge info data is collected once the order is confirmed.

Note: If the order has an approval action, the charge info record will be created when the order is approved (and therefore is active).

Invoice Discount Refund

The data on the refund of the discounted service.

"key": "INVOICEDISCOUNTREFUND",
"label": "Invoice Discount Refund"

  1. Go to Quick Links>New Basic Product and create a product with a recurring charge, selecting the Bill in Advance and Prorate on Cancel check boxes.
  2. Go to Products>Discounts>Discount Codes and click Add next to the Discount Code pane. The Add Discount Code window opens.
  3. Fill in the needed fields and click Finish.
  4. To associate a discount code with a product:
    1. In the Discount Codes pane, next to the needed discount, under Actions, click Edit. The Edit Discount Code window opens.
    2. Scroll down and in the Products section, double-click the products that you want to associate with this discount code, and then click Finish.
  5. Create an order for this product including the discount.
  6. Run the associated bill cycle for the first service period (it will invoice the first and second invoice periods).
  7. Deactivate the service within the second service period.
  8. Run the next bill cycle. In the next invoice, you will get the amount of discount refund.
Invoice Discount Refund Negative

The data on the refund of the service with a negative discount applied.

"key": "INVOICEDISCOUNTREFUNDNEGATIVE",
"label": "Invoice Discount Refund Negative"

  1. Go to Quick Links>New Basic Product and create a subscription product with a recurring charge, selecting the Bill in Advance and Prorate on Cancel check boxes.
  2. Go to Products>Discounts>Discount Codes and click Add next to the Discount Code pane. The Add Discount Code window opens.
  3. Fill in the needed fields, enter the negative discount amount, and then click Finish.
  4. To associate a discount code with a product:
    1. In the Discount Codes pane, next to the needed discount, under Actions, click Edit. The Edit Discount Code window opens.
    2. Scroll down and in the Products section, double-click the products that you want to associate with this discount code, and then click Finish.
  5. Create an order for this product including the discount.
  6. Run the associated bill cycle for the first service period (it will invoice the first and second invoice periods).
  7. Deactivate the service within the second service period.
  8. Run the next bill cycle. In the next invoice, you will get the amount of discount negative refund.
Invoice Refund

The data on the invoice refund.

"key": "INVOICEREFUND",
"label": "Invoice Refund"

  1. Go to Quick Links>New Basic Product and create a subscription product and select the Bill in Advance and Prorate on Cancel check boxes.
  2. Create an order for this product.
  3. Run the bill cycle for the first service period (it will invoice the first and second invoice periods).
  4. Deactivate the service within the second service period.
  5. Run the associated bill cycle. In the next invoice, you will get the amount of invoice refund.

Invoice Refund Negative

The data on the negative invoice refund.

"key": "INVOICEREFUNDNEGATIVE",
"label": "Invoice Refund Negative"

  1. Go to Quick Links>New Basic Product and create a subscription product with a negative charge and select the Bill in Advance and Prorate on Cancel check boxes.
  2. Create an order for this product.
  3. Run the bill cycle for the first service period (it will invoice the first and second invoice periods).
  4. Deactivate the service within the second service period.
  5. Run the associated bill cycle. In the next invoice, you will get the amount of invoice refund.
Manual Additional Fees

The data on additional fee applied to the specified product with recurring charge collected after the manual invoice has been created.

"key": "MANUALADDITIONALFEES",
"label": "Manual Additional Fees"

  1. Go to Quick Links>New Basic Product and create a subscription product with a positive charge.
  2. Go to Products>Additional Fees, and click Add to create a new additional fee with the Product Applicability Level.
  3. Associate the additional fee with a product:
    1. On the Additional Fee Details page, next to Fee Contribution Criteria, click Add and select the following Criteria TypeProduct.
    2. On the Additional Fee Details page, next to Assessment Criteria, click Add and select the following Criteria TypeProduct. Then, to select the products that you want to associate with this additional fee, double-click the desired product in the Available pane on the left. Now, the products that you selected appear in the Selected pane on the right.
  4. Create an order for this product.
  5. Run the associated bill cycle.
  6. Approve the invoice.
  7. From the original invoice, create one of manual invoice types: reverse, reissue, retax, or ad hoc.
Manual Additional Fees Negative

The data on negative additional fee applied to the specified product with recurring charge collected after the manual invoice has been created.

"key": "MANUALADDITIONALFEESNEGATIVE",
"label": "Manual Additional Fees Negative"

  1. Go to Quick Links>New Basic Product and create a product with a positive negative recurring charge.
  2. Go to Products>Additional Fees, and click Add to create a new additional fee with the Product Applicability Level.
  3. Create an order for this product.
  4. Run the associated bill cycle.
  5. Approve the invoice.
  6. From the original invoice, create one of manual invoice types: reverse, reissue, retax, or ad hoc.
Manual Debit Adjustment

The data on the debit adjustment applied to the invoice after the manual invoice has been created.

"key": "MANUALDEBITADJUSTMENT",
"label": "Manual Debit Adjustment"

 

  1. Go to Accounts>Account Search, find the needed account and click the account number. The Account Details page opens.
  2. Scroll down to the Debit Adjustments pane, click Add, select the Adjustment Reason, enter the Amount, Description, Effective Date for the adjustment, and then click Finish.
  3. In the Actions column, click Post.
  4. From the original invoice, create one of manual invoice types: reverse, reissue, retax, or ad hoc.
  5. The charge info data is collected once the adjustment is posted.
Manual Debit Adjustment Negative  

The data on the negative debit adjustment after the manual invoice has been created.

"key": "MANUALDEBITADJUSTMENTNEGATIVE",
"label": "Manual Debit Adjustment Negative"

  1. Go to Accounts>Account Search, find the needed account and click the account number. The Account Details page opens.
  2. Scroll down to the Debit Adjustments pane, click Add, select the Adjustment Reason, enter the negative Amount, Description, Effective Date for the adjustment, and then click Finish.
  3. Next to the needed adjustment, under Actions, click Post.
  4. From the original invoice, create one of manual invoice types: reverse, reissue, retax, or ad hoc.
Manual Discount  

The data on the discount applied to the subscription product after the manual invoice has been created.

"key": "MANUALDISCOUNT"
"label": "Manual Discount"

  1. Go to Quick Links>New Basic Product and create a subscription product.
  2. Go to Products>Discounts>Discount Codes and click Add next to the Discount Code pane. The Add Discount Code window opens.
  3. Fill in the needed fields and click Finish.
  4. To associate a discount code with a product:
    1. In the Discount Codes pane, next to the needed discount, in the Actions column, click b. The Edit Discount Code window opens.

    2. Scroll down and in the Products section, double-click the products that you want to associate with this discount code, and then click Finish.

  5. Create an order for this product including the discount code.
  6. From the original invoice, create one of manual invoice types: reverse, reissue, retax, or ad hoc.
Manual Discount Negative  

The data on the discount with the negative amount collected after the manual invoice has been created.

"key": "MANUALDISCOUNTNEGATIVE",
"label": "Manual Discount Negative"

 

  1. Go to Quick Links>New Basic Product and create a subscription product with a negative charge.
  2. Go to Products>Discounts>Discount Codes and click Add next to the Discount Code pane. The Add Discount Code window opens.
  3. Fill in the needed fields and click Finish.
  4. To associate a discount code with a product:
    1. In the Discount Codes pane, next to the needed discount, in the Actions column, click b. The Edit Discount Code window opens.

    2. Scroll down and in the Products section, double-click the products that you want to associate with this discount code, and then click Finish.

  5. Create an order for this product including the discount code.
Manula Invoice Ad hoc  

The data on manual ad hoc invoice.

"key": "MANUALINVOICEADHOC", "label": "Manual Invoice Adhoc"

  1. Create an order and generate an invoice.
  2. Based on the original invoice, create an ad hoc invoice with a positive amount. For more information about ad hoc invoices and how to create them, refer to the Ad Hoc Manual Invoices topic.
  3. The charge info data is collected once the manual invoice is created.
Manual Invoice Ad hoc Negative  

The data on the manual ad hoc invoice with the negative amount.

"key": "MANUALINVOICEADHOCNEGATIVE", "label": "Manual Invoice Adhoc Negative"

  1. Create an order and generate an invoice.
  2. Based on the original invoice, create an ad hoc invoice with the negative amount. For more information about ad hoc invoices and how to create them, refer to the Ad Hoc Manual Invoices topic.
  3. The charge info data is collected once the manual invoice is created.
Manual Invoice Discount Refund  

The data on the refund of the discounted service collected after the manual invoice has been created.

"key": "MANUALINVOICEDISCOUNTREFUND", "label": "Manual Invoice Discount Refund"

  1. Go to Quick Links>New Basic Product, create a subscription product and select the Bill in Advance and Prorate on Cancel check boxes.
  2. Go to Products>Discounts>Discount Codes and click Add next to the Discount Code pane. The Add Discount Code window opens.
  3. Fill in the needed fields and click Finish.
  4. To associate a discount code with a product, in the Discount Codes pane, next to the needed discount, under Actions, click Edit. The Edit Discount Code window opens. Now, scroll down and in the Products section, double-click the products that you want to associate with this discount code, and then click Finish.
  5. Create an order for this product including the discount code.
  6. Run the associated bill cycle for the first service period (it will invoice the first and second invoice periods).
  7. Deactivate the service within the second service period.
  8. Run the next bill cycle. In the next invoice, you will get the amount of discount refund.
  9. From the original invoice, create one of manual invoice types: reverse, reissue, retax, or ad hoc.
Manual Invoice Discount Refund Negative  

The data on the discount applied to the invoice with the negative amount collected after the manual invoice has been created.

"key": "MANUALINVOICEDISCOUNTREFUNDNEG",
"label": "Manual Invoice Discount Refund Negative"

  1. Go to Quick Links>New Basic Product create a subscription product and select the Bill in Advance and Prorate on Cancel check boxes.
  2. Go to Products>Discounts>Discount Codes and click Add next to the Discount Code pane. The Add Discount Code window opens.
  3. Fill in the needed fields and the negative discount amount and click Finish.
  4. To associate a discount code with a product, in the Discount Codes pane, next to the needed discount, under Actions,click Edit. The Edit Discount Code window opens.
  5. Scroll down and in the Products section, double-click the products that you want to associate with this discount code, and then click Finish.
  6. Create an order for this product including the discount.
  7. Run the associated bill cycle for the first service period (it will invoice the first and second invoice periods).
  8. Deactivate the service within the second service period.
  9. Run the next bill cycle. In the next invoice, you will get the amount of discount negative refund.
  10. From the original invoice, create one of manual invoice types: reverse, reissue, retax, or ad hoc.
Manual Invoice Refund  

The data on the invoice refund collected after the manual invoice has been created.

"key": "MANUALINVOICEREFUND",
"label": "Manual Invoice Refund"

 

  1. Go to Quick Links>New Basic Product and create a product with a recurring charge, selecting the Bill in Advance and Prorate on Cancel check boxes.
  2. Create an order for this product.
  3. Run the associated bill cycle for the first service period (it will invoice the first and second invoice periods).
  4. Deactivate the service within the second service period.
  5. Run the next bill cycle. In the next invoice, you will get the amount of invoice refund.
  6. From the original invoice, create one of manual invoice types: reverse, reissue, retax, or ad hoc.
Manual Invoice Refund Negative  

The data on the negative invoice refund collected after the manual invoice has been created.

"key": "MANUALINVOICEREFUNDNEGATIVE", "label": "Manual Invoice Refund Negative"

  1. Go to Quick Links>New Basic Product and create a product with a negative recurring charge, selecting the Bill in Advance and Prorate on Cancel check boxes.
  2. Create an order for this product.
  3. Run the associated bill cycle for the first service period (It will invoice the first and second invoice periods).
  4. Deactivate the service within the second service period.
  5. Run the next bill cycle. In the next invoice, you will get the amount of invoice refund.
  6. From the original invoice, create one of manual invoice types: reverse, reissue, retax, or ad hoc.
Manual One Time  

The data on the one-time charges collected after the manual invoice has been created.

"key": "MANUALONETIME",
"label": "Manual One Time"

  1. Go to Quick Links>New Basic Product and create a one-time product with the approval operation disabled.
  2. Create an order for this product.
  3. From the original invoice, create one of manual invoice types: reverse, reissue, retax, or ad hoc.
Manual One Time Negative  

The data on the negative one-time charge collected after the manual invoice has been created.

"key": "MANUALONETIMENEGATIVE",
"label": "Manual One Time Negative"

 

  1. Go to Quick Links>New Basic Product and create a one-time product with a negative charge and the approval operation disabled.
  2. Order the product.
  3. From the original invoice, create one of manual invoice types: reverse, reissue, retax, or ad hoc.

Note: If the order has an approval action, the charge info data is created when the order is approved (and therefore is active).

Manual Recurring  

The data on the recurring charges collected after the manual invoice has been created.

"key": "MANUALRECURRING",
"label": "Manual Recurring"

  1. Go to Quick Links>New Basic Product and create a subscription product with no approval action.
  2. Create an order for this product.
  3. Generate an invoice.
  4. From the original invoice, create one of manual invoice types: reverse, reissue, retax, or ad hoc.

Note: If order has an approval action, the charge info data is created when the order is approved (and is therefore is active).

Manual Recurring Negative  

The data on the recurring negative charge.

"key": "MANUALRECURRINGNEGATIVE", "label": "Manual Recurring Negative"

 

  1. Go to Quick Links>New Basic Product and create a subscription product with negative charge and no approval action.
  2. Create an order for this product.
  3. Generate an invoice.
  4. From the original invoice, create one of manual invoice types: reverse, reissue, retax, or ad hoc.

Note: If order has an approval action, the charge info data is created when the order is approved (and is therefore is active).

Manual Scheduled  

The data on the invoiced scheduled charged collected after the manual invoice has been created.

"key": "MANUALSCHEDULED",
"label": "Manual Scheduled"

  1. Go to Quick Links>New Basic Product and create a one-time or subscription product.
  2. On the Product Details page, in the Standard Prices pane, click Action, and then click Create One-Time Charge Price.
  3. In the Manage One-Time Charge Price window, select the Require Scheduled Charges check box, select the needed currency, enter the Price, and then click Finish.
  4. Create an order for this product, next to the product, click Add Scheduled Charges and specify the prices.
  5. Run the associated bill cycle so that at least one of the scheduled charges falls into the billing period.
  6. From the original invoice, create one of manual invoice types: reverse, reissue, retax, or ad hoc.
Manual Scheduled Negative  

The data on the negative scheduled charges collected after the manual invoice has been created.

"key": "MANUALSCHEDULEDNEGATIVE", "label": "Manual Scheduled Negative"

  1. Go to Quick Links>New Basic Product and create a one-time or subscription product with negative charge.
  2. On the product details page, in the standard prices pane, click Action, and then click Create One-Time Charge Price.
  3. In the Manage One-Time Charge Price window, select the Require Scheduled Charges check box, select the needed currency, enter the Price, and then click Finish.
  4. Create an order for this product, next to the product, click Add Scheduled Charges and specify the prices.
  5. Run the associated bill cycle so that at least one of the scheduled charges falls into the billing period.
  6. From the original invoice, create one of manual invoice types: reverse, reissue, retax, or ad hoc.
Manual Tax  

The data on taxes applied to recurring or one-time charges collected after the manual invoice has been created.

"key": "MANUALTAX",
"label": "Manual Tax"

 

  1. Go to Quick Links>New Basic Product and create a one-time or subscription product and select the Taxable check box.
  2. Associate the product with a taxable Price charge category.
  3. Go to Admin>Integration>Tax Processors and set up a tax processor.
  4. Create an order for this product.
  5. Run the associated bill cycle for the first service period.
  6. From the original invoice, create one of manual invoice types: reverse, reissue, retax, or ad hoc.
Manual Tax Negative  

The data on taxes applied to negative recurring or one-time charges collected after the manual invoice has been created.

"key": "MANUALTAXNEGATIVE",
"label": "Manual Tax Negative"

  1. Go to Quick Links>New Basic Product and create a one-time product with a negative charge and select the Taxable check box.
  2. Associate the product with a taxable Price charge category.
  3. Go to Admin>Integration>Tax Processors and set up a tax processor.
  4. Run the associated bill cycle for the first service period.
  5. From the original invoice, create one of manual invoice types: reverse, reissue, retax, or ad hoc.
Manual Tax Refund  

The data on taxes applied to the recurring charge and refunded, it’s collected after the manual invoice has been created.

"key": "MANUALTAXREFUND",
"label": "Manual Tax Refund"

  1. Go to Quick Links>New Basic Product, create a subscription product. In the New Product window, fill in the required fields, select the Bill in Advance, Prorate on Cancel, and Taxable check boxes, and then click Finish.
  2. Associate the product with a taxable Price charge category.
  3. Go to Admin>Integration>Tax Processors and set up a tax processor.
  4. Create an order for this product.
  5. Run the bill cycle for the first service period (it will invoice the first and second service periods).
  6. Deactivate the service within the second service period.
  7. Run the associated bill cycle.
  8. From the original invoice, create one of manual invoice types: reverse, reissue, retax, or ad hoc.
Manual Tax Refund Negative  

The data on taxes applied to the subscription product with negative charge that is collected after the manual invoice is created.

"key": "MANUALTAXREFUNDNEGATIVE", "label": "Manual Tax Refund Negative"

  1. Go to Quick Links>New Basic Product and create a subscription product. In the New Product window, fill in the required fields, enter the negative price, select the Bill in Advance, Prorate on Cancel, and Taxable check boxes, and then click Finish.
  2. Associate the product with a taxable Price charge category.
  3. Go to Admin>Integration>Tax Processors and set up a tax processor.
  4. Create an order for this product.
  5. Run the bill cycle for the first service period (it will invoice the first and second service periods).
  6. Deactivate the service within the second service period.
  7. Run the associated bill cycle.
  8. From the original invoice, create one of manual invoice types: reverse, reissue, retax, or ad hoc.
Manual Usage  

The data on positive usage charges on the subscription product that is collected after the manual invoice has been created.

"key": "MANUALUSAGE",
"label": "Manual Usage"

  1. Go to Quick Links>New Basic Product and create a subscription product.
  2. On the Product Details page, click Action, and then click Edit next to the name of the product. The Edit Product window opens.
  3. Scroll down and fill in the following fields:
    • Identifier Category: select the needed service resource category from the list or create a new one by clicking the Add button.
    • Minimum Identifiers: enter the minimum identifier number.
    • Maximum Identifiers: enter the maximum identifier number.
  4. Go to Rating & Billing>Usage Rules. To create a new rule, click Add.
  5. Create an order for this product and next to the product name, click Set Service Resource Identifier. The Subscription Configuration window opens.
  6. Select the Selection Method, enter Service Identifiers, and then click Finish.
  7. Submit usage records that result in a positive usage amount (on invoice item charge table).
  8. Run the associated bill cycle.
  9. From the original invoice, create one of manual invoice types: reverse, reissue, retax, or ad hoc.
  10. Once the ProcessChargeInformationQuartzJob is completed the charge info data is collected.
Manual Usage Negative  

The data on negative usage charges on the subscription product that is collected after the manual invoice has been created.

"key": "MANUALUSAGENEGATIVE",
"label": "Manual Usage Negative"

  1. Go to Quick Links>New Basic Product and create a subscription product.
  2. On the Product Details page, click Action, and then click Edit next to the name of the product. The Edit Product window opens.
  3. Scroll down and fill in the following fields:
    • Identifier Category: select the needed service resource category from the list or create a new one by clicking the Add button.
    • Minimum Identifiers: enter the minimum identifier number.
    • Maximum Identifiers: enter the maximum identifier number.
    • Identifier Category: select the needed service resource category from the list or create a new one by clicking the Add button.
    • Minimum Identifiers: enter the minimum identifier number.
    • Maximum Identifiers: enter the maximum identifier number.
  4. Create an order for this product and next to the product name, click Set Service Resource Identifier. The Subscription Configuration window opens.

  5. Select the Selection Method, enter Service Identifiers, and then click Finish.

  6. Submit usage records that result in a negative usage amount (on invoice item charge table).

  7. Run the associated bill cycle.

  8. From the original invoice, create one of manual invoice types: reverse, reissue, retax, or ad hoc.

  9. Once the ProcessChargeInformationQuartzJob is completed the charge info data is collected.

One Time  

The data on the one-time charges.

"key": "ONETIME",
"label": "One Time"

  1. Go to Quick Links>New Basic Product and create a one-time product.
  2. Create an order for this product.

Note: If the product has an approval operation enabled, the charge info data is collected after the order is approved (and therefore is active).

One Time Negative  

The data on the negative one-time charge.

"key": "ONETIMENEGATIVE",
"label": "One Time Negative"

  1. Go to Quick Links>New Basic Product and create a one-time product with a negative charge.
  2. Create an order for this product.

Note: If the product has an approval operation enabled, the charge info data is collected after the order is approved (and therefore is active).

Payment  

The data on the executed payment.

"key": "PAYMENT",
"label": "Payment"

  1. Go to Accounts>Account Search, find the needed account, and click the account number.
  2. On the Account Details page, in the Payments pane, click Execute Payment. In the Manual Payment window, fill in all required fields, and then click Finish.
  3. The charge info data is collected once the payment is executed.

Payment Apply  

The data on the payment applied to an invoice.

"key": "PAYMENTAPPLY",
"label": "Payment Apply"

  1. Go to Accounts>Account Search, find the needed account, and click the account number.
  2. On the Account Details page, in the Payments pane, click the ID of the payment. The Payment Details page opens.
  3. Scroll down to the Payment Applications pane and click Add. In the Add Payment Application window, fill in all required fields, and then click Finish.
  4. Once the payment is applied to a certain invoice, the charge info data is collected.
Payment Cancel  

The data on the canceled payment.

"key": "PAYMENTCANCEL",
"label": "Payment Cancel"

  1. Go to Accounts>Account Search, find the needed account, and click the account number.
  2. On the Account Details page, in the Payments pane, click the ID of the payment. The Payment Details page opens.
  3. Scroll down to the Payment Applications pane and click Add. In the Add Payment Application window, fill in all required fields, and then click Finish.
  4. On the Account Details page, in the Payments pane, click Change next to the needed payment. The Add Payment Change window opens. 5. In the Add Payment Change window, select one of the following options and enter the following:
    • Change: select Cancel.
    • Change Reason: select the needed reason from the list or create a new one by clicking Add.
    • Payment Note: enter the additional information on payment cancelation.
    • Change On: enter the date when cancelation should be applied.
    • Click Finish.
  5. The charge info data is collected once the payment is canceled.
Payment Partial Cancel  

The data on the payment that was partly canceled.

"key": "PAYMENTPARTIALCANCEL",
"label": "Payment Partial Cancel"

  1. Go to Admin>Company>System Settings, and set the Partial Cancel Enabled parameter to true.
  2. On the Account Details page, in the Payments pane, click Change next to the needed payment. The Add Payment Change window opens.
  3. In the Add Payment Change window, select one of the following options and enter the following:
    • Change: select Cancel Unapplied Amount.
    • Change Reason: select the needed reason from the list or create a new one by clicking Add.
    • Payment Note: enter the additional information on payment cancelation.
    • Change On: enter the date when the payment should be canceled.
    • Click Finish.
  4. The charge info data is collected once the payment is canceled.
Payment Reverse  

The data on the reversed payment.

"key": "PAYMENTREVERSE",
"label": "Payment Reverse"

 

  1. Go to Accounts>Account Search, find the needed account, and click the account number.
  2. On the Account Details page, in the Payments pane, click Change next to the needed payment. The Add Payment Change window opens.
  3. In the Add Payment Change window, select one of the following options and enter the following:
    • Change: select Reverse.
    • Change Reason: select the needed reason from the list or create a new one by clicking Add.
    • Payment Note: enter the additional information on payment cancelation.
    • Reverse On: enter the date when reversal should be applied.
    • Click Finish.
  4. The charge info data is collected once the payment is reversed.
Pending Recurring  

The data on the charges for one-time or subscription products with the approval operation enabled that is collected before the order is approved.

"key": "PENDINGRECURRING",
"label": "Pending Recurring"

  1. Go to Quick Links>New Basic Product and create a one-time or subscription product.
  2. On the product details page, in the Actions pane, click New Product Sale. The Action Configuration page opens.
  3. On the Approval Operation pane, click Edit. The Configure Required Approvals window opens. Select the Enabled check box, and then click Finish.
  4. Create an order for this product.
  5. The charge info data is collected until the order is approved.
Prepaid Expired Contribution  

The data on the prepaid balance that was not used due to the expired period.

"key": "PREPAIDEXPIREDCONTRIBUTION",
"label": "Prepaid Expired Contribution"

  1. Go to Quick Links>New Basic Product and create a one-time product.
  2. In the Additional Product parameters, specify the following:
    • Select the Fund Prepaid Balance check box.
    • Select the Expiring Contribution check boxes.
    • In the Expiration Duration Quantity field, enter the number of days the prepaid balance can be used.
  3. Once the contribution period ends with the balance not used, the charge info data is collected.
Recurring  

The data on the recurring charges.

"key": "RECURRING",
"label": "Recurring"

  1. Go to Quick Links>New Basic Product and create a subscription product with no approval action.
  2. Create an order for this product.
  3. The charge info data is collected once the order is confirmed.
Recurring Negative  

The data on the recurring negative charge.

"key": "RECURRINGNEGATIVE",
"label": "Recurring Negative"

  1. Go to Quick Links>New Basic Product and create a subscription product with a negative charge and no approval action.
  2. Create an order for this product.
  3. The charge info data is created once the order is confirmed.
Refund  

The data on the credit or debit payment refund.

"key": "REFUND",
"label": "Refund"

  1. Go to Accounts>Account Search, find the needed account, and then click the account number.
  2. On the Account Details page, in the Payments pane, click Execute Payment.
  3. In the Manual Payment window, select Credit Card payment method and in the Change field, select Refund and fill in the following fields:
    • Change Reason: select a reason for the change.
    • Amount: the amount of the refund.
    • Payment Note: the additional information about the transaction.
  4. The charge info data is collected once the refund is complete.
Scheduled  

The data on the invoiced scheduled charged.

"key": "SCHEDULED",
"label": "Scheduled"

  1. Go to Quick Links>New Basic Product and create a one-time product.
  2. On the product details page, in the standard prices pane, click Action, and then click Create One-Time Charge Price.
  3. In the Manage One-Time Charge Price window, select the Require Scheduled Charges check box.
  4. Run bill cycle so that at least one of the scheduled charges falls into the billing period.
  5. This charge info data is collected only for the invoiced scheduled charges.
Scheduled Negative  

The data on invoiced negative scheduled charges.

"key": "SCHEDULEDNEGATIVE",
"label": "Scheduled Negative"

  1. Go to Quick Links>New Basic Product and create a one-time product with a negative charge.
  2. On the product details page, in the standard prices pane, click Action, and then click Create One-Time Charge Price.
  3. In the Manage One-Time Charge Price window, select the Require Scheduled Charges check box.
  4. Run the bill cycle so that at least one of the scheduled charges falls into the billing period.
  5. This charge info data is collected only for the invoiced scheduled charges.
Tax  

The data on taxes applied to recurring or one-time charges.

"key": "TAX",
"label": "Tax"

  1. Go to Quick Links>New Basic Product and create a subscription or one-time product, and select the Taxable check box.
  2. Associate the product with the taxable Price charge category.
  3. Go to Admin>Integration>Tax Processors and set up a tax processor.
  4. Create an order for this product.
  5. Run the bill cycle for the first service period.
Tax Negative  

The data on taxes applied to the negative recurring or one-time charges.

"key": "TAXNEGATIVE",
"label": "Tax Negative"

  1. Go to Quick Links>New Basic Product and create a subscription or one-time product with a negative charge and select the Taxable check box.
  2. Associate the product with the taxable Price charge category.
  3. Go to Admin>Integration>Tax Processors and set up a tax processor.
  4. Create an order for this product.
  5. Run the bill cycle for the first service period.
Tax Refund  

The data on taxes applied to the subscription product collected after the charge is refunded.

"key": "TAXREFUND",
"label": "Tax Refund"

  1. Go to Quick Links>New Basic Product and create a subscription product, and select the Bill in Advance, Prorate on Cancel, and Taxable check boxes.
  2. Associate the product with the taxable Price charge category.
  3. Go to Admin>Integration>Tax Processors and set up a tax processor.
  4. Create an order for this product.
  5. Run the bill cycle for the first service period (it will invoice the first and second service periods).
  6. Deactivate the service within the second service period.
  7. Run the next bill cycle.
Tax Refund Negative  

The data on taxes applied to the subscription product with the negative charge collected after the refund.

"key": "TAXREFUNDNEGATIVE",
"label": "Tax Refund Negative"

  1. Go to Quick Links>New Basic Product and create a subscription product with a negative charge, and select the Bill in Advance, Prorate on Cancel, and Taxable check boxes.
  2. Associate the product with the taxable Price charge category.
  3. Go to Admin>Integration>Tax Processors and set up a tax processor.
  4. Create an order for this product.
  5. Run the bill cycle for the first service period (it will invoice the first and second service periods).
  6. Deactivate the service within the second service period.
  7. Run the next bill cycle.
Unbilled Activity  

The data on the unbilled activity, meaning the usage not included in the last generated invoice.

"key": "UNBILLEDACTIVITY",
"label": "Unbilled Activity"

  1. With Billing API, send usage to a service without generating an invoice. You can use the following endpoint:
    POST /usage-events/bulk
    For more information refer to the Billing API documentation on Usage Events.
  2. Set the Accounting - posting for unbilled activities system parameter to Daily_Roll_Up.
  3. Once the ProcessUnbilledUsageQuartzJob is completed, the charge info data is collected. This aggregates usage data since the last invoice.
Unbilled Activity Daily  

The data on unbilled charges aggregated for a day.

"key": "UNBILLEDACTIVITYDAILY",
"label": "Unbilled Activity Daily"

  1. With Billing API, send usage to a service without generating an invoice. You can use the following endpoint:
    POST usage-events/bulk
    For more information refer to the Billing API documentation on Usage Events.
  2. Set the Accounting - posting for unbilled activities system parameter to Daily.
  3. Once the ProcessUnbilledUsageQuartzJob is completed, the charge info data is collected. This aggregates usage data for one day every time the invoice is not generated.

Note: Use this system parameter only if the usage will never be voided or deleted.

Unbilled Activity Daily Negative  

The data on unbilled negative charges aggregated for a day.

"key": "UNBILLEDACTIVITYDAILYNEGATIVE",
"label": "Unbilled Activity Daily Negative"

  1. With Billing API, send usage to a service without generating an invoice. You can use the following endpoint:
    POST usage-events/bulk
    For more information refer to the Billing API documentation on Usage Events.
  2. Set the Accounting - posting for unbilled activities system parameter to Daily.
  3. Once the ProcessUnbilledUsageQuartzJob is completed, the charge info data is collected. This aggregates usage data for one day every time the invoice is not generated.

Note: Use this system parameter only if the usage will never be voided or deleted.

Unbilled Activity Negative  

The data on the unbilled activity resulting in a negative amount.

"key": "UNBILLEDACTIVITYNEGATIVE",
"label": "Unbilled Activity Negative"

  1. With Billing API, send usage to a service without generating an invoice. You can use the following endpoint:
    POST usage-events/bulk
    For more information refer to the Billing API documentation on Usage Events.
  2. Set the Accounting - posting for unbilled activities system parameter to Daily_Roll_Up.
  3. Once the ProcessUnbilledUsageQuartzJob is completed, the charge info data is collected. This aggregates usage data since the last invoice.
Unbilled Activity Reverse  

The data on the reversed unbilled charges.

"key": "UNBILLEDACTIVITYREVERSE",
"label": "Unbilled Activity Reverse"

  1. Set the Accounting - posting for unbilled activities system parameter to Daily_Roll_Up.
  2. Wait until the ProcessUnbilledUsageQuartzJob is completed. The charge info data for the Unbilled activity is created.
  3. Wait for one day without generating an invoice.
  4. Wait until the ProcessUnbilledUsageQuartzJob is completed, the charge info data is collected.
Unbilled Activity Reverse Negative  

The data on the unbilled negative charges collected after the reverse.

"key": "UNBILLEDACTIVITYREVERSENEGATIVE",
"label": "Unbilled Activity Reverse Negative"

  1. With Billing API, send negative usage to a service without generating an invoice. You can use the following endpoint:
    POST usage-events/bulk
    For more information refer to the Billing API documentation on Usage Events.
  2. Set the Accounting - posting for unbilled activities system parameter to Daily_Roll_Up.
  3. Wait until the ProcessUnbilledUsageQuartzJob is completed. The charge info data for the Unbilled activity is created. Wait for one day without generating an invoice.
  4. Wait until the ProcessUnbilledUsageQuartzJob is completed, the charge info data is collected.
Usage  

The data on positive usage charges.

"key": "USAGE",
"label": "Usage"

  1. Go to Quick Links>New Basic Product and create a subscription product.
  2. On the product details page, click Action, and then click Edit next to the name of the product. The Edit Product window opens.
  3. Scroll down and fill in the following fields:
    • Identifier Category: select the needed service resource category from the list or create a new one by clicking the Add button.
    • Minimum Identifiers: enter the minimum identifier number.
    • Maximum Identifiers: enter the maximum identifier number.
  4. Go to Rating & Billing>Usage Rules. To create a new rule, click Add.
  5. Create an order for this product and next to the product name, click Set Service Resource Identifier. The Subscription Configuration window opens.
  6. Select the Selection Method, enter Service Identifiers, and then click Finish.
  7. Submit usage records that result in a positive usage amount (on invoice item charge table).
  8. Run bill cycle.
  9. Once the ProcessChargeInformationQuartzJob is completed the charge info data is collected.
Usage Negative  

The data on negative usage charges.

"key": "USAGENEGATIVE",
"label": "Usage Negative"

  1. Go to Quick Links>New Basic Product and create a subscription product.
  2. On the product details page, click Action, and then click Edit next to the name of the product. The Edit Product window opens.
  3. Scroll down and fill in the following fields:
    • Identifier Category: select the needed service resource category from the list or create a new one by clicking the Add button.
    • Minimum Identifiers: enter the minimum identifier number.
    • Maximum Identifiers: enter the maximum identifier number.
  4. Go to Rating & Billing>Usage Rules. To create a new rule, click Add.
  5. Create an order for this product and next to the product name, click Set Service Resource Identifier. The Subscription Configuration window opens.
  6. Select the Selection Method, enter Service Identifiers, and then click Finish.
  7. Submit usage records that result in a negative usage amount (on invoice item charge table).
  8. Run bill cycle.
  9. Once the ProcessChargeInformationQuartzJob is completed the charge info data is collected.
Usage Prepaid  

The data on usage prepaid amount.

"key": "USAGEPREPAID",
"label": "Usage Prepaid"

  1. Go to Quick Links>New Basic Product and create a subscription product with the Consume Prepaid Balance and Register Type selected.
  2. On the product details page, click Action, and then click Edit next to the name of the product. The Edit Product window opens.
  3. Scroll down and fill in the following fields:
    • Identifier Category: select the needed service resource category from the list or create a new one by clicking the Add button.
    • Minimum Identifiers: enter the minimum identifier number.

    • Maximum Identifiers: enter the maximum identifier number.

  4. Create a one-time product with the following configurations:
    • Select the Fund Prepaid Balance check box.

    • Register Type: select the same register type as the one of a subscription product that we created earlier.

    • Granted Value: enter the granted value of the product.

    • One-Time Price (order amount): enter the product price.
  5. Go to Rating & Billing>Usage Rules, and click Add to create a new usage rule for the subscription product.

  6. Create an order for subscription and one-time products. For the subscription product, set the Service Resource Identifier.

  7. Submit usage records that result in a positive usage amount.

  8. Once the ProcessChargeInformationQuartzJob is completed the charge info date is collected.

Note: The Charge Info Table displays the usage prepaid charge amount which depends on following coefficient: Price (order amount)/Granted Value.

Usage Prepaid Negative  

The data on usage prepaid amount with the negative charge.

"key": "USAGEPREPAIDNEGATIVE",
"label": "Usage Prepaid Negative"

 

  1. Go to Quick Links>New Basic Product and create a subscription product with the Consume Prepaid Balance and Register Type selected.
  2. On the product details page, click Action, and then click Edit next to the name of the product. The Edit Product window opens.
  3. Scroll down and fill in the following fields:
  • Maximum Identifiers: enter the maximum identifier number.
  1. Create a one-time product with the following configurations:
  • Fund Prepaid Balance: select this check box.
  • Register Type: select the same as the one of a subscription product that we created earlier.
  • Granted Value: enter the granted value of the product.
  • One-Time Price (order amount): enter the product price.
  1. Go to Rating & Billing>Usage Rules, and click Add to create a new usage rule for the subscription product.
  2. Create an order for subscription and one-time products. For the subscription product, set the Service Resource Identifier.

  3. Submit usage records that result in a negative usage amount.

  4. Once the ProcessChargeInformationQuartzJob is completed the charge info date is collected.

Note: The Charge Info Table displays the usage prepaid charge amount which depends on following coefficient: Price (order amount)/Granted Value.

   
Top