This method adds a statement to the system. The parameters and the JSON/XML nodes returned vary based on your specific use case, the fields listed below are the fields that are available for all use cases/clients. Please discuss your integration with support to determine the specific fields required for your use case. The Checkissuing API currently supports pre-generated pdf statements as well as mail merge style statements using custom templates. Pass the statement parameter as an array in your post with the field names listed as the array's keys for their respective values.
Parameter | Type | Required | Default | Description |
---|---|---|---|---|
statement[wl_id] | String | No | N/A | ID of the whitelabel to use |
statement[issue_ts] | String | No | N/A | Date to send the statement on |
statement[recipient] | String | Yes | N/A | The recipients name |
statement[address] | String | Yes | N/A | The recipients address |
statement[return_address] | String | No | N/A | The return address to print on the statement |
statement[file] | String | No | N/A | Name of the pdf for this statement |
statement[ref] | String | No | N/A | Internal Reference |
statement[cover] | String | No | N/A | Boolean indicating if the statement requires a coversheet |
statement[color] | String | No | N/A | Print in color |
statement[duplex] | String | No | N/A | Print front and back |
statement[generic1] | String | No | N/A | Generic Field #1 |
statement[generic2] | String | No | N/A | Generic Field #2 |
statement[generic3] | String | No | N/A | Generic Field #3 |
statement[generic4] | String | No | N/A | Generic Field #4 |
statement[generic5] | String | No | N/A | Generic Field #5 |
statement[generic6] | String | No | N/A | Generic Field #6 |
statement[generic7] | String | No | N/A | Generic Field #7 |
statement[generic8] | String | No | N/A | Generic Field #8 |
statement[generic9] | String | No | N/A | Generic Field #9 |
statement[generic10] | String | No | N/A | Generic Field #10 |
statement[generic11] | String | No | N/A | Generic Field #11 |
statement[generic12] | String | No | N/A | Generic Field #12 |
statement[generic13] | String | No | N/A | Generic Field #13 |
statement[generic14] | String | No | N/A | Generic Field #14 |
statement[generic15] | String | No | N/A | Generic Field #15 |
statement[generic16] | String | No | N/A | Generic Field #16 |
statement[generic17] | String | No | N/A | Generic Field #17 |
statement[generic18] | String | No | N/A | Generic Field #18 |
statement[generic19] | String | No | N/A | Generic Field #19 |
statement[generic20] | String | No | N/A | Generic Field #20 |
statement[generic21] | String | No | N/A | Generic Field #21 |
statement[generic22] | String | No | N/A | Generic Field #22 |
statement[generic23] | String | No | N/A | Generic Field #23 |
statement[generic24] | String | No | N/A | Generic Field #24 |
statement[generic25] | String | No | N/A | Generic Field #25 |
statement[generic26] | String | No | N/A | Generic Field #26 |
statement[generic27] | String | No | N/A | Generic Field #27 |
statement[generic28] | String | No | N/A | Generic Field #28 |
statement[generic29] | String | No | N/A | Generic Field #29 |
statement[generic30] | String | No | N/A | Generic Field #30 |
statement[generic31] | String | No | N/A | Generic Field #31 |
statement[generic32] | String | No | N/A | Generic Field #32 |
statement[generic33] | String | No | N/A | Generic Field #33 |
statement[generic34] | String | No | N/A | Generic Field #34 |
statement[generic35] | String | No | N/A | Generic Field #35 |
statement[generic36] | String | No | N/A | Generic Field #36 |
statement[generic37] | String | No | N/A | Generic Field #37 |
statement[generic38] | String | No | N/A | Generic Field #38 |
statement[generic39] | String | No | N/A | Generic Field #39 |
statement[generic40] | String | No | N/A | Generic Field #40 |
statement[template_id] | String | No | N/A | Template to use for mail merge style statements |
statement[address2] | String | No | N/A | The recipients address 2 |
statement[city] | String | No | N/A | The recipients city |
statement[state] | String | No | N/A | The recipients state |
statement[zip] | String | No | N/A | The recipients zip |
statement[date] | String | No | N/A | Generic Date Field |
statement[ignore] | String | No | N/A | Ignored and not saved |