Passer au contenu

📋 Get client mandates

Requête

Get all mandates for a client with their directory information.

Returns a list of mandates with their associated directory entries, including routing information and establishment details.

Sécurité
APIKeyHeader
Requête
status_filterMandateStatus (string) or null(Status Filter)
Any of:

Status of the mandate.

string(MandateStatus)
Enum:"processing""created""pending_kyb""active""expired""error""portability"
En-têtes
X-PDP-Client-Idstring(X-Pdp-Client-Id)obligatoire

ID of the PDP Client for which the operation is performed

Examples:
Sandbox client
client_abc123
curl -i -X GET \
  'https://pdp.seqino.dev/api/mandates?status_filter=processing' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'X-PDP-Client-Id: client_abc123'

Réponses

List of client mandates

Corpsapplication/json
Array [
client_idstring(Client Id)obligatoire

Reference to the client who owns this mandate

start_datestring, (date-time)(Start Date)obligatoire

When the mandate becomes active. Note: if the requested start date is today or in the past, it will be updated with the real start date returned by the PPF once the status of the mandate becomes CREATED.

end_datestring or null(End Date)
Any of:

When the mandate expires. Optional: when omitted (null) the mandate never expires and stays active indefinitely. In the PPF directory an open-ended mandate maps to an effective end date of 9999-12-31. An expiry can be set or removed later via PATCH /mandates/{id}.

string (date-time)
file_attachmentstring or null(File Attachment)
Any of:

Optional file attachment for the mandate

string
statusstring(MandateStatus)obligatoire

Current status of the mandate

Enum:"processing""created""pending_kyb""active""expired""error""portability"
directory_entryobjectobligatoire

Directory entry information for the mandated entity

emit_onlyboolean(Emit Only)

Whether the mandate is only for emitting invoices

Par défaut:false
vat_regimestring(VATRegime)

VAT regime of the mandated company. Determines data transmission periodicity.

Par défaut:"real_normal_monthly"
Enum:"real_normal_monthly""real_normal_quarterly""simplified""franchise"
created_atstring, (date-time)(Created At)obligatoire

When the mandate was created

updated_atstring or null(Updated At)
Any of:

When the mandate was last updated

string (date-time)
error_causestring or null(Error Cause)
Any of:

Cause details in case of error.

string
idstring(Id)obligatoire

Unique mandate identifier

peppol_addressstring or null(Peppol Address)
Any of:

Peppol electronic address (for ACTIVE mandates only)

string
]
Response
[
  {
    "client_id": "string",
    "start_date": "2019-08-24T14:15:22Z",
    "end_date": "2019-08-24T14:15:22Z",
    "file_attachment": "string",
    "status": "processing",
    "directory_entry": {},
    "emit_only": false,
    "vat_regime": "real_normal_monthly",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "error_cause": "string",
    "id": "string",
    "peppol_address": "string"
  }
]