Page Notifications Off
Share page
  1. Zuora Knowledge Center
  2. How Do I . . . ?
  3. How do I understand the user actions in Payment Operations so I can build a test plan or plan an integration?
Was this article helpful?

How do I understand the user actions in Payment Operations so I can build a test plan or plan an integration?

Modified 23:34, 29 Dec 2011 by Neal Kaplan | Page History
  1. 1. Overview
  2. 2. Solution
    1. 2.1. Payment Operations
    2. 2.2. Use Cases by Operation
  3. 3. Related

Overview

Zuora's Payment Operations is our way to manage your invoice to cash process, or Accounts Receivable.

  • If you are creating a test plan, it would be helpful to have a list of actions that can be performed in Payment Operations so that you can build a comprehensive test plan.
  • If you are performing a custom integration where you want to provide an advanced customer self-service actions, it would be helpful to have a list of actions that can be performed in Payment Operations so that you can determine which actions make sense for your end customers.
  • If you are performing an accounting integration using Zuora's data, it would be helpful to understand all of the actions that a user can perform in Payment Operations, so that you can define your integration process accordingly.

We've got you covered. This topic provides a high-level list of actions that a user can perform with the key permutations that are possible in Zuora. 

Solution

To understand the use cases for Payment Operations, there are two key things to understand: The definition of the high level operations and the use cases for the operations. See How do I understand the "Invoice to Cash" business processes that Payment Operations supports? for more information about the Invoice to Cash Business Process for Payment Operations.

Payment Operations

We have grouped the use cases or user actions by high level operation:

  • Process a Payment: When you process a payment, you can identify whether it is external or electronic. An Electronic Payment means that a call to the Payment Gateway will be performed and an external payment means you are recording that a payment occurred in another system. You can create a payment for one or more invoices and/or to the Credit Balance.
  • Adjust Invoice Charges: This creates one-to-many invoice item adjustments. An Invoice Item Adjustment can be positive or negative and is tied to the invoice item, so it uses the Accounting Code and the Service Period from the Invoice Item.
  • Create Invoice Adjustment: An Invoice Adjustment can be positive or negative and can have its own Accounting Code.
  • Transfer to Credit Balance: This operation is used to transfer a negative invoice to the Credit Balance. The Credit Balance Adjustment is applied to the invoice and impacts the Credit Balance.
  • Apply Credit Balance: This operation is used to transfer funds from the credit balance to a positive invoice. The Credit Balance Adjustment is applied to the invoice and impacts the Credit Balance.
  • Refund a Payment: In Zuora, you can create a refund either externally or electronically. An electronic refund means that a call to the Payment Gateway will be performed to refund a specific payment or an external refund is used to reflect that a refund has occurred in another system such as by check.
  • Refund the Credit Balance: You can issue a refund of the Credit Balance either electronically or externally.  When an electronic refund is performed, it is a non-referenced refund where the refund is not applied to a specific payment, but rather the credit card.  An external refund is used to reflect that a refund was made in another system, which could be an Accounts Payable process.  Note: Non-referenced refunds are available via specific gateways.

Use Cases by Operation

We have defined 84 use cases for Payment Operations that can kick-start the process to thinking about test planning or more complex accounting integration.

 

Operation Use Cases
Generate an Invoice
  1. Positive Invoice with one or more positive invoice items
  2. Positive Invoice with one or more positive invoice items AND tax items
  3. Positive Invoice with one or more positive invoice items AND negative invoice items
  4. Positive Invoice with one or more positive invoice items AND discount invoice items
  5. Negative Invoice with one or more negative invoice items
  6. Negative Invoice with one or more negative invoice items AND tax items
  7. Negative Invoice with one or more negative invoice items AND positive invoice items
  8. Negative Invoice with one or more negative invoice items AND positive invoice items AND discount invoice items
Process a Payment
  1. Full External Payment against a single invoice
  2. Partial External Payment against a single invoice
  3. Full External Payment against multiple invoices
  4. Partial External Payment against multiple invoices
  5. External Payment applied to one or more invoices and the credit balance
  6. External Payment applied to only the credit balance
  7. Full Electronic Payment against a single invoice
  8. Partial Electronic Payment against a single invoice
  9. Full Electronic Payment against multiple invoices
  10. Partial Electronic Payment against multiple invoices
  11. Electronic Payment applied to one or more invoices and the credit balance
  12. Electronic Payment applied to only the credit balance
Cancel a Payment
  1. Cancel an External Payment applied to a single invoice
  2. Cancel an External  Payment applied to multiple invoices
  3. Cancel an External  Payment applied to Invoices and a Credit Balance Adjustment
  4. Cancel an External  Payment applied to the Credit Balance Adjustment only
  5. Cancel (void) an Electronic Payment applied to a single invoice
  6. Cancel (void) an Electronic Payment applied to multiple invoices
  7. Cancel (void) an Electronic Payment applied to an Invoice(s) and a Credit Balance Adjustment
  8. Cancel (void) an Electronic Payment applied to the Credit Balance Adjustment only
Adjust Invoice Items
  1. Full Invoice Item Adjustment (Credit Type) for a positive invoice for a positive charge
  2. Full Invoice Item Adjustment (Credit Type) for a positive invoice for a negative charge
  3. Full Invoice Item Adjustment (Credit Type) for a negative invoice for a positive charge
  4. Full Invoice Item Adjustment (Credit Type) for a negative invoice for a negative charge
  5. Full Invoice Item Adjustment (Charge Type) for a positive invoice for a positive charge
  6. Full Invoice Item Adjustment (Charge Type) for a positive invoice for a negative charge
  7. Full Invoice Item Adjustment (Charge Type) for a negative invoice for a positive charge
  8. Full Invoice Item Adjustment (Charge Type) for a negative invoice for a negative charge
  9. Partial Invoice Item Adjustment (Credit Type) for a positive invoice for a positive charge
  10. Partial Invoice Item Adjustment (Credit Type) for a positive invoice for a negative charge
  11. Partial Invoice Item Adjustment (Credit Type) for a negative invoice for a positive charge
  12. Partial Invoice Item Adjustment (Credit Type) for a negative invoice for a negative charge
  13. Partial Invoice Item Adjustment (Charge Type) for a positive invoice for a positive charge
  14. Partial Invoice Item Adjustment (Charge Type) for a positive invoice for a negative charge
  15. Partial Invoice Item Adjustment (Charge Type) for a negative invoice for a positive charge
  16. Partial Invoice Item Adjustment (Charge Type) for a negative invoice for a negative charge
Create Invoice Adjustment
  1. Invoice Adjustment (Credit Type) for a positive invoice that decreases the invoice balance (for example, makes less positive)
  2. Invoice Adjustment (Credit Type) for a negative original invoice that decreases the invoice balance (for example, makes more negative) *
  3. Invoice Adjustment (Charge Type) for a negative invoice that increases the invoice balance (for example, make less negative)
  4. Invoice Adjustment (Charge Type) for a positive invoice that increases the invoice balance (for example, make more positive) *
Cancel this Invoice Item Adjustment
  1. Invoice Item Adjustment is a Charge Type
  2. Invoice Item Adjustment is a Credit Type
Cancel this Invoice Adjustment
  1. Invoice Adjustment is a Charge Type
  2. Invoice Adjustment is a Credit Type
Transfer to Credit Balance
  1. Transfer the full invoice balance to the Credit Balance
  2. Transfer the partial invoice balance to the Credit Balance
Apply Credit Balance
  1. Apply Credit Balance for the full invoice balance
  2. Apply Credit Balance for a partial invoice balance 
Cancel the Credit Balance Adjustment
  1. Cancel Credit Balance Adjustment that was applied to an invoice
  2. Cancel Credit Balance Adjustment that was transferred to the Credit Balance
Refund a Payment
  1. External Refund the full amount of a payment applied to a single invoice
  2. External Refund the full amount of a payment applied to multiple invoices
  3. External Refund the full amount of a payment applied to the Credit Balance and one or more invoices
  4. External Refund the full amount of a payment applied only to the Credit Balance
  5. External Refund the partial amount of a payment applied to a single invoice
  6. External Refund the partial amount of a payment applied to multiple invoices
  7. External Refund the partial amount of a payment applied to the Credit Balance and one or more invoices
  8. External Refund the partial amount of a payment applied only to the Credit Balance
  9. Electronic Refund the full amount of a payment applied to a single invoice
  10. Electronic Refund the full amount of a payment applied to multiple invoices
  11. Electronic Refund the full amount of a payment applied to the Credit Balance and one or more invoices
  12. Electronic Refund the full amount of a payment applied only to the Credit Balance
  13. Electronic Refund the partial amount of a payment applied to a single invoice
  14. Electronic Refund the partial amount of a payment applied to multiple invoices
  15. Electronic Refund the partial amount of a payment applied to the Credit Balance and one or more invoices
  16. Electronic Refund the partial amount of a payment applied only to the Credit Balance
Refund the Credit Balance
  1. Refund the Credit Balance with an External Refund Type
  2. Refund the Credit Balance with an Electronic Refund Type
Cancel the Refund
  1. Cancel an External Refund that has been applied to a payment that has been applied to a single invoice
  2. Cancel an External Refund that has been applied to a payment that has been applied to multiple invoices
  3. Cancel an External Refund that has been applied to a Payment that has been applied to Invoices and a Credit Balance Adjustment
  4. Cancel an External Refund applied to a Payment that has been applied to the Credit Balance Adjustment only
  5. Cancel (void) an Electronic Refund that has been applied to a payment that has been applied to a single invoice
  6. Cancel (void) an Electronic Refund that has been applied to a payment that has been applied to multiple invoices
  7. Cancel (void) an Electronic Refund that has been applied to a Payment that has been applied to Invoices and a Credit Balance Adjustment
  8. Cancel (void) an Electronic Refund applied to a Payment that has been applied to the Credit Balance Adjustment only

* Requires advanced Invoice adjustment functionality available through APIs. Contact Zuora Global Support if you want to support these advanced use cases.

If you want to develop a detailed test plan, this is a great list to start with. You can take this a level or two deeper with the variations on payment method type, and you might want to explore various negative test cases as a best practice.

As you can see, Payment Operations is more complex than what meets the eye!

Was this article helpful?
Pages that link here
Page statistics
650 view(s), 15 edit(s) and 15111 character(s)

Tags

Comments

You must to post a comment.

Attach file

Attachments