Ir para o conteúdo principal

Abastecimento | 2025 -

Tipo Envio: Balancete - Frota

Chave Unicidade

 [ Exercício - Código Unidade Gestora - Ano - Mês - Tipo Combustível - Categoria - Código ]


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
ano
mes
tipoCombustivel Tabela Tipo Combustível
tipoCategoriaFrota Tabela Tipo Categoria Frota
codigo Quando a categoria for veículo, o identificador deve corresponder à placa do veículo
Quando a categoria for máquina, o identificador deve corresponder ao código da máquina
quantidade
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 Abastecimentos",
  "description": "Lista de objetos representando a entidade Abastecimento",
  "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": "Abastecimento",
        "description": "Representação do schema para envio da entidade Abastecimento",
        "type": "object",
        "properties": {
          "ano": {
            "type": "string",
            "minLength": 4,
            "maxLength": 4,
            "pattern": "^[0-9]{4}$"
          },
          "mes": {
            "type": "string",
            "minLength": 2,
            "maxLength": 2,
            "pattern": "^[0-9]$"
          },
          "tipoCombustivel": {
            "type": "string",
            "minLength": 1,
            "maxLength": 1,
            "pattern": "^[0-9]$"
          },
          "tipoCategoriaFrota": {
            "type": "string",
            "minLength": 1,
            "maxLength": 1,
            "pattern": "^[0-9]$"
          },
          "codigo": {
            "type": "string",
            "minLength": 7,
            "maxLength": 7
          },
          "quantidade": {
            "type": "number",
            "minimum": 0
          },
          "action": {
            "type": "string",
            "enum": [
              "CREATE",
              "UPDATE",
              "DELETE"
            ]
          }
        },
        "required": [
          "ano",
          "mes",
          "tipoCombustivel",
          "tipoCategoriaFrota",
          "codigo",
          "quantidade",
          "action"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "timestamp",
    "elementos"
  ],
  "additionalProperties": false
}

Exemplo de Payload
{
  "timestamp": "2025-09-11T15:30:00.123456",
  "elementos": [
    {
      "ano": "2025",
      "mes": "09",
      "tipoCombustivel": "2",
      "tipoCategoriaFrota": "1",
      "codigo": "ABC1234",
      "quantidade": 500.50,
      "action": "CREATE"
    },
    {
      "ano": "2025",
      "mes": "09",
      "tipoCombustivel": "4",
      "tipoCategoriaFrota": "2",
      "codigo": "0000001",
      "quantidade": 125.75,
      "action": "CREATE"
    },
    {
      "ano": "2025",
      "mes": "09",
      "tipoCombustivel": "1",
      "tipoCategoriaFrota": "1",
      "codigo": "XYZ9876",
      "quantidade": 0,
      "action": "CREATE"
    }
  ]
}

Regras

ID Regra
ABASTECIMENTO_DUPLICIDADE_NAO_PERMITIDA Não é permitido cadastrar registros duplicados pela chave de unicidade
ABASTECIMENTO_OBRIGATORIO_ENVIO É obrigatório o envio destas informações mesmo que não haja abastecimento naquele mês de referência, exceto para os veículos baixados do patrimônio
ABASTECIMENTO_GAS_NATURAL_UNIDADE_M3 Para os veículos abastecidos com gás natural, a unidade de medida da quantidade abastecida será em m³
ABASTECIMENTO_REQUER_SITUACAO_FROTA Não poderá ser informado veículo/máquina em Abastecimento sem que esteja informado no arquivo SITUACAOFROTA