MakePayment Reference
Reference for the MakePayment object. At least one of these is required for the object: CashInfo, CheckInfo, CreditCardInfo but no more then two.
Parameters
| Name | DataType | Is Required |
|---|---|---|
| AcctID | Long | Required |
| Description | The account’s ID number. This is returned when you use the CreateNewAccount method or can be retrieved with the SearchBy method. | |
| CashCreditAmount | Decimal | Optional |
| Description | No input necessary. The cash credit/escrow amount is automatically applied to the rental item. | |
| CashInfo | Decimal | Optional* |
| Description | If making a cash payment, this field should contain the total amount of the cash payment. | |
| CheckInfo | CheckData | Optional* |
| Description | If making a check payment, you can use the CheckData collection for up to three checks. | |
| CreditCardInfo | CreditCardData | Optional* |
| Description | If making a credit card payment, you can use the CreditCardData collection for up to three credit cards. | |
| Cycles | Integer | Optional |
| Description | The standard length of time a rental object is rented. If no cycle is passed in it is assumed only one cycle should be paid for. If a single integer is passed in it is assumed that all reference rentals need to pay for the cycles indicated. If an array of integers is passed in, it is assumed they match one to one with the array of rental ID’s passed in. The number of cycles starts from the PTD. You are limited to the number of cycles you can retrieve based on the ‘Prepaid Rent Maximum Days’ rule of the site. | |
| IsRetail | Boolean | Required |
| Description | Indicates “True” if the payment is for retail only, “False” if it is not. | |
| IsRetailAndRental | Boolean | Required |
| Description | Indicates “True” if the payment is for rent and retail, “False” if it is not. | |
| MoveOutDate | dateTime | Optional |
| Description | The date applied when vacating a rental item. This defaults to today’s date unless otherwise specified. The date can be set in the past, based on the site’s End Rental rule settings. No future dates are allowed though. | |
| PayAssessData | AssessmentData | Optional |
| Description | Allows a tenant to pay for specific assessments on a rental item instead of the amount due. Follows the sites partial payment rules. | |
| RentalIDs | Long | Optional |
| Description | The rental item’s ID number. An array of rental IDs. If no IDs are passed in, all rentals on the account are paid. You can pass in one or more IDs to have the payment apply to one or more specified rentals. All rentals must belong to the account. This is returned when using the MakeReservation method or can be searched for using the SearchBy method. | |
| SiteID | Long | Required |
| Description | The site’s ID number. This can be found using the GetSiteList method. | |
| TaxExemptNumber | String | Optional |
| Description | If paying for tax exempt retail item, the Tax ID number must be included here. If the tax ID number is not the same as it is for the rental or if the rental is not tax exempt you will not be able to pay for both in the same transaction. Max string length of 20. | |
| TotalAmtDue | Decimal | Required |
| Description | The total amount required for the specified account, rental items and cycles. To obtain the total due, see the GetAssessments and GetTotalDue methods. | |
| TotalAmtPaid | Decimal | Required |
| Description | The total amount paid for the rental item. This is a total of all forms of payment applied. For example, If the customer pays $50 with a check and $50 with a credit card this should be $100. | |
*At least one of these is required for the object: CashInfo, CheckInfo, CreditCardInfo but no more then two.
Categories: API General, References
Comments (0)
Trackbacks (0)
Leave a comment
Trackback
Yardi Store Developer eXchange 