Criar 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
Criar Tipo de Recibo
Regista um tipo de recibo personalizado com um JSON Schema para validação de carga útil.
POST
/
v1
/
receipt-types
Criar 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
}Cria um tipo de recibo personalizado para o inquilino com um JSON Schema para validação de payload. Tipos definidos pela plataforma (
payment_receipt, security_event_receipt, delivery_receipt, compliance_receipt, custom_receipt) são somente leitura e não podem ser substituídos ou alterados.
Tipos personalizados são isolados para o inquilino autenticado por segurança em nível de linha. Outros inquilinos não podem ver ou usar seus tipos personalizados.
Corpo da solicitação
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | Identificador único em snake_case (por exemplo, invoice_receipt). Não deve entrar em conflito com nomes de tipos de plataforma. |
display_name | string | Sim | Rótulo legível por humanos exibido na UI do console. |
version | string | Não | String SemVer (padrão 1.0.0). Crie várias versões para gerenciar a evolução do esquema. |
schema | object | Sim | Esquema JSON válido (rascunho 2020-12) descrevendo a estrutura payload necessária. |
description | string | Não | Descrição em texto simples para documentação. |
Requisitos de Esquema
O camposchema deve ser um JSON Schema válido (rascunho 2020-12). Inclua um array required para impor campos de payload obrigatórios ao cunhar.
{
"$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
}
Versionamento
Crie várias versões do mesmo tipo passando diferentes valores deversion (1.0.0, 2.0.0, etc.). Os recibos sempre fixam a versão no momento da cunhagem, então os recibos existentes não são afetados quando você introduz uma nova versão.
Para depreciar uma versão antiga, use PATCH /v1/receipt-types/{name} com {"status": "deprecated"}.
Respostas
Corpo
application/json

