Saltar al contenido principal
POST
Crear tipo de recibo
Crea un tipo de recibo personalizado por inquilino con un esquema JSON para la validación de la carga útil. Los tipos definidos por la plataforma (payment_receipt, security_event_receipt, delivery_receipt, compliance_receipt, custom_receipt) son de solo lectura y no se pueden anular ni reemplazar. Los tipos personalizados están aislados al inquilino autenticado por seguridad a nivel de fila. Otros inquilinos no pueden ver ni usar sus tipos personalizados.

Cuerpo de la solicitud

Requisitos de esquema

El campo schema debe ser un esquema JSON válido (borrador 2020-12). Incluya una matriz required para hacer cumplir los campos de carga útil obligatorios al acuñar.

Control de versiones

Cree múltiples versiones del mismo tipo pasando diferentes valores de version (1.0.0, 2.0.0, etc.). Los recibos siempre fijan la versión en el momento de la acuñación, por lo que los recibos existentes no se ven afectados cuando introduce una nueva versión. Para dejar de usar una versión antigua, use PATCH /v1/receipt-types/{name} con {"status": "deprecated"}.

Respuestas

Autorizaciones

X-API-Key
string
header
requerido

Clave API para autenticación máquina a máquina

Cuerpo

application/json
display_name
string
requerido

Nombre legible por humanos

name
string
requerido

Nombre del tipo de recibo legible por máquina

schema
any
requerido

Esquema JSON para la validación de la carga útil

description
string | null
version
string

Respuesta

Tipo de recibo creado

name
string
display_name
string
schema
object
created_at
string