Entidades - Farmácia

Esta página apresenta todas as informações para o recebimento dos dados de farmácia no SAGRES Captura 2.0.


⚠️ Páginas com a tag [WIP] ainda estão em revisão pelo TCE e/ou não foram implementadas, podendo sofrer alterações.

Estoque Farmácia


Estoque Farmácia

Estoque Farmácia | 2025 -

Tipo Envio: Balancete - Farmácia

Chave Unicidade

 [ Exercício - Mês - Código Unidade Gestora - Código Farmácia - Código Produto ]


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
codigoFarmacia
codigoProduto
descricaoProduto
unidadeMedida
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 Estoques Farmácia",
  "description": "Lista de objetos representando a entidade Estoque Farmácia",
  "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": "Estoque Farmácia",
        "description": "Representação do schema para envio da entidade Estoque Farmácia",
        "type": "object",
        "properties": {
          "codigoFarmacia": {
            "type": "string",
            "minLength": 7,
            "maxLength": 7,
            "pattern": "^[A-Z0-9]+$"
          },
          "codigoProduto": {
            "type": "string",
            "minLength": 14,
            "maxLength": 14,
            "pattern": "^[A-Z0-9]+$"
          },
          "descricaoProduto": {
            "type": "string",
            "minLength": 10,
            "maxLength": 60
          },
          "unidadeMedida": {
            "type": "string",
            "minLength": 1,
            "maxLength": 10
          },
          "quantidade": {
            "type": "number",
            "minimum": 0
          },
          "action": {
            "type": "string",
            "enum": [
              "CREATE",
              "UPDATE",
              "DELETE"
            ]
          }
        },
        "required": [
          "codigoFarmacia",
          "codigoProduto",
          "descricaoProduto",
          "unidadeMedida",
          "quantidade",
          "action"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "timestamp",
    "elementos"
  ],
  "additionalProperties": false
}

Exemplo de Payload
{
  "timestamp": "2025-09-11T15:30:00.123456",
  "elementos": [
    {
      "codigoFarmacia": "0000001",
      "codigoProduto": "00000000000001",
      "descricaoProduto": "Dipirona 500mg Comprimido Para dor e febre",
      "unidadeMedida": "comprimido",
      "quantidade": 1500.50,
      "action": "CREATE"
    },
    {
      "codigoFarmacia": "0000002",
      "codigoProduto": "00000000000002",
      "descricaoProduto": "Amóxicilina 500mg Cápsula Antibiótico",
      "unidadeMedida": "cápsula",
      "quantidade": 2500.00,
      "action": "UPDATE"
    }
  ]
}

Regras

ID Regra
ESTOQUE_FARMACIA_DUPLICIDADE_NAO_PERMITIDA Não é permitido cadastrar registros duplicados pela chave de unicidade
ESTOQUE_FARMACIA_FARMACIA_CADASTRADA A farmácia deve ter sido cadastrada para unidade gestora no exercício

Farmácia


Farmácia

Farmácia | 2025 -

Tipo Envio: Balancete - Farmácia

Chave Unicidade

 [ Exercício - Código Unidade Gestora - Código Farmácia - Descrição - Tipo Logradouro - Número Logradouro - Complemento Logradouro - CEP Logradouro - Nome Responsável - CPF Responsável - CRF Responsável ]


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
codigoFarmacia
descricao
tipoLogradouro
numeroLogradouro
complementoLogradouro
cepLogradouro
nomeResponsavel
cpfResponsavel
crfResponsavel
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 Farmácias",
  "description": "Lista de objetos representando a entidade Farmácia",
  "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": "Farmácia",
        "description": "Representação do schema para envio da entidade Farmácia",
        "type": "object",
        "properties": {
          "codigoFarmacia": {
            "type": "string",
            "minLength": 7,
            "maxLength": 7,
            "pattern": "^[A-Z0-9]+$"
          },
          "descricao": {
            "type": "string",
            "minLength": 10,
            "maxLength": 100
          },
          "tipoLogradouro": {
            "type": "string",
            "minLength": 1,
            "maxLength": 150
          },
          "numeroLogradouro": {
            "type": "string",
            "minLength": 1,
            "maxLength": 50
          },
          "cepLogradouro": {
            "type": "string",
            "minLength": 1,
            "maxLength": 30
          },
          "complementoLogradouro": {
            "type": "string",
            "minLength": 1,
            "maxLength": 300
          },
          "nomeResponsavel": {
            "type": "string",
            "minLength": 10,
            "maxLength": 150
          },
          "cpfResponsavel": {
            "type": "string",
            "minLength": 11,
            "maxLength": 11,
            "pattern": "^[0-9]+$"
          },
          "crfResponsavel": {
            "type": "string",
            "minLength": 10,
            "maxLength": 10
          },
          "action": {
            "type": "string",
            "enum": [
              "CREATE",
              "UPDATE",
              "DELETE"
            ]
          }
        },
        "required": [
          "codigoFarmacia",
          "descricao",
          "numeroLogradouro",
          "cepLogradouro",
          "tipoLogradouro",
          "complementoLogradouro",
          "nomeResponsavel",
          "cpfResponsavel",
          "crfResponsavel",
          "action"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "timestamp",
    "elementos"
  ],
  "additionalProperties": false
}

Exemplo de Payload
{
  "timestamp": "2025-09-11T15:30:00.123456",
  "elementos": [
    {
      "codigoFarmacia": "1234567",
      "descricao": "Farmácia Central da Cidade",
      "tipoLogradouro": "Rua",
      "numeroLogradouro": "123",
      "cepLogradouro": "58000000",
      "complementoLogradouro": "Próximo ao mercado central",
      "nomeResponsavel": "João da Silva Santos",
      "cpfResponsavel": "12345678901",
      "crfResponsavel": "1234567890",
      "action": "CREATE"
    },
    {
      "codigoFarmacia": "7654321",
      "descricao": "Farmácia Popular Bairro Norte",
      "tipoLogradouro": "Avenida",
      "numeroLogradouro": "456",
      "cepLogradouro": "58010000",
      "complementoLogradouro": "Sala 02, ao lado da padaria",
      "nomeResponsavel": "Maria Oliveira Souza",
      "cpfResponsavel": "10987654321",
      "crfResponsavel": "0987654321",
      "action": "UPDATE"
    }
  ]
}

Regras

ID Regra
FARMACIA_DUPLICIDADE_NAO_PERMITIDA Não é permitido cadastrar registros duplicados pela chave de unicidade
FARMACIA_RESPONSAVEL_NOME_INVALIDO O nome do responsável deve ser correspondente ao cadastrado na Receita Federal