11. Glossário de Integração (Dicionário de Dados)¶
Esta seção define todos os campos técnicos e de negócio utilizados nas integrações. Os nomes em inglês refletem as propriedades das classes no código-fonte (.NET) e os nomes físicos das colunas no banco de dados (PostgreSQL).
11.1 Contexto de Produto (Catalog)¶
11.1.1 Identificação e Dados Básicos (Owned: Basic)¶
| Nome Original (Código/API) | Nome Traduzido | Descrição em Português |
|---|---|---|
ean |
EAN Principal | Código de barras internacional de 13 dígitos. |
description |
Descrição Comercial | Nome do produto para exibição externa. |
internalDescription |
Descrição Interna | Nome técnico usado para processos internos. |
barCode |
Código de Barras Alternativo | Outros formatos de código de barras. |
dunCode |
Código DUN-14 | Identificador de unidades logísticas (caixas/pallets). |
skucode |
Código SKU | Stock Keeping Unit — identificação única no estoque. |
dosage |
Dosagem / Concentração | Concentração do princípio ativo (ex: 500mg, 10%). |
rmsCode |
Registro MS/RMS | Código de registro no Ministério da Saúde. |
balanceClass |
Classe de Balanço | Classificação para fins de balanço de estoque. |
hospitalPackaging |
Embalagem Hospitalar | Booleano indicando se é de uso restrito hospitalar. |
unit |
Unidade de Medida | Unidade de venda (UN, CX, FR, etc). |
dcbCode |
Código DCB | Denominação Comum Brasileira (farmacêutica). |
11.1.2 Dados Comerciais e Marketing (Owned: Commercial / Marketing)¶
| Nome Original (Código/API) | Nome Traduzido | Descrição em Português |
|---|---|---|
brand |
Marca | Fabricante ou marca detentora do item. |
activeIngredient |
Princípio Ativo | Substância química principal do medicamento. |
continuousUse |
Uso Contínuo | Indica se o medicamento é de uso prolongado. |
releasedPrice |
Preço Liberado | Preço de venda praticado sem restrições. |
priceGroup |
Grupo de Preço | Agrupamento comercial para regras de precificação. |
referenceProduct |
Produto de Referência | Nome do medicamento de referência (original). |
role |
Papel Comercial | Função do item no mix (ex: Gerador de Tráfego). |
loyaltyGroup |
Grupo de Fidelidade | Vínculo com programas de fidelização/PBM. |
metaDescription |
Meta Descrição | Texto otimizado para motores de busca (SEO). |
keyWord |
Palavras-Chave | Tags para busca interna e externa. |
specification |
Especificação Técnica | Detalhes de composição e características. |
webName |
Nome para Web | Nome amigável para lojas online. |
webUrl |
URL Permanente | Link direto para a página do produto. |
images |
Coleção de Imagens | Lista de objetos contendo o nome do arquivo e o conteúdo em Base64. |
11.1.3 Dados Fiscais e Tributários (Owned: Fiscal / TaxExtended)¶
| Nome Original (Código/API) | Nome Traduzido | Descrição em Português |
|---|---|---|
ncmCode |
NCM | Nomenclatura Comum do Mercosul (8 dígitos). |
cest |
CEST | Código de Especificador da Substituição Tributária. |
taxBurdenPercent |
Carga Tributária % | Percentual total da carga tributária estimada. |
spedTypeId |
Tipo de Item SPED | Classificação conforme guia prático da EFD. |
cstPisIn / cstPisOut |
CST PIS (E/S) | Código de Situação Tributária para PIS (Entrada e Saída). |
cstCofinsIn / cstCofinsOut |
CST COFINS (E/S) | Código de Situação Tributária para COFINS (Entrada e Saída). |
cstIcmsIn / cstIcmsOut |
CST ICMS (E/S) | Código de Situação Tributária para ICMS (Entrada e Saída). |
pisRate / cofinsRate |
Alíquotas PIS/COFINS | Percentual de alíquota efetiva para PIS e COFINS. |
ibsRate / cbsRate |
Alíquotas IBS/CBS | Percentuais para o Imposto sobre Bens e Serviços e Contribuição sobre Bens e Serviços (Reforma Tributária). |
cfopInternalIn / cfopInternalOut |
CFOP Interno (E/S) | Código Fiscal de Operações e Prestações para transações dentro do estado. |
cfopInterstateIn / cfopInterstateOut |
CFOP Interestadual (E/S) | Código Fiscal de Operações e Prestações para transações entre estados. |
mva |
MVA / IVA | Margem de Valor Agregado ou Índice de Valor Adicionado para cálculo de ST. |
taxExempt |
Isento de Imposto | Flag indicando isenção total de impostos. |
11.1.4 Dimensões e Logística (Owned: Dimensions)¶
| Nome Original (Código/API) | Nome Traduzido | Descrição em Português |
|---|---|---|
height |
Altura | Altura da embalagem individual (cm ou m). |
width |
Largura | Largura da embalagem individual. |
length |
Comprimento | Profundidade da embalagem individual. |
productWeight |
Peso | Peso líquido do produto (Kg). |
volume |
Volume | Volume total ocupado. |
boxQuantity |
Itens por Caixa | Quantidade de unidades na caixa master. |
displayQty |
Qtd no Display | Quantidade de unidades no display de balcão. |
11.1.5 Dados Regulatórios e PBM (Owned: Regulatory / Pbm)¶
| Nome Original (Código/API) | Nome Traduzido | Descrição em Português |
|---|---|---|
msRegistration |
Registro Sanitário | Número formal do registro na ANVISA. |
controlledSale |
Venda Controlada | Se requer retenção de receita (Portaria 344). |
isThermolabile |
Termolábil | Se requer refrigeração (cadeia de frio). |
retainsRevenue |
Retém Receita | Se a farmácia deve reter a via da receita. |
isPopularPharmacy |
Farmácia Popular | Se o item faz parte do programa federal. |
pbmProgram |
Programa PBM | Nome do programa de benefício em medicamentos. |
indication |
Indicação | Finalidade terapêutica do produto. |
contraindication |
Contraindicação | Restrições de uso do produto. |
11.2 Contexto de Fornecedor (Supplier)¶
11.2.1 Identificação e Localização¶
| Nome Original (Código/API) | Nome Traduzido | Descrição em Português |
|---|---|---|
erpSupplierId |
ID ERP | Identificador primário no sistema de gestão. |
name |
Razão Social | Nome jurídico da empresa fornecedora. |
fantasyName |
Nome Fantasia | Nome comercial/público da empresa. |
taxId |
CNPJ | Cadastro Nacional da Pessoa Jurídica (14 dígitos). |
stateRegistration |
Inscrição Estadual | Registro fiscal estadual (IE). |
type |
Tipo de Fornecedor | Enumeração (comercializável, prestador, etc). |
zipCode |
CEP | Código de Endereçamento Postal. |
address |
Logradouro | Rua, avenida ou praça do estabelecimento. |
number |
Número | Número do prédio/sala. |
complement |
Complemento | Informações extras de endereço. |
cityId |
ID da Cidade | Vínculo com a tabela de cidades. |
11.2.2 Validação e Documento¶
| Nome Original (Código/API) | Nome Traduzido | Descrição em Português |
|---|---|---|
validationStatus |
Status de Validação | Estado atual no workflow (Pendente, Aprovado, etc). |
documentType |
Tipo de Documento | Classificação (CNPJ, Alvará, AFE, etc). |
expirationDate |
Data de Vencimento | Data limite de validade do documento legal. |
fileName |
Nome do Arquivo | Nome original do documento anexado. |
contentBase64 |
Conteúdo Base64 | Conteúdo do arquivo codificado em Base64. |
fileId |
ID do Arquivo | Referência para o armazenamento binário (Bucket/DB). |
[!NOTE] Para detalhes sobre a implementação das consultas SOAP/REST que utilizam estes campos, consulte o Manual de Consultas (Capítulo 10).