Crear tipo de recibo
curl --request POST \
--url https://api.truthlocks.com/v1/receipt-types \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"display_name": "<string>",
"name": "<string>",
"schema": "<unknown>"
}
'const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({display_name: '<string>', name: '<string>', schema: '<unknown>'})
};
fetch('https://api.truthlocks.com/v1/receipt-types', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.truthlocks.com/v1/receipt-types"
payload = {
"display_name": "<string>",
"name": "<string>",
"schema": "<unknown>"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.truthlocks.com/v1/receipt-types"
payload := strings.NewReader("{\n \"display_name\": \"<string>\",\n \"name\": \"<string>\",\n \"schema\": \"<unknown>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"name": "<string>",
"display_name": "<string>",
"schema": {},
"created_at": "<string>"
}{
"code": "AUTH_REQUIRED",
"message": "Authentication required",
"http_status": 401
}Recibos
Crear tipo de recibo
Registra un tipo de recibo personalizado con un esquema JSON para la validación de la carga útil.
POST
/
v1
/
receipt-types
Crear tipo de recibo
curl --request POST \
--url https://api.truthlocks.com/v1/receipt-types \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"display_name": "<string>",
"name": "<string>",
"schema": "<unknown>"
}
'const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({display_name: '<string>', name: '<string>', schema: '<unknown>'})
};
fetch('https://api.truthlocks.com/v1/receipt-types', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.truthlocks.com/v1/receipt-types"
payload = {
"display_name": "<string>",
"name": "<string>",
"schema": "<unknown>"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.truthlocks.com/v1/receipt-types"
payload := strings.NewReader("{\n \"display_name\": \"<string>\",\n \"name\": \"<string>\",\n \"schema\": \"<unknown>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"name": "<string>",
"display_name": "<string>",
"schema": {},
"created_at": "<string>"
}{
"code": "AUTH_REQUIRED",
"message": "Authentication required",
"http_status": 401
}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
| Campo | Tipo | Requerido | Descripción |
|---|---|---|---|
name | string | Sí | Identificador único en snake_case (por ejemplo, invoice_receipt). No debe entrar en conflicto con los nombres de tipos de plataforma. |
display_name | string | Sí | Etiqueta legible por humanos que se muestra en la interfaz de usuario de la consola. |
version | string | No | Cadena SemVer (predeterminado 1.0.0). Cree múltiples versiones para gestionar la evolución del esquema. |
schema | object | Sí | Esquema JSON válido (borrador 2020-12) que describe la estructura payload requerida. |
description | string | No | Descripción en texto plano para la documentación. |
Requisitos de esquema
El camposchema 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.
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"required": ["invoice_number", "amount", "currency"],
"properties": {
"invoice_number": { "type": "string" },
"amount": { "type": "integer", "description": "Amount in smallest currency unit" },
"currency": { "type": "string", "minLength": 3, "maxLength": 3 }
},
"additionalProperties": false
}
Control de versiones
Cree múltiples versiones del mismo tipo pasando diferentes valores deversion (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
Cuerpo
application/json

