List all receivers

GET /api/recurring-email-receivers?recurring_id={recurring_id}

E-mail receivers can only be returned for a particular recurring invoice.
Therefore recurring_id is a mandatory parameter.

<?xml version="1.0" encoding="UTF-8"?>
<recurring-email-receivers type="array" page="1" per_page="100" total="2">
    <recurring-email-receiver>
        ...
    <recurring-email-receiver>
    <recurring-email-receiver>
        ...
    <recurring-email-receiver>
</recurring-email-receivers>

Get a receiver

GET /api/recurring-email-receivers/{id}
<?xml version="1.0" encoding="UTF-8"?>
<recurring-email-receiver>
    <id type="integer">1</id>
    <recurring_id type="integer">1</recurring_id>
    <type>To</type>
    <address>info@example.com</address>
</recurring-email-receiver>

type can have the following values:
– to
– cc
– bcc

Create receiver

POST /api/recurring-email-receivers

typeReceiver type (to, cc, bcc)ALNUM

XML element Description Type Default value Mandatory
recurring_id ID of the recurring INT yes (except for creation of an recurring)
address e-mail address ALNUM If the address is left blank the recurring will be send to the client’s e-mail address

The receiver is added to evenutell already existing receivers.

<recurring-email-receiver>
    <recurring_id type="integer">1</recurring_id>
    <type>To</type>
    <address>info@example.com</address>
</recurring-email-receiver>
<?xml version="1.0" encoding="UTF-8"?>
<recurring-email-receiver>
    <id type="integer">1</id>
    <recurring_id type="integer">1</recurring_id>
    <type>To</type>
    <address>info@example.com</address>
</recurring-email-receiver>

Edit receiver

PUT /api/recurring-email-receivers/{id}

Here the same parameters apply as for creating, however, the associated recurring (recurring_id) can not be changed.

<recurring-email-receiver>
    <type>Bcc</type>
    <address>info@example.com</address>
</recurring-email-receiver>

Delete receiver

DELETE /api/recurring-email-receivers/{id}