The Payment is a description of the customer's payment—how much the customer is paying, which invoice or invoices the payment is to be applied to, and the type of payment being made.
This object is used in the create and query calls.
In addition to the following fields, zObject contributes additional fields. For information on the field types, see Field Types.
| Name | Required? | Type | Allowable Values | Description |
|---|---|---|---|---|
| AccountID | Yes | zns: ID | A valid account ID | A unique identifier for the account this payment is for. |
| Amount | Yes | double (currency) | Any allowable currency values | The amount of the payment. |
| Comment | No | string | 80 characters | An optional comment on this payment. |
| EffectiveDate | Yes | date | A valid date value | The date on which this payment will be effective. |
| PaymentMethodID | Yes | zns: ID | This value is automatically generated | A valid PaymentMethod ID indicating the method being used to make the payment. |
| ReferenceId | No | string | 80 characters | A reference ID for accounts. This is used to generate payments in lieu of an actual credit card number. For customers who have credit cards stored with a credit card gateway before switching over to Zuora, you can use the reference ID for to identify to our gateway to reference the credit cards that are stored remotely. |
| Status | Yes | string (enum) | Canceled, Draft, Error, Posted, Processed, Voided | The status of the payment. These are determined by the system. |
| Type | Yes | string (enum) | External, Electronic | Indicates how the customer is making the payment. |
Copyright © 2008-2009 Zuora, Inc.