RefundInvoicePayment
If you have the Advanced AR Settlement feature enabled, this object is deprecated and only available for backward compatibility.
A refund invoice payment represents a portion of the refund that's being made against a payment that was applied to an invoice.
The RefundInvoicePayment object is automatically generated when you create a refund. This object works with the Refund object and the InvoicePayment object that the refund applies to. The RefundInvoicePayment object ties the Refund and the InvoicePayment objects together.
See Refund for API examples of refund invoice payments.
Field Descriptions
All field names are case sensitive. Check enumerated values in descriptions to confirm capitalization and spacing. See Field Types for additional information.
| Name | Require to Create? | Allowed Operations | Description |
|---|---|---|---|
| CreatedById | Query | The ID of the Zuora user who created the RefundInvoicePayment object. Type: zns:ID | |
| CreatedDate | Query | The date when the RefundInvoicePayment object was created. Type: dateTime | |
| Id | Query Filter | The ID of this object. Upon creation, the ID of this object is Type: zns:ID | |
| InvoiceId | Query Filter | The unique ID of the invoice associated with this refund invoice payment. Type: zns:ID | |
| InvoicePaymentId | Query | The ID of the InvoicePayment object associated with the refund. Type: zns:ID | |
| RefundAmount | Query | Specifies the amount of a refund applied against a payment. Type: decimal (currency) | |
| RefundId | Query | The ID of the Refund object that created the refund. Type: zns:ID | |
| UpdatedById | Query | The ID of the last user to update the object. Type: zns:ID | |
| UpdatedDate | Query | The date when the object was last updated. Type: dateTime |
Additional Field Detail
Id
The ID of this object. Every object has a unique identifier that Zuora automatically assigns upon creation. You use this ID later when you work with the object. For example, if you send an amend() call to modify an existing subscription, then you need to include the specific Subscriptionobject's ID with the call.
The ID for the RefundInvoicePayment object is RefundInvoicePaymentId.
RefundAmount
Specifies the amount of refund that applies against a the InvoicePayment. This read-only field is generated by the system, and exists only when a payment that was applied to an invoice is later refunded.
For example: An invoice is generated for $1000. An $800 payment is applied, then $300 of that payment is refunded. In this example, the amount of the invoice (Invoice.Amount) is $1000, the balance (Invoice.Balance) is $500 (= $1000-$800+$300), the refund amount (Invoice.RefundAmount) is $300, and the payment amount (Invoice.PaymentAmount) is $800.