Listar tipos de recibo
curl --request GET \
--url https://api.truthlocks.com/v1/receipt-types \
--header 'X-API-Key: <api-key>'const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
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"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.truthlocks.com/v1/receipt-types"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"items": [
{
"name": "<string>",
"display_name": "<string>",
"schema": {},
"created_at": "<string>"
}
]
}{
"code": "AUTH_REQUIRED",
"message": "Authentication required",
"http_status": 401
}Recibos
Listar tipos de recibo
Retorna todos os tipos de recibo registrados para o locatário autenticado.
GET
/
v1
/
receipt-types
Listar tipos de recibo
curl --request GET \
--url https://api.truthlocks.com/v1/receipt-types \
--header 'X-API-Key: <api-key>'const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
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"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.truthlocks.com/v1/receipt-types"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"items": [
{
"name": "<string>",
"display_name": "<string>",
"schema": {},
"created_at": "<string>"
}
]
}{
"code": "AUTH_REQUIRED",
"message": "Authentication required",
"http_status": 401
}Retorna todos os tipos de recibo disponíveis para o locatário autenticado. Inclui todos os cinco tipos definidos pela plataforma (globalmente disponíveis para cada locatário) mais quaisquer tipos personalizados registrados pelo locatário.
Use este endpoint para descobrir os tipos disponíveis e inspecionar o JSON Schema que cada tipo impõe ao campo
Os tipos de plataforma têm
payload ao emitir um recibo.
Tipos definidos pela plataforma
| Nome | Nome de Exibição | Caso de Uso |
|---|---|---|
payment_receipt | Recibo de Pagamento | Pagamentos, faturas, reembolsos |
security_event_receipt | Recibo de Evento de Segurança | Eventos de autenticação, rotações de chave, anomalias |
delivery_receipt | Recibo de Entrega | Entrega de documento/credencial/notificação |
compliance_receipt | Recibo de Conformidade | KYC, AML, verificações de sanções |
custom_receipt | Recibo Personalizado | Qualquer evento definido pelo inquilino (esquema aberto) |
tenant_id: null na resposta. Os tipos personalizados de locatário incluem seu tenant_id.

