InvoicePayment

From API Documentation

This object ties a payment to an invoice, providing information on how much the payment is and how a payment is to be applied to one or more invoices. Only one PaymentID and once InvoiceID are accepted (i.e., you cannot spread a payment across multiple invoices).

Supported Calls

This object is used in the create and query calls.

Fields

In addition to the following fields, zObject contributes additional fields. For information on the field types, see Field Types.

Name	Required?	Type	Allowed Operations: ● Yes ○ No	Allowable Values	Description
Amount	Yes	double (v1.0-18.0) / decimal (v19.0+)	● Create ● Query ● Update ○ Delete ● Filter	Any valid currency amount	The amount of the payment.
CreatedById	System generated, always exists	ZNS:Id	○ Create ● Query ○ Update ○ Delete ● Filter	This field is not editable. 32 characters maximum.	Available as of version 20.0 of the API. The Zuora system automatically generates this Id of the user who created the object.
CreatedDate	System generated, always exists	dateTime	○ Create ● Query ○ Update ○ Delete ● Filter	This field is not editable.	Available as of version 20.0 of the API. The Zuora system automatically generates this, and denotes when the objects was first created.
InvoiceId	Yes	zns: ID	● Create ● Query ○ Update ○ Delete ● Filter	A valid Invoice object ID	A unique identification number for the invoice (identifying an Invoice object).
PaymentId	Yes	zns: ID	● Create ● Query ○ Update ○ Delete ● Filter	A valid Payment object ID	A unique identification number for the payment (identifying a Payment object).
RefundAmount	No	decimal	○ Create ● Query ○ Update ○ Delete ● Filter		The refund amount to apply.
UpdatedById	System generated, always exists	ZNS:Id	○ Create ● Query ○ Update ○ Delete ● Filter	This field is not editable. 32 characters maximum.	Available as of version 20.0 of the API. The Zuora system automatically generates this Id of the user who last updated the object.
UpdatedDate	System generated, always exists	dateTime	○ Create ● Query ○ Update ○ Delete ● Filter	This field is not editable.	Available as of version 20.0 of the API. The Zuora system automatically generates this, and denotes when the objects was last updated.