GET /api/reminder-texts
<?xml version="1.0" encoding="UTF-8"?> <reminder-texts type="array"> <reminder-text> ... </reminder-text> <reminder-text> ... </reminder-text> </reminder-texts>
GET /api/reminder-texts/{id}
<?xml version="1.0" encoding="UTF-8"?> <reminder-text> <id type="integer">7</id> <sorting type="integer">1</sorting> <name>First friendly reminder</name> <subject>Payment reminder</subject> <header>Unfortunately there is no payment for our invoice [Invoice.invoice_number] from [Invoice.date] yet.</header> <footer>Best regards</footer> <charge_name>Dunning charge</charge_name> <charge_description>Postal charge</charge_description> <charge_amount type="float">0.55</charge_amount> </reminder-text>
POST /api/reminder-texts
XML element | Description | Type | Default value | Mandatory |
---|---|---|---|---|
sorting | The sorting of this reminder text | INT | Without a sorting the reminder text it placed at the end of all reminder texts. | no |
name | A name for internal use only | ALNUM | no | |
subject | A subject. | ALNUM | no | |
header | Introductory text | ALNUM | no | |
footer | Explanatory notes | ALNUM | no | |
charge_name | Name of charge (if present) | ALNUM | no | |
charge_description | Description of charge (if present) | ALNUM | no | |
charge_amount | Amount of charge (if present) | FLOAT | no |
<reminder-text> <name>Hire a lawyer</name> <subject>Last reminder</subject> </reminder-text>
<?xml version="1.0" encoding="UTF-8"?> <reminder-text> <id type="integer">42</id> <sorting type="integer">2</sorting> <name>Hire a lawyer</name> <subject>Last reminder</name> <header></header> <footer></footer> <charge_name></charge_name> <charge_description></charge_description> <charge_amount type="float"></charge_amount> </reminder-text>
PUT /api/reminder-texts/{id}
<reminder-text> <charge_amount>100.00</charge_amount> </reminder-text>
DELETE /api/reminder-texts/{id}