Ir para o conteúdo principal

Receita Extra | Schema V1 | 2025 - ∞

Tipo Envio: Diário

Objeto Raiz
Campo Informações
timestamp Campo utilizado para ordenar a validação das informações enviadas. Caso sejam enviados múltiplos payloads do mesmo tipo, a ordenação ocorrerá da data mais antiga para a mais recente
elementos

Item
Campo Chave Informações
numeroReceitaExtra
exercicio
codigoContaContabil Tabela Plano de Contas
dataReceitaExtra
cpfCnpjFornecedor Fornecedores
exercicioFonteRecurso ATUAL / ANTERIOR
codigoFonteRecurso Definido pela Secretaria do Tesouro Nacional e disponibilizada pela Matriz de Saldos Contábeis - MSC
codigoBancoContaBancaria Código da FEBRABAN
numeroContaBancaria
numeroAgenciaContaBancaria
tipoContaBancaria Tabela Tipo Conta Bancária
cnpjGerenciaContaBancaria
valorReceitaExtra
historico
codigoReceitaExtra Tabela Código Receita Extra
codigoUnidadeGestoraRetencao
codigoUnidadeOrcamentariaRetencao Código da Unidade Orçamentária cadastrado pela Unidade Gestora para o exercício
anoEmissaoEmpenho
numeroEmpenho
numeroPagamento
tipoRetencao Tabela Tipo Retenção
action Define a operação a ser realizada com a informação, seja ela criação, atualização ou exclusão

Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Lista de Receitas Extraorçamentárias",
  "description": "Lista de objetos representando a entidade Receita Extraorçamentária",
  "type": "object",
  "properties": {
    "timestamp": {
      "type": "string",
      "pattern": "^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])T([01]\\d|2[0-3]):([0-5]\\d):([0-5]\\d)\\.\\d{3,6}$",
      "examples": ["2025-09-11T15:30:00.123456"]
    },
    "elementos": {
      "type": "array",
      "uniqueItems": true,
      "items": {
        "title": "Receita Extraorçamentária",
        "description": "Representação do schema para envio da entidade Receita Extraorçamentária",
        "type": "object",
        "properties": {
          "numeroReceitaExtra": {
            "type": "string",
            "minLength": 7,
            "maxLength": 7,
            "pattern": "^[0-9]+$"
          },
          "codigoContaContabil": {
            "type": "string",
            "minLength": 9,
            "maxLength": 9,
            "pattern": "^[0-9]+$"
          },
          "dataReceitaExtra": {
            "type": "string",
            "format": "date"
          },
          "cpfCnpjFornecedor": {
            "type": "string",
            "minLength": 14,
            "maxLength": 14,
            "pattern": "^[0-9]+$"
          },
          "exercicioFonteRecurso": {
            "type": "string",
            "minLength": 1,
            "maxLength": 1,
            "pattern": "^[0-9]+$"
          },
          "codigoFonteRecurso": {
            "type": "string",
            "minLength": 3,
            "maxLength": 3,
            "pattern": "^[0-9]+$"
          },
          "numeroContaBancaria": {
            "type": "string",
            "minLength": 1,
            "maxLength": 13,
            "pattern": "^[0-9]+$"
          },
          "numeroAgenciaContaBancaria": {
            "type": "string",
            "minLength": 1,
            "maxLength": 6,
            "pattern": "^[0-9]+$"
          },
          "codigoBancoContaBancaria": {
            "type": "string",
            "minLength": 3,
            "maxLength": 3,
            "pattern": "^[0-9]+$"
          },
          "tipoContaBancaria": {
            "type": "string",
            "minLength": 1,
            "maxLength": 1,
            "pattern": "^[0-9]+$"
          },
          "valorReceitaExtra": {
            "type": "number",
            "exclusiveMinimum": 0
          },
          "historico": {
            "type": "string",
            "minLength": 10,
            "maxLength": 500
          },
          "codigoReceitaExtra": {
            "type": "string",
            "minLength": 8,
            "maxLength": 8,
            "pattern": "^[0-9]+$"
          },
          "exercicio": {
            "type": "string",
            "minLength": 4,
            "maxLength": 4,
            "pattern": "^[0-9]+$"
          },
          "codigoUnidadeGestoraRetencao": {
            "type": "string",
            "minLength": 6,
            "maxLength": 6,
            "pattern": "^[0-9]+$"
          },
          "codigoUnidadeOrcamentariaRetencao": {
            "type": "string",
            "minLength": 5,
            "maxLength": 5,
            "pattern": "^[0-9]+$"
          },
          "anoEmissaoEmpenho": {
            "type": "string",
            "minLength": 4,
            "maxLength": 4,
            "pattern": "^[0-9]+$"
          },
          "numeroEmpenho": {
            "type": "string",
            "minLength": 7,
            "maxLength": 7,
            "pattern": "^[0-9]+$"
          },
          "numeroPagamento": {
            "type": "string",
            "minLength": 7,
            "maxLength": 7,
            "pattern": "^[0-9]+$"
          },
          "tipoRetencao": {
            "type": "string",
            "minLength": 1,
            "maxLength": 1,
            "pattern": "^[0-9]+$"
          },
          "cnpjGerenciaContaBancaria": {
            "type": "string",
            "minLength": 14,
            "maxLength": 14,
            "pattern": "^[0-9]+$"
          },
          "action": {
            "type": "string",
            "enum": ["CREATE", "UPDATE", "DELETE"]
          }
        },
        "required": [
          "numeroReceitaExtra",
          "codigoContaContabil",
          "dataReceitaExtra",
          "cpfCnpjFornecedor",
          "exercicioFonteRecurso",
          "codigoFonteRecurso",
          "numeroContaBancaria",
          "numeroAgenciaContaBancaria",
          "codigoBancoContaBancaria",
          "tipoContaBancaria",
          "valorReceitaExtra",
          "historico",
          "codigoReceitaExtra",
          "exercicio",
          "codigoUnidadeGestoraRetencao",
          "codigoUnidadeOrcamentariaRetencao",
          "anoEmissaoEmpenho",
          "numeroEmpenho",
          "numeroPagamento",
          "tipoRetencao",
          "cnpjGerenciaContaBancariaContaBancaria",
          "action"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": ["timestamp", "elementos"],
  "additionalProperties": false
}

Exemplo de Payload
{
  "timestamp": "2025-09-11T15:30:00.123456",
  "elementos": [
    {
      "numeroReceitaExtra": "1234567",
      "codigoContaContabil": "123456789",
      "dataReceitaExtra": "2025-09-11",
      "cpfCnpjFornecedor": "12345678000190",
      "exercicioFonteRecurso": "1",
      "codigoFonteRecurso": "100",
      "numeroContaBancaria": "1234567890123",
      "numeroAgenciaContaBancaria": "123456",
      "codigoBancoContaBancaria": "001",
      "tipoContaBancaria": "1",
      "valorReceitaExtra": 50000.00,
      "historico": "Receita de imposto sobre serviços",
      "codigoReceitaExtra": "12345678",
      "exercicio": "2025",
      "codigoUnidadeGestoraRetencao": "123456",
      "codigoUnidadeOrcamentariaRetencao": "12345",
      "anoEmissaoEmpenho": "2025",
      "numeroEmpenho": "1234567",
      "numeroPagamento": "0001001",
      "tipoRetencao": "1",
      "cnpjGerenciaContaBancaria": "12345678000190",
      "action": "CREATE"
    },
    {
      "numeroReceitaExtra": "7654321",
      "codigoContaContabil": "987654321",
      "dataReceitaExtra": "2025-08-20",
      "cpfCnpjFornecedor": "98765432000188",
      "exercicioFonteRecurso": "2",
      "codigoFontRecurso": "200",
      "numeroContaBancaria": "9876543210987",
      "numeroAgenciaContaBancaria": "654321",
      "codigoBancoContaBancaria": "033",
      "tipoContaBancaria": "2",
      "valorReceitaExtra": 25000.50,
      "historico": "Receita de taxa de licença",
      "codigoReceitaExtra": "87654321",
      "exercicio": "2024",
      "codigoUnidadeGestoraRetencao": "654321",
      "codigoUnidadeOrcamentariaRetencao": "54321",
      "anoEmissaoEmpenho": "2024",
      "numeroEmpenho": "7654321",
      "numeroPagamento": "0002001",
      "tipoRetencao": "2",
      "cnpjGerenciaContaBancaria": "98765432000199",
      "action": "DELETE"
    }
  ]
}