Skip to Content
TillorManuale
Mandate agreements

List Mandate Agreements

Accesso

Membro dell’organizzazione con questo permesso:

  • payments:read

Una chiave API con scope deve avere il permesso anche tra i suoi scope.

GET
/orgs/{organizationId}/mandate-agreements

Lists mandate agreements with pagination, filtering (e.g. customerId, status) and sorting.

Authorization

ApiKeyAuth
headerx-api-key<token>

API key for authentication

Path Parameters

organizationId*string

The ID or slug of the organization

Query Parameters

page?integer
Range-9007199254740991 <= value <= 9007199254740991
limit?integer
Range-9007199254740991 <= value <= 9007199254740991
sortBy?string
Value in"id""reference""status""locale""templateVersion""customerId""debtorName""debtorEmail""creditorSnapshot""viewTokenHash""expiresAt""signedAt""signerIp""signerUserAgent""verificationCodeHash""codeSentAt""verificationTarget""signatureMethod""documentSha256""signedDocumentId""mandateId""selectedMethod""setupPaymentId""useForUtilityBills""failureReason""halfwayReminderSentAt""twoDayReminderSentAt""expiryDayReminderSentAt""createdById""signedOnDeviceById""createdAt""updatedAt"
sortDir?string
Value in"asc""desc"
include?|array<>|string
signedDocumentId?string|array<string>|null
mandateId?string|array<string>|null
setupPaymentId?string|array<string>|null
createdById?string|array<string>|null
signedOnDeviceById?string|array<string>|null
status?|array<>|
selectedMethod?|array<>|
useForUtilityBills?boolean|string|number|null
expiresAt?|null
signedAt?|null
codeSentAt?|null
halfwayReminderSentAt?|null
twoDayReminderSentAt?|null
expiryDayReminderSentAt?|null
createdAt?|null
updatedAt?|null
reference?string|array<string>|
locale?string|array<string>|
templateVersion?string|array<string>|
customerId?string|array<string>|
debtorName?string|array<string>|
debtorEmail?string|array<string>|
viewTokenHash?string|array<string>|
signerIp?string|array<string>|
signerUserAgent?string|array<string>|
verificationCodeHash?string|array<string>|
verificationTarget?string|array<string>|
signatureMethod?string|array<string>|
documentSha256?string|array<string>|
failureReason?string|array<string>|
creditorSnapshot?
hasSignedDocument?boolean|string|number|null
hasNoSignedDocument?boolean|string|number|null
hasMandate?boolean|string|number|null
hasNoMandate?boolean|string|number|null

Response Body

OK

application/json
  1. response
Example Request
curl -X GET 'https://api.tillor.eu/orgs//mandate-agreements'
Example Response
null

Import Ledger Opening Balances POST

Creates opening balances and updates the ones whose reference already exists; rows without a matching customer or repeated in the file are skipped. Refused as a whole (409, `INVOICE_LEDGER_BALANCE_EXCEEDED`) when a row would take a guarded ledger below zero. With `ledgerBalanceOverride`, users with invoicing:override-ledger-balance may take a guarded ledger below zero; the motivation and the violations are recorded on the customer's timeline.

Create Mandate Agreement POST

Generates a SEPA mandate for the customer (IBAN optional) and sends it to sign: by email link, or on the reception iPad. The provider mandate is created once it is signed. Signed agreements are legal evidence, so there is no update or delete; use cancel or revoke.