This API call let's you create a pdf file from a misc transaction record. The response is an XML of the misc transaction PDF action.
Request Fields
| Field Name |
Type |
Required |
Description |
| action |
String |
Yes |
transactionOtherPDF |
| accountId |
Integer |
Yes |
The Helcim Commerce account ID. |
| apiToken |
String |
Yes |
API token used for authentication and access control. |
| transactionOtherId |
Integer |
Yes |
The transaction ID. |
Response Fields
| Field Name |
Type |
Description |
| message |
- |
XML structure |
| response |
Integer |
1 or 0. Whether the misc transaction record was converted to PDF or not. |
| responseMessage |
String |
Confirmation of action taken. |
| pdf |
- |
XML Structure |
| name |
String |
The pdf file name. |
| content |
String |
BASE-64 ENCODED |
| height |
Decimal |
The height of the PDF in millimitres. |
Errors
For all API requests, there are also generic API authentication and user access restriction errors.
| Response Code |
Error Code |
Message |
Description |
| 0 |
- |
Invalid Transaction ID |
The transaction ID is invalid, or not entered. |
| 0 |
- |
Invalid API Token1 |
The API Token is invalid, or not entered. |
| 0 |
- |
Missing or Invalid Fields - Account ID |
The Account ID is invalid, or not entered. |
