Passer au contenu principal
POST
Créer un type de reçu
Crée un type de reçu personnalisé pour le locataire avec un schéma JSON pour la validation de la charge utile. Les types définis par la plateforme (payment_receipt, security_event_receipt, delivery_receipt, compliance_receipt, custom_receipt) sont en lecture seule et ne peuvent pas être remplacés ou modifiés. Les types personnalisés sont isolés au locataire authentifié par la sécurité au niveau des lignes. Les autres locataires ne peuvent pas voir ou utiliser vos types personnalisés.

Corps de la requête

Exigences du schéma

Le champ schema doit être un schéma JSON valide (brouillon 2020-12). Incluez un tableau required pour appliquer les champs de charge utile obligatoires lors de la frappe.

Gestion des versions

Créez plusieurs versions du même type en passant différentes valeurs version (1.0.0, 2.0.0, etc.). Les reçus épinglent toujours la version au moment de la frappe, de sorte que les reçus existants ne sont pas affectés lorsque vous introduisez une nouvelle version. Pour déprécier une ancienne version, utilisez PATCH /v1/receipt-types/{name} avec {"status": "deprecated"}.

Réponses

Autorisations

X-API-Key
string
header
requis

Clé API pour l'authentification machine-à-machine

Corps

application/json
display_name
string
requis

Nom lisible par l'homme

name
string
requis

Nom du type de reçu lisible par machine

schema
any
requis

Schéma JSON pour la validation de la charge utile

description
string | null
version
string

Réponse

Type de reçu créé

name
string
display_name
string
schema
object
created_at
string