Configuration APIIntegrations

Get a list of mandates

Requires the INTEGRATION.VIEW permission.

Authentication

X-API-KEYstring
API Key authentication via header
OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

versionstringRequiredDefaults to 1
version

Headers

x-platform-idstringOptional
Platform ID.

Query parameters

limitintegerOptional
The amount of records shown in the list
pageintegerOptional
The page which is going to be shown
order_bystringOptional
The parameter by which the response is ordered.
order_directionstringOptional
The order direction by which the response is ordered.

Response

OK
namestringOptional
The name of the mandate
countrystring or nullOptionalRead-only
The country that this mandate belongs to
mappingslist of objects or nullOptional
The mappings that are used for this Mandate. If not provided, all mappings will be default. If provided, will be merged with defaults
condition_groupslist of objects or nullOptional
The condition groups that are used for this mandate. If provided, no defaults will be used. The mandate applies if 1 conditionGroup applies
include_pdf_in_einvoiceboolean or nullOptional
Whether the PDF should be included in the submitted eInvoice payload when supported
supported_file_formatslist of objects or nullOptionalRead-only
The file formats in which eInvoices for this mandate can be downloaded

Errors

401
Unauthorized Error
403
Forbidden Error