### Show Invoices API

Source: https://github.com/pve/autorespond-doc/blob/main/autorespond-api-docs.md

Retrieves a list of invoices and credit invoices created after a specified date. Requires the start date, admin ID, and API key.

```APIDOC
GET https://api.e-act.nl/api/1.0/invoices

Parameters:
  dateFrom (String): use this to select all (credit and normal) invoices that are created AFTER this date. Use format 'YYYY-MM-DD'
  admin (Number): administration id of caller (used as authentication)
  key (String): administration API access key of caller (used as authentication)

Success Response (200):
  List (Object): of invoices [ { relationEmail, invoiceNumber, description, invoiceDate, isCreditInvoice, amountIncl } ]

Error Response (4xx):
  error (String): An error message.
```

--------------------------------

### Get All Groups API

Source: https://github.com/pve/autorespond-doc/blob/main/autorespond-api-docs.md

Retrieves a list of all groups within a specific administration. Requires 'admin' and 'key' for authentication. Returns an array of group objects, each with an 'id' and 'title'.

```APIDOC
GET https://api.e-act.nl/api/1.0/groups

Parameters:
  admin (Number): Administration ID for authentication.
  key (String): Administration API access key for authentication.

Success Response (200):
  groups (Object): An array of group objects, each containing 'id' and 'title'.

Error Response (4xx):
  error (String): An error message.
```

--------------------------------

### Get Relations in Group API

Source: https://github.com/pve/autorespond-doc/blob/main/autorespond-api-docs.md

Fetches all relations that are members of a specified group. The group ID is included in the URL path. Requires 'admin' and 'key' for authentication.

```APIDOC
GET https://api.e-act.nl/api/1.0/groups/{grpId}/relations

Parameters:
  grpId (Number): The ID of the group.
  admin (Number): Administration ID for authentication.
  key (String): Administration API access key for authentication.

Success Response (200):
  [Object]: An array of relation objects belonging to the group.

Error Response (4xx):
  error (String): An error message.
```

--------------------------------

### Get PDF Invoice API

Source: https://github.com/pve/autorespond-doc/blob/main/autorespond-api-docs.md

Retrieves a PDF invoice for a given invoice number. Requires the invoice number, admin ID, and API key for authentication.

```APIDOC
GET https://api.e-act.nl/api/1.0/invoices/{invoiceNumber}

Parameters:
  invoiceNumber (String): the invoice number for which the PDF must be retrieved
  admin (Number): administration id of caller (used as authentication)
  key (String): administration API access key of caller (used as authentication)

Success Response (200):
  Invoice (Object): PDF file (application/pdf)

Error Response (4xx):
  error (String): An error message.
```

--------------------------------

### Administration API Endpoints

Source: https://github.com/pve/autorespond-doc/blob/main/autorespond-api-docs.md

Provides endpoints for retrieving API version, administration fields, tags, and specific administration details. Requires 'admin' and 'key' for authentication.

```APIDOC
APIDOC:
  Get API Version:
    Endpoint: https://api.e-act.nl/api/1.0/version
    Description: Get the current version of the API.
    Success Response (200):
      version: String - The current version of the API

  Get All Fields:
    Endpoint: https://api.e-act.nl/api/1.0/fields
    Description: Get all defined fields within an administration.
    Parameters:
      admin: Number - administration id of caller (used as authentication)
      key: String - administration API access key of caller (used as authentication)
    Success Response (200):
      fields: Object - [ { code, name, type, options[] } ]
    Error Response (4xx):
      error: String - An error message.

  Get All Tags:
    Endpoint: https://api.e-act.nl/api/1.0/tags
    Description: Get all defined tags within an administration.
    Parameters:
      admin: Number - administration id of caller (used as authentication)
      key: String - administration API access key of caller (used as authentication)
    Success Response (200):
      tags: Object - [ { id, name } ]
    Error Response (4xx):
      error: String - An error message.

  Load Admin:
    Endpoint: https://api.e-act.nl/api/1.0/admins/{id}
    Description: Load an administration with the given id.
    Parameters:
      id: Number - ID of admin to fetch
      admin: Number - administration id of caller (used as authentication)
      key: String - administration API access key of caller (used as authentication)
    Success Response (200):
      admin: Object - { company_id, accessCode, serviceLevel, locked, adminName, adminEmail}
    Error Response (4xx):
      error: String - An error message.
```

--------------------------------

### Show Orders API

Source: https://github.com/pve/autorespond-doc/blob/main/autorespond-api-docs.md

Retrieves paid and/or non-paid orders for a specified period. Requires 'admin' and 'key' for authentication. Supports filtering by 'paid' status and 'hours'. Returns a list of order objects.

```APIDOC
GET https://api.e-act.nl/api/1.0/orders

Parameters:
  paid (String): 'Y' for paid, 'N' for unpaid, '-' for all (optional)
  hours (Number): Time period in hours (e.g., 24 for past 24 hours)
  admin (Number): Administration ID for authentication
  key (String): Administration API access key for authentication

Success Response (200):
  List (Object): An array of order objects, each containing orderId, relationId, relationName, relationEmail, invoiceNumber, orderlines, purchaseDate, and paid status.

Error Response (4xx):
  error (String): An error message.
```

--------------------------------

### Show Orders for Relation API

Source: https://github.com/pve/autorespond-doc/blob/main/autorespond-api-docs.md

Retrieves all orders for a specified relation. Requires the relation ID, admin ID, and API key for authentication.

```APIDOC
GET https://api.e-act.nl/api/1.0/orders/relation/{id}

Parameters:
  id (Number): the id of the relation for which orders must be collected
  admin (Number): administration id of caller (used as authentication)
  key (String): administration API access key of caller (used as authentication)

Success Response (200):
  List (Object): of orders [ { orderId, invoiceNumber, orderlines [ {lineType, productId, productName, quantity, subscriptionId, subscriptionBilledUntil, subscriptionEndsAt } ], purchaseDate, paid, email } ]

Error Response (4xx):
  error (String): An error message.
```

--------------------------------

### List Manager API Endpoints

Source: https://github.com/pve/autorespond-doc/blob/main/autorespond-api-docs.md

Provides endpoints for managing list managers, including retrieving a list of all list managers, subscribing relations with or without GDPR consent, and skipping the opt-in step.

```APIDOC
APIDOC:
  Show Listmanagers:
    Endpoint: https://api.e-act.nl/api/1.0/listmanagers
    Description: Returns a complete list of listmanagers within an administration.
    Parameters:
      admin: Number - administration id of caller (used as authentication)
      key: String - administration API access key of caller (used as authentication)
    Success Response (200):
      list: Object - List of listmanagers [ { id, name, category, code, groupId } ]
    Error Response (4xx):
      error: String - An error message.

  Start Listmanager with GDPR Data:
    Endpoint: https://api.e-act.nl/api/1.0/listmanagers/{listId}/gdpr_subscribe
    Description: Start a listmanager for the given relation including GDPR consent.
    Parameters:
      listId: Number - id of listmanager to start
      relId: Number - id of relation for whom the listmanager is started
      skipOptin: String - if set to 'Y', skip the optin step
      admin: Number - administration id of caller (used as authentication)
      key: String - administration API access key of caller (used as authentication)
      privacyText: String - text of privacy remark on the form
      privacyAgreement: String - 'Y' or 'N' if relation agrees with privacy statement
      privacyUrl: String - link to privacy statement as used in the form
      consentText: String - text of consent remark on the form
      consentAgreement: String - 'Y' or 'N' if relation agrees with consent text
      ip: String - address of relation that submitted the form
    Success Response (200):
      TRUE: Boolean - if action succeeded.
    Error Response (4xx):
      error: String - An error message.

  Start Listmanager:
    Endpoint: https://api.e-act.nl/api/1.0/listmanagers/{listId}/subscribe
    Description: Start a listmanager for the given relation.
    Parameters:
      listId: Number - id of listmanager to start
      relId: Number - id of relation for whom the listmanager is started
      skipOptin: String - if set to 'Y', skip the optin step
      admin: Number - administration id of caller (used as authentication)
      key: String - administration API access key of caller (used as authentication)
    Success Response (200):
      TRUE: Boolean - if action succeeded.
    Error Response (4xx):
      error: String - An error message.
```

--------------------------------

### E-ACT API Documentation

Source: https://github.com/pve/autorespond-doc/blob/main/autorespond-api-docs.md

This section details the various endpoints available in the E-ACT API for managing relations and groups. It covers loading relations by email or ID, removing relations from groups, showing subscriptions, updating relation emails, and managing tags.

```APIDOC
Load Relation by Email:
  Endpoint: https://api.e-act.nl/api/1.0/relation
  Method: GET
  Description: Returns a relation details object for a given email address.
  Parameters:
    email (String): emailaddress of relation to search for
    admin (Number): administration id of caller (used as authentication)
    key (String): administration API access key of caller (used as authentication)
  Success Response (200):
    relation (Object): { id, firstName, suffix, lastName, email, funnelState, gender }
  Error Response (4xx):
    error (String): An error message.

Load Relation by Id:
  Endpoint: https://api.e-act.nl/api/1.0/relation/{id}
  Method: GET
  Description: Returns a relation details object for a given id.
  Parameters:
    id (Number): id of relation to load
    admin (Number): administration id of caller (used as authentication)
    key (String): administration API access key of caller (used as authentication)
  Success Response (200):
    relation (Object): { id, firstName, suffix, lastName, email, funnelState, gender }
  Error Response (4xx):
    error (String): An error message.

Remove Relation From group:
  Endpoint: https://api.e-act.nl/api/1.0/group/{grpId}/member/{relId}
  Method: DELETE
  Description: Remove a relation from a group. If the relation is not member of the group, no action is taken.
  Parameters:
    grpId (Number): id of the group
    relId (Number): id of the relation to remove
    admin (Number): administration id of caller (used as authentication)
    key (String): administration API access key of caller (used as authentication)
  Success Response (200):
    result (Boolean): code
  Error Response (4xx):
    error (String): An error message.

Show subscriptions:
  Endpoint: https://api.e-act.nl/api/1.0/relation/{id}/subscriptions
  Method: GET
  Description: Returns a list of listmanager-id's for which the given relation subscribed and/or unsubscribed.
  Parameters:
    id (Number): the id of the relation
    admin (Number): administration id of caller (used as authentication)
    key (String): administration API access key of caller (used as authentication)
  Success Response (200):
    List (Object): of (un)subscriptions [ { campaignId, relationId, subscribedFlag (U or S), eventDate } ]
  Error Response (4xx):
    error (String): An error message.

Update Relation Email:
  Endpoint: https://api.e-act.nl/api/1.0/relation/{id}/email
  Method: PUT
  Description: Update the email address of an existing relation.
  Parameters:
    newemail (String): new email address for the existing relation
    id (Number): of the existing relation
    admin (Number): administration id of caller (used as authentication)
    key (String): administration API access key of caller (used as authentication)
  Success Response (200):
    result (Boolean): code
  Error Response (4xx):
    error (String): An error message.

Add Tag To Relation with given email:
  Endpoint: https://api.e-act.nl/api/1.0/relation/addtag/{tagId}
  Method: POST
  Description: Add a tag to a relation with the given email address. If the tag is already associated to the relation, no action is taken.
  Parameters:
    tagId (Number): id of the tag to add
    email (String): address of the relation
    admin (Number): administration id of caller (used as authentication)
    key (String): administration API access key of caller (used as authentication)
  Success Response (200):
    status (String): ok
  Error Response (4xx):
    error (String): An error message.

Add Tag To Relation:
  Endpoint: https://api.e-act.nl/api/1.0/relation/{relId}/addtag/{tagId}
  Method: POST
  Description: Add a tag to a relation. If the tag is already associated to the relation, no action is taken.
  Parameters:
    relId (Number): id of the relation
    tagId (Number): id of the tag to add
    admin (Number): administration id of caller (used as authentication)
    key (String): administration API access key of caller (used as authentication)
  Success Response (200):
    status (String): ok
  Error Response (4xx):
    error (String): An error message.
```

--------------------------------

### Show Tags For Relation API

Source: https://github.com/pve/autorespond-doc/blob/main/autorespond-api-docs.md

Retrieves a list of tags associated with a specific relation. Requires the relation ID and authentication credentials.

```APIDOC
APIDOC:
  Endpoint: https://api.e-act.nl/api/1.0/relation/{id}/tags
  Method: GET
  Description: Returns a list of tags that are associated with the given relation.
  Parameters:
    - id (Number): the id of the relation
    - admin (Number): administration id of caller (used as authentication)
    - key (String): administration API access key of caller (used as authentication)
  Success Response (200):
    - Array (String): List of of tagnames
  Error Response (4xx):
    - error (String): An error message.
```

--------------------------------

### Show Individual Invoice API

Source: https://github.com/pve/autorespond-doc/blob/main/autorespond-api-docs.md

Retrieves details for a specific invoice number. Credit invoices are not supported. Requires the invoice number, admin ID, and API key.

```APIDOC
GET https://api.e-act.nl/api/1.0/invoice/{invoiceNumber}

Parameters:
  invoiceNumber (String): the number of the requested invoice
  admin (Number): administration id of caller (used as authentication)
  key (String): administration API access key of caller (used as authentication)

Success Response (200):
  Invoice (Object): details { lines: [ { discount, sku, description, quantity, amount, vatamount, vatpercentage, ledger } ], orderId, billingId, relationEmail, relationId, invoiceNumber, invoiceDate, isCreditInvoice, amountIncl, amountExcl, amountVat, fullName, address, postalCode, city, country, btwNummer, company }

Error Response (4xx):
  error (String): An error message.
```

--------------------------------

### Create New Free Field API

Source: https://github.com/pve/autorespond-doc/blob/main/autorespond-api-docs.md

Creates a new custom free field within an administration. The 'fieldName' must be unique and adhere to specific character constraints. Requires 'admin' and 'key' for authentication.

```APIDOC
POST https://api.e-act.nl/api/1.0/field

Parameters:
  fieldName (String): Unique name for the field (a-Z, underscore, no spaces, < 60 chars).
  fieldLabel (String): Label displayed for the field.
  fieldType (String): Type of the field ('boolean', 'string', 'list').
  fieldOptions (String): Comma-separated values if fieldType is 'list' (< 2048 chars).
  admin (Number): Administration ID for authentication.
  key (String): Administration API access key for authentication.

Success Response (200):
  id (Number): The ID of the newly created field.

Error Response (4xx):
  error (String): An error message.
```

--------------------------------

### Create or Update Relation API

Source: https://github.com/pve/autorespond-doc/blob/main/autorespond-api-docs.md

Creates a new relation if the email is not found, otherwise updates an existing relation. Requires 'admin' and 'key' for authentication. Various fields can be provided to create or update the relation details.

```APIDOC
POST https://api.e-act.nl/api/1.0/relation

Parameters:
  email (String): Email address for the relation. Used to find existing relations.
  firstName (String): First name of the relation (optional).
  suffix (String): Suffix for the relation (optional).
  lastName (String): Last name of the relation (optional).
  gender (String): Relation gender ('M', 'F', or '-' for not specified) (optional).
  type (String): 1-character relation type (optional).
  password (String): Relation password (6-20 characters long) (optional).
  customer (String): Flag to activate as customer ('y' or 'n') (optional).
  admin (Number): Administration ID for authentication.
  key (String): Administration API access key for authentication.

Success Response (200):
  relation (Object): An object containing the relation's id, firstName, suffix, lastName, email, funnelState, and gender.

Error Response (4xx):
  error (String): An error message.
```

--------------------------------

### Add Tag To Relation API

Source: https://github.com/pve/autorespond-doc/blob/main/autorespond-api-docs.md

Adds a tag to a specified relation. Requires relation ID, tag ID, and authentication credentials.

```APIDOC
APIDOC:
  Endpoint: https://api.e-act.nl/api/1.0/relation/{relId}/addtag/{tagId}
  Method: POST
  Description: Add a tag to a relation.
  Parameters:
    - relId (Number): id of the relation
    - tagId (Number): id of the tag to add
    - admin (Number): administration id of caller (used as authentication)
    - key (String): administration API access key of caller (used as authentication)
  Success Response (200):
    - result (Boolean): code
  Error Response (4xx):
    - error (String): An error message.
```

--------------------------------

### End Existing Subscription API

Source: https://github.com/pve/autorespond-doc/blob/main/autorespond-api-docs.md

Ends an existing subscription with a specified end date. Requires the subscription ID, end date, admin ID, and API key for authentication.

```APIDOC
POST https://api.e-act.nl/api/1.0/orders/subscriptions/{id}/end

Parameters:
  endDate (Date): date that the subscription should end. Use format 'DD-MM-YYYY'
  id (Number): of the existing subscription
  admin (Number): administration id of caller (used as authentication)
  key (String): administration API access key of caller (used as authentication)

Success Response (200):
  result (Boolean): code

Error Response (4xx):
  error (String): An error message.
```

--------------------------------

### Set Free Field For Relation API

Source: https://github.com/pve/autorespond-doc/blob/main/autorespond-api-docs.md

Assigns or updates a free field for a given relation. Requires relation ID, field code, field value, and authentication.

```APIDOC
APIDOC:
  Endpoint: https://api.e-act.nl/api/1.0/relation/{relId}/setfield
  Method: PUT
  Description: Assign a free field to a relation.
  Parameters:
    - relId (Number): id of the relation
    - fieldCode (String): code of the free field to add or update
    - fieldValue (String): the new value the field should be set to
    - admin (Number): administration id of caller (used as authentication)
    - key (String): administration API access key of caller (used as authentication)
  Success Response (200):
    - result (Boolean): code
  Error Response (4xx):
    - error (String): An error message.
```

--------------------------------

### List Manager Unsubscribe API

Source: https://github.com/pve/autorespond-doc/blob/main/autorespond-api-docs.md

Stops a list manager for a given relation, removing them from associated groups, creating an unsubscribe event, and removing planned emails. Requires listId, relId, reason, admin, and key.

```APIDOC
POST https://api.e-act.nl/api/1.0/listmanagers/{listId}/unsubscribe

Parameters:
  listId (Number): id of listmanager to stop
  relId (Number): id of relation for whom the listmanager is started
  reason (String): reason to stop - will be added as 'contact' with the relation
  admin (Number): administration id of caller (used as authentication)
  key (String): administration API access key of caller (used as authentication)

Success Response (200):
  TRUE (Boolean): if action succeeded.

Error Response (4xx):
  error (String): An error message.
```

--------------------------------

### Add Relation To Group API

Source: https://github.com/pve/autorespond-doc/blob/main/autorespond-api-docs.md

Adds a relation to a specified group. If the relation is already a member, no action is taken. Requires 'admin' and 'key' for authentication. The group ID and relation ID are part of the URL path.

```APIDOC
POST https://api.e-act.nl/api/1.0/group/{grpId}/member/:relId

Parameters:
  grpId (Number): The ID of the group.
  relId (Number): The ID of the relation to add.
  admin (Number): Administration ID for authentication.
  key (String): Administration API access key for authentication.

Success Response (200):
  result (Boolean): Indicates success or failure of the operation.

Error Response (4xx):
  error (String): An error message.
```

--------------------------------

### Remove Tag From Relation API

Source: https://github.com/pve/autorespond-doc/blob/main/autorespond-api-docs.md

Removes a tag from a specified relation. If the tag is not associated, no action is taken. Requires relation ID, tag ID, and authentication.

```APIDOC
APIDOC:
  Endpoint: https://api.e-act.nl/api/1.0/relation/{relId}/removetag/{tagId}
  Method: DELETE
  Description: Remove a tag from a relation.
  Parameters:
    - relId (Number): id of the relation
    - tagId (Number): id of the tag to remove
    - admin (Number): administration id of caller (used as authentication)
    - key (String): administration API access key of caller (used as authentication)
  Success Response (200):
    - result (Boolean): code
  Error Response (4xx):
    - error (String): An error message.
```

=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.