Ir para o conteúdo principal

Credor | 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
credores

Item
Campo Chave Informações
cpfCnpj
nomeCredor
tipoCredor Tabela Tipo Credor
nomeCredor
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": "Credor",
  "description": "Schema para envio de credores 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"]
    },
    "credores": {
      "type": "array",
      "uniqueItems": true,
      "items": {
        "type": "object",
        "properties": {
          "cpfCnpjCredor": {
            "type": "string",
            "minLength": 11,
            "maxLength": 14,
            "pattern": "^[0-9]+$"
          },
          "nomeCredor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 80
          },
          "tipoCredor": {
            "type": "string",
            "minLength": 1,
            "maxLength": 1,
            "pattern": "^[0-9]+$"
          },
          "action": {
            "type": "string",
            "enum": ["CREATE", "UPDATE", "DELETE"]
          }
        },
        "required": [
          "cpfCnpjCredor",
          "nomeCredor",
          "tipoCredor",
          "action"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": ["timestamp", "credores"],
  "additionalProperties": false
}

Exemplo de Payload
{
  "timestamp": "2025-09-11T15:30:00.123456",
  "credores": [
    {
      "cpfCnpjCredor": "12345678000199",
      "nomeCredor": "Empresa Fornecedora de Materiais LTDA",
      "tipoCredor": "1",
      "action": "CREATE"
    },
    {
      "cpfCnpjCredor": "98765432100",
      "nomeCredor": "João da Silva Pereira",
      "tipoCredor": "2",
      "action": "UPDATE"
    },
    {
      "cpfCnpjCredor": "11122233000177",
      "nomeCredor": "Construtora Municipal S.A.",
      "tipoCredor": "3",
      "action": "DELETE"
    }
  ]
}