Knowledge Center

Knowledge Center > API > SOAP API > SOAP API Object Reference > InvoicePayment

InvoicePayment

An invoice payment is a mechanism that ties a payment to an invoice and indicates how much of the payment was applied to the invoice.

You can use the Zuora API or UI to apply a payment to a single invoice or to multiple invoices. 

You can only apply a payment to multiple invoices in a single SOAP API call if you use WSDL 64 or later.

If you use the UI to apply payments and then query using the Zuora API, multiple InvoicePayment objects are returned. Each returned InvoicePayment object has one invoice and one payment.

For API examples of applying single and multiple invoice payments, see Payment.

Supported calls

You can use this object with the following calls

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

Required to Create?

Allowed Operations

Description

Amount required Create
Query
Update
Filter

The amount of the payment.

Type: decimal (currency)
Character limit: 16
Version notes: type is double in WSDL 18.0 and older
Values: a valid currency amount

CreatedById optional

Query
Filter

The user ID of the person who created the invoice payment.

Type: zns:ID
Character limit: 32
Version notes: WSDL 20.0+
Values: automatically generated

CreatedDate optional

Query
Filter

The date when the invoice payment was generated.

Type: dateTime
Character limit: 29
Version notes: WSDL 20.0+
Values: automatically generated

Id required Query
Filter

The ID of this object. Upn creation, the ID of this object is InvoicePaymentId.

Type: zns:ID
Character limit: 32
Version notes: --
Values: automatically generated

InvoiceId required Create
Query
Filter

The unique ID of the invoice associated with this invoice payment.

Type: zns:ID
Character limit: 32
Version notes: --
Values: a valid invoice ID

PaymentId required Create
Query
Filter

The unique ID of the payment associated with this invoice payment.

Type: zns:ID
Character limit: 32
Version notes: --
Values: a valid payment ID

RefundAmount optional

Query
Filter

Specifies the amount of a refund applied against this InvoicePayment.

Type: decimal (currency)
Character limit: 16
Version notes: --
Values: automatically generated

UpdatedById optional

Query
Filter

The ID of the user who last updated the invoice payment.

Type: zns:ID
Character limit: 32
Version notes: WSDL 20.0+
Values: automatically generated

UpdatedDate optional

Query
Filter

The date when the invoice payment was last updated.

Type: dateTime
Character limit: 29
Version notes: WSDL 20.0+
Values: automatically generated

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 InvoicePayment object is InvoicePaymentId.

RefundAmount

Specifies the amount of a refund that applied against this 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.

Last modified
18:30, 6 Oct 2015

Tags

Classifications

(not set)