📅 Get the mandate's VAT regime and derived transmission periodicity

Requête

Get the periodicity settings of a mandate, derived from its VAT regime.

Sécurité

APIKeyHeader

Chemin

mandate_idstring(Mandate Id)obligatoire

Mandate ID

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/settings/periodicity/{mandate_id}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'X-PDP-Client-Id: client_abc123'

Réponses

Successful Response

Corpsapplication/json

mandate_idstring(Mandate Id)obligatoire

Mandate these settings apply to

vat_regimestring(VATRegime)obligatoire

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

Enum:"real_normal_monthly""real_normal_quarterly""simplified""franchise"

transaction_periodicitystring(TransactionPeriodicity)obligatoire

Frequency for transaction data, imposed by the VAT regime

Enum:"monthly""decade""bimonthly"

payment_periodicitystring(PaymentPeriodicity)obligatoire

Frequency for payment data, imposed by the VAT regime

Enum:"monthly""bimonthly"

Response

{
  "mandate_id": "string",
  "vat_regime": "real_normal_monthly",
  "transaction_periodicity": "monthly",
  "payment_periodicity": "monthly"
}