all data is live and searchable
|
Main Web API Documentation Information
|
|
|
Actual Page/Function Name:
|
addLoyaltyPointsUsedTransaction |
|
Human Readable Name or Caption:
|
Add Loyalty Points Used Transaction |
|
Page/Function Description:
|
This method will calculate the reward/loyalty points for an invoice. The results will be added as a transaction for the customer. |
|
Page/Function Output Type:
|
API - JSON or WDDX |
|
Categories:
|
invoice,customer |
|
Extra Page/Function Notes:
|
|
|
Parameters
|
|||||||
| Scope | Name | Type | Default | Description | Required | Alternates | Known Values |
| Arguments | CORP_ID | Numeric | 0 | Pass in the corp id. | Yes | ||
| Arguments | CREATED_DATE | String | Pass in the created date/time stamp. | Yes | |||
| Arguments | CUSTOMER_ID | Numeric | 0 | Pass in the customer id. | Yes | ||
| Arguments | DONE_BY_PAYEE_ID | Numeric | 0 | Pass in the payee id that is creating this transaction. | Yes | ||
| Arguments | INVOICE_NUMBER | Numeric | 0 | Pass in the invoice number. | Yes | ||
| Arguments | NOTES | String | Pass in the human readable notes for the transaction. Must be at least three letters long. | Yes | |||
| Arguments | PAYMENT_AMOUNT | Numeric | 0 | Pass in the payment amount in dollars. | Yes | ||
| Arguments | SOURCE | String | coming from API | Pass in the source of the transaction. Set by an internal developer. Must be at least three letters long. | Yes | ||
|
Results
|
||||
| RET_STATUS | RET_MAIN_MESSAGE | RET_SECOND_MESSAGE | Redirect Link | Description |
|
Samples
|
|
| Caption | Text |
| JSON |
{"API_CALL_FUNCTION_NAME":"addLoyaltyPointsUsedTransaction","API_USER_PASSWORD":1234,"API_URL_ENCODING":"AUTO","CREATED_DATE":"5/15/20","API_INPUT_OUTPUT_TYPE":"JSON","CUSTOMER_ID":23169,"CORP_ID":53,"INVOICE_NUMBER":10598,"API_CURRENT_PAYEE_ID":3191,"API_USER_NAME":"demo","NOTES":"This is your note","PAYMENT_AMOUNT":5.00,"API_CORP_KEY_ID":"PLA-0053","DONE_BY_PAYEE_ID":3191,"SOURCE":"This is your source"}
|