Ir para o conteúdo principal

Pagamento | 2025 ~

Tipo Envio: Diário
Chave Unicidade

[ Exercício - Código Unidade Gestora - Código Unidade Orçamentária - Número Empenho - Número Liquidação - Número Pagamento ]

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
codigoUnidadeOrcamentaria ✅ –
numeroEmpenho ✅ –
numeroLiquidacao ✅ –
numeroPagamento ✅ –
valorPagamento – –
codigoBancoContaBancaria – –
numeroContaBancaria – –
tipoContaBancaria – –
numeroAgenciaContaBancaria – –
cnpjGerenciaContaBancaria – –
numeroDocumentoDebito – –
codigoBancoContaBancariaCredor – –
numeroAgenciaContaBancariaCredor – –
numeroContaBancariaCredor – –
action – CREATE / UPDATE / DELETE 
Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Pagamentos",
  "description": "Schema para envio de pagamentos por unidade gestora",
  "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": {
        "type": "object",
        "properties": {
          "codigoUnidadeOrcamentaria": {
            "type": "string",
            "minLength": 5,
            "maxLength": 5,
            "pattern": "^[0-9]+$"
          },
          "numeroEmpenho": {
            "type": "string",
            "minLength": 7,
            "maxLength": 7,
            "pattern": "^[0-9]+$"
          },
          "numeroLiquidacao": {
            "type": "string",
            "minLength": 7,
            "maxLength": 7,
            "pattern": "^[0-9]+$"
          },
          "numeroPagamento": {
            "type": "string",
            "minLength": 7,
            "maxLength": 7,
            "pattern": "^[0-9]+$"
          },
          "valorPagamento": {
            "type": "number",
            "exclusiveMinimum": 0
          },
          "codigoBancoContaBancaria": {
            "type": "string",
            "maxLength": 3
          },
          "numeroContaBancaria": {
            "type": "string",
            "maxLength": 13
          },
          "tipoContaBancaria": {
            "type": "string",
            "minLength": 1,
            "maxLength": 1,
            "pattern": "^[0-9]+$"
          },
          "numeroAgenciaContaBancaria": {
            "type": "string",
            "maxLength": 6
          },
          "cnpjGerenciaContaBancaria": {
            "type": "string",
            "minLength": 14,
            "maxLength": 14
          },
          "numeroDocumentoDebito": {
            "type": "string",
            "maxLength": 11
          },
          "codigoBancoContaBancariaCredor": {
            "type": "string",
            "maxLength": 3
          },
          "numeroAgenciaContaBancariaCredor": {
            "type": "string",
            "maxLength": 6
          },
          "numeroContaBancariaCredor": {
            "type": "string",
            "maxLength": 13
          },
          "action": {
            "type": "string",
            "enum": ["CREATE", "UPDATE", "DELETE"]
          }
        },
        "required": [
          "codigoUnidadeOrcamentaria",
          "numeroEmpenho",
          "numeroLiquidacao",
          "numeroPagamento",
          "valorPagamento",
          "codigoBancoContaBancaria",
          "numeroContaBancaria",
          "tipoContaBancaria",
          "numeroAgenciaContaBancaria",
          "cnpjGerenciaContaBancaria",
          "numeroDocumentoDebito",
          "codigoBancoContaBancariaCredor",
          "numeroAgenciaContaBancariaCredor",
          "numeroContaBancariaCredor",
          "action"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": ["timestamp", "elementos"],
  "additionalProperties": false
}
Exemplo de Payload
{
  "timestamp": "2025-09-11T15:30:00.123456",
  "pagamentos": [
    {
      "codigoUnidadeOrcamentaria": "17050",
      "numeroEmpenho": "0001234",
      "numeroLiquidacao": "0000001",
      "numeroPagamento": "0000001",
      "valorPagamento": 15000.00,
      "codigoBancoContaBancaria": "001",
      "numeroContaBancaria": "12345678901",
      "tipoContaBancaria": "1",
      "numeroAgenciaContaBancaria": "1234",
      "cnpjGerenciaContaBancaria": "12345678000195",
      "numeroDocumentoDebito": "12345678901",
      "codigoBancoContaBancariaCredor": "341",
      "numeroAgenciaContaBancariaCredor": "5678",
      "numeroContaBancariaCredor": "98765432100",
      "action": "CREATE"
    }
  ]
}

Regras

ID Regra
PAGAMENTO_DUPLICIDADE_NAO_PERMITIDA Não é permitido cadastrar registros duplicados pela chave de unicidade
PAGAMENTO_CONTA_BANCARIA_CADASTRADA A conta bancária deve ter sido cadastrada para a Unidade Gestora no exercício do envio
PAGAMENTO_CONTA_CREDOR_CADASTRADA A conta do credor deve ter sido cadastrada para a Unidade Gestora 
PAGAMENTO_LIQUIDACAO_CADASTRADA A Liquidação referenciada deve ter sido cadastrada para a Unidade Gestora no exercício do envio
PAGAMENTO_VALOR_PAGO_EXCEDE_VALOR_LIQUIDADO A soma do valor pago não pode superar o valor liquidado

O valor líquido pago (pago - estornado pago) não pode exceder o valor líquido liquidado (liquidado - estornado liquidado) até a data do envio.

Nenhum comentário para exibir

Voltar ao topo