Belegtyp erstellen
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
}Belege
Belegtyp erstellen
Registriert einen benutzerdefinierten Belegtyp mit einem JSON-Schema zur Nutzlastvalidierung.
POST
/
v1
/
receipt-types
Belegtyp erstellen
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
}Erstellt einen mandanten-spezifischen Belegtyp mit einem JSON-Schema zur Nutzlastvalidierung. Plattformdefinierte Typen (
payment_receipt, security_event_receipt, delivery_receipt, compliance_receipt, custom_receipt) sind schreibgeschützt und können nicht überschrieben oder ersetzt werden.
Benutzerdefinierte Typen sind durch zeilenbasierte Sicherheit auf den authentifizierten Mandanten isoliert. Andere Mandanten können Ihre benutzerdefinierten Typen nicht sehen oder verwenden.
Anfragetext
| Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
name | string | Ja | Eindeutiger snake_case-Bezeichner (z. B. invoice_receipt). Darf nicht mit Plattformtypnamen kollidieren. |
display_name | string | Ja | Im Konsolen-UI angezeigte, menschenlesbare Bezeichnung. |
version | string | Nein | SemVer-String (Standard 1.0.0). Erstellen Sie mehrere Versionen, um die Schemaentwicklung zu verwalten. |
schema | object | Ja | Gültiges JSON-Schema (Entwurf 2020-12), das die erforderliche payload-Struktur beschreibt. |
description | string | Nein | Klartextbeschreibung für die Dokumentation. |
Schema-Anforderungen
Das Feldschema muss ein gültiges JSON-Schema (Entwurf 2020-12) sein. Fügen Sie ein required-Array hinzu, um obligatorische Payload-Felder beim Minting zu erzwingen.
{
"$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
}
Versionierung
Erstellen Sie mehrere Versionen desselben Typs, indem Sie verschiedeneversion-Werte (1.0.0, 2.0.0 usw.) übergeben. Belege fixieren immer die Version zum Zeitpunkt der Prägung, sodass bestehende Belege unberührt bleiben, wenn Sie eine neue Version einführen.
Um eine alte Version zu verwerfen, verwenden Sie PATCH /v1/receipt-types/{name} mit {"status": "deprecated"}.
Antworten
Autorisierungen
Body
application/json

