Skip to content

⚙️ Settings

Configure client preferences

Operations

📅 Set the mandate's VAT regime (determines transmission periodicity)

Request

Set the VAT regime of a mandate.

The VAT regime determines the data transmission periodicity:

  • real_normal_monthly: Régime réel normal mensuel
  • real_normal_quarterly: Régime réel normal trimestriel
  • simplified: Régime simplifié d'imposition
  • franchise: Franchise en base de TVA
Security
APIKeyHeader
Path
mandate_idstring(Mandate Id)required

Mandate ID

Headers
X-PDP-Client-Idstring(X-Pdp-Client-Id)required

ID of the PDP Client for which the operation is performed

Examples:
Sandbox client
client_abc123
Bodyapplication/jsonrequired
vat_regimestring(VATRegime)required

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

Enum:"real_normal_monthly""real_normal_quarterly""simplified""franchise"
curl -i -X PUT \
  'https://pdp.seqino.dev/api/settings/periodicity/{mandate_id}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -H 'X-PDP-Client-Id: client_abc123' \
  -d '{
    "vat_regime": "real_normal_monthly"
  }'

Responses

Periodicity settings saved successfully

Bodyapplication/json
mandate_idstring(Mandate Id)required

Mandate these settings apply to

vat_regimestring(VATRegime)required

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

Enum:"real_normal_monthly""real_normal_quarterly""simplified""franchise"
transaction_periodicitystring(TransactionPeriodicity)required

Frequency for transaction data, imposed by the VAT regime

Enum:"monthly""decade""bimonthly"
payment_periodicitystring(PaymentPeriodicity)required

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"
}