POST api/Loyalty/CreatePointsTransaction?companyKey={companyKey}
Creates a points transaction with the specified details.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| companyKey | string |
Default value is |
Body Parameters
The parameter object containing the new transaction details.
CreatePointsTransactionParameter| Name | Description | Type | Additional information |
|---|---|---|---|
| CustomerCode |
The customer code. |
string |
Required Max length: 10 |
| TranDate |
The transaction date. |
date |
Required |
| TranType |
The transaction type. |
string |
Required Max length: 2 |
| Description |
The transaction's description. |
string |
Required Max length: 50 |
| Analysis |
The transaction's analysis code. |
string |
Max length: 4 |
| Points |
The number of points in the transaction. |
integer |
Required |
| Amount |
The amount (in the company's base currency) corresponding to the number of points in the transaction. |
decimal number |
Required |
| CompNo |
The company number. |
integer |
Required |
| ExtRef |
The transaction's external reference. |
string |
Max length: 15 |
Request Formats
application/json, text/json
Sample:
{
"CustomerCode": "sample string 1",
"TranDate": "2024-11-23T18:32:39.5269336",
"TranType": "sample string 3",
"Description": "sample string 4",
"Analysis": "sample string 5",
"Points": 6,
"Amount": 7.0,
"CompNo": 8,
"ExtRef": "sample string 9"
}
Response Information
Resource Description
The result containing the created transaction.
CreatePointsTransactionResult| Name | Description | Type | Additional information |
|---|---|---|---|
| Transaction | Transact |
N/A |
Response Formats
application/json, text/json
Sample:
{
"Transaction": {
"CustRef": "sample string 1",
"SysRef": "sample string 2",
"TranDate": "2024-11-23T18:32:39.5425545",
"TranType": "AP",
"TransactionType": 0,
"Description": "sample string 6",
"Analysis": "sample string 7",
"DbCr": "sample string 8",
"Points": 9,
"Amount": 10.0,
"CompNo": 11,
"IntRef": "sample string 12",
"ExtRef": "sample string 13",
"PtsAlloc": 14,
"Allocated": true,
"UserId": "sample string 16",
"Date": "2024-11-23T18:32:39.5425545",
"Time": "sample string 18"
}
}