gtARReceiptPayDetails
This function supplies the information to add payment details to Accounts Receivable Receipt headers. The Receipt Reference parameter must be the unique ID returned by the gtARReceipt function call.
The parameters that must be specified depend on the value of the Receipt Type parameter in the gtARReceipt function of the current receipt. If the receipt type is:
- CHEQUE, then the cheque parameters must be specified.
- OTHER then the credit card parameters must be specified.
- CASH, then no pay details are required this function should not be used for that particular receipt.
Reference
This must be the unique identifier generated by the gtARReceipt function call. It has the format ARREC-nnn.
This ensures the payment details are of the correct Receipt header and it ensures Excel creates the header information before attempting to calculate and create the receipt payment details.
ChequeName
If the receipt type is Cheque, then this is the name specified on the cheque received.
ChequeBank
The bank of the cheque received.
ChequeBranch
The bank branch of the cheque received.
CreditCardType
This is the name of the credit card that is defined on the Credit Card Maintenance form (for example, VISA, VOUCHER). If the receipt type specified in gtARReceipt is Other, and the CreditCardType refers to a banked credit card, the receipt updates the selected bank.
If the CreditCardType refers to a non-banked credit card, the receipt updates the GL Clearing account of the card.
CreditCardName
The name specified on the credit card the customer used for payment.
CreditCardNumber
The credit card number that the customer used for payment.
CreditCardExpiry
The expiry date of the credit card.
Returns
- Ok - If there are no errors.
- Error - If there is an error.
Errors Returned
- AR Receipt header error
- Invalid AR Receipt header reference
- AR Receipt header not found
- Pay Detail not required for a cash line
- ChequeBank is required
- ChequeBranch is required
- ChequeName is required
- Credit Card Name is required
- Credit Card Type is required
- Credit Card Number is required
- Credit Card Expiry is required
- Invalid credit card
- The credit card expiry date is invalid