Créer un type de reçu
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
}Reçus
Créer un type de reçu
Enregistre un type de reçu personnalisé avec un schéma JSON pour la validation de la charge utile.
POST
/
v1
/
receipt-types
Créer un type de reçu
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
}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
| Champ | Type | Requis | Description |
|---|---|---|---|
name | chaîne | Oui | Identifiant unique en snake_case (par exemple invoice_receipt). Ne doit pas entrer en conflit avec les noms de types de plateforme. |
display_name | chaîne | Oui | Libellé lisible par l’homme affiché dans l’interface utilisateur de la console. |
version | chaîne | Non | Chaîne SemVer (par défaut 1.0.0). Créez plusieurs versions pour gérer l’évolution du schéma. |
schema | object | Oui | Schéma JSON valide (brouillon 2020-12) décrivant la structure payload requise. |
description | chaîne | Non | Description en texte clair pour la documentation. |
Exigences du schéma
Le champschema 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.
{
"$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
}
Gestion des versions
Créez plusieurs versions du même type en passant différentes valeursversion (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
Corps
application/json

