> ## Documentation Index
> Fetch the complete documentation index at: https://docs.truthlocks.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Criar Tipo de Recibo

> Regista um tipo de recibo personalizado com um JSON Schema para validação de carga útil.

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 campo `schema` deve ser um JSON Schema válido (rascunho 2020-12). Inclua um array `required` para impor campos de payload obrigatórios ao cunhar.

```json theme={null}
{
  "$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 de `version` (`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


## OpenAPI

````yaml pt/mint-openapi.yaml POST /v1/receipt-types
openapi: 3.0.3
info:
  title: Truthlocks API
  description: >-
    Truthlocks é uma infraestrutura de verificação universal para documentos,
    credenciais e ativos digitais.

    Esta especificação define a API canônica para interagir com os serviços
    Truthlocks.


    ## URLs Base

    - **Produção**: `https://api.truthlocks.com`

    - **Sandbox**: `https://sandbox-api.truthlocks.com`


    ## Autenticação

    - **Chaves de API**: Use o cabeçalho `X-API-Key` para operações máquina a
    máquina

    - **Tokens de Portador**: Use `Authorization: Bearer <jwt>` para operações
    iniciadas pelo usuário


    ## Identidade do Inquilino

    Em produção, a identidade do inquilino é derivada do contexto autenticado
    (chave de API ou JWT).

    O cabeçalho `X-Tenant-ID` é ignorado em produção para evitar falsificação.
  version: 1.0.0
  contact:
    name: Truthlocks Support
    url: https://truthlocks.com/support
    email: support@truthlocks.com
servers:
  - url: https://api.truthlocks.com
    description: API de Produção
  - url: https://sandbox-api.truthlocks.com
    description: Ambiente Sandbox
security:
  - APIKey: []
  - BearerAuth: []
tags:
  - name: Authentication
    description: Gerenciamento de chaves e tokens de API
  - name: Issuers
    description: Registro do emissor e gerenciamento de confiança
  - name: Keys
    description: Gerenciamento de chaves criptográficas para emissores
  - name: Attestations
    description: Ciclo de vida da atestação (cunhar, revogar, substituir)
  - name: Verification
    description: Verificação de atestado e pacotes de prova
  - name: Governance
    description: Fluxos de trabalho de governança do emissor (somente administrador)
  - name: Identity
    description: Gerenciamento de organização, usuário e função
  - name: Audit
    description: Consultas de eventos de auditoria
  - name: Tenant Console
    description: Endpoints de perfil e ciclo de vida do locatário
  - name: Health
    description: Endpoints de saúde e prontidão do serviço
  - name: Risk
    description: Ingestão de sinal de risco e detecção de fraude
  - name: Risk Enforcement
    description: Ações de aplicação de risco — bloqueio, desafio, quarentena e configuração
  - name: Billing
    description: Gerenciamento de faturamento, assinatura e complementos
  - name: Machine Identity
    description: >-
      Protocolo de Identidade de Agente de Máquina (MAIP) — registro de agente,
      sessões, confiança, testemunha, conformidade, orquestração e
      observabilidade
externalDocs:
  description: API somente leitura de transparência (especificação de serviço separada)
  url: >-
    https://github.com/truthlocks/truthlock/blob/main/docs/transparency/openapi.yaml
paths:
  /v1/receipt-types:
    post:
      tags:
        - Receipts
      summary: Criar tipo de recibo
      description: >-
        Regista um tipo de recibo personalizado com um JSON Schema para
        validação de carga útil.
      operationId: receiptTypes.create
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                description:
                  nullable: true
                  type: string
                display_name:
                  type: string
                  description: Nome legível por humanos
                name:
                  type: string
                  description: Nome do tipo de recibo legível por máquina
                schema:
                  description: JSON Schema para validação de carga útil
                version:
                  type: string
              type: object
              required:
                - name
                - display_name
                - schema
      responses:
        '201':
          description: Tipo de recibo criado
          content:
            application/json:
              schema:
                type: object
                properties:
                  name:
                    type: string
                  display_name:
                    type: string
                  schema:
                    type: object
                  created_at:
                    type: string
        '401':
          description: Autenticação necessária
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
      security:
        - APIKey: []
components:
  schemas:
    ErrorEnvelope:
      type: object
      required:
        - code
        - message
        - http_status
      properties:
        code:
          type: string
          description: Código de erro legível por máquina
          enum:
            - AUTH_REQUIRED
            - AUTH_INVALID
            - PERMISSION_DENIED
            - TENANT_IDENTITY_UNVERIFIED
            - NOT_FOUND
            - VALIDATION_ERROR
            - CONFLICT
            - PAYLOAD_TOO_LARGE
            - RATE_LIMIT_EXCEEDED
            - QUOTA_EXCEEDED
            - SERVICE_UNAVAILABLE
            - INTERNAL_ERROR
        message:
          type: string
          description: Mensagem de erro legível por humanos
        http_status:
          type: integer
          description: Código de status HTTP
        retry_after_ms:
          type: integer
          description: >-
            Milissegundos para aguardar antes de tentar novamente (para limites
            de taxa)
        details:
          type: object
          description: Contexto de erro adicional
      example:
        code: AUTH_REQUIRED
        message: Authentication required
        http_status: 401
  securitySchemes:
    APIKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: Chave de API para autenticação máquina a máquina
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT para operações iniciadas pelo usuário

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.