Histórico da Página
...
Método para inclusão de dados gerais e fiscais das famílias.
Chamada
POST [URLAPI]/CadastrosEstruturaisAPI/api/v1/Familia
Permissionamento
Antes de prosseguir, certifique-se de que o usuário, utilizado para autenticação de uso na API, está com as devidas permissões no Sistema/Módulo/Aplicações e na empresa desejada.
Para isso, acesse o módulo SegurançaWeb > Permissões > Associação de Permissão Usuário / Grupo > Sistemas/Módulo/Aplicações > Comercial Web > API Cadastros Estruturais > API Cadastros Estruturais
Imagem 01 - Configurações de Sistemas/Módulos/Aplicações
Assuntos Relacionados
Para saber mais sobre permissionamentos acesse Permissões - Segurança Web.
Informações para Requisição (Request Information)
...
| Nome (Name) | Descrição (Description) | Tipo (Type) | Informações Adicionais (Adittional Information) |
| idFamilia* | Código da Família | integer($int64) | Não há |
| idMarca | Código da Marca | integer($int64) | Não há |
| nomeFamilia* | Nome da Família | string | Não há |
| pesavel* | Produto pesável | string | Não há |
| aliquotaIpi* | Alíquota IPI | number($double) | Não há |
| pmtDecimal* | Permite Quantidade Decimal | string | Não há |
| indCalcIpiSaida | Indica Calcula IPI de Saída | string | Não há |
| perBaseIpi | Percentual de Base IPI | number($double) | Não há |
| perOutroIpi | Percentual de Outro IPI | number($double) | Não há |
| perAliquotaIpiNão há | Percentual de Alíquota IPI | number($double) | Não há |
| vlrIpiPauta | Valor de Pauta IPI | number($double) | Não há |
| codTipi | Código TIPI | integer($int32) | Não há |
| indComplVlrImp | Indica Complemento de Valor de Imposto | string | Não há |
| codNbmsh | Código NCM/SH | string | Não há |
| situacaoNfPis | Situação da Nota Fiscal PIS | string | Não há |
| situacaoNfCofins | Situação da Nota Fiscal Cofins | string | Não há |
| perBasePis | Percentual de Base PIS | number($double) | Não há |
| perBaseCofins | Percentual de Base Cofins | number($double) | Não há |
| atualizNcmIpi | Atualiza NCM IPI | string | Não há |
| aliqPadraoIcms | Alíquota Padrão ICMS | number($double) | Não há |
| codNatRec | Código da Natureza da receita | integer($int32) | Não há |
| situacaoNfPisSai | Situação Nota Fiscal PIS Saída | string | Não há |
| atualizaNcmImpImport | Atualiza NCM de Imposto de Importação | string | Não há |
| perImpostoImport | Percentual de Imposto de Importação | number($double) | Não há |
| perRedImpostoImport | Percentual de Redução Imposto de Importação | number($double) | Não há |
| perRedBaseIpiEnt | Percentual de Redução Base IPI Entrada | number($double) | Não há |
| seqNatRec | Código Sequencial da Natureza da Receita | integer($int32) | Não há |
| indBebidaAlcoolica | Indica se é bebida alcoólica | string | Não há |
| sitPisCofinsSimples | Situação PIS COFINS Simples | string | Não há |
| situacaoNfIpi | Situação Nota Fiscal IPI | string | Não há |
| situacaoNfIpiSai | Situação Nota Fiscal IPI Saída | string | Não há |
| aliqPadraoIcmsProtege | Alíquota Padrão de ICMS para o cálculo do PROTEGE GO (Fundo de proteção Social do estado de Goiás) | integer($int32) | Não há |
| indEscritOutrosEI | Indica se o valor do ICMS será demonstrado em "Outros" para Notas Fiscais com o produto farinha | string | Não há |
| codProdDacAl | Código de produto para a DAC (Declaração de Atividades do Contribuinte) | integer($int32) | Não há |
| codNve | Código NVE (Nomenclatura de Valor Aduaneiro e Estatística) | string | Não há |
| classeEnquadramentoIpi | Clase de Enquadramento IPI | string | Não há |
| codigoSeloIpi | Código de Selo IPI | string | Não há |
| codigoEnquadramentoIpi | Código de Enquadramento IPI | string | Não há |
| litrosTabIpiPisCofins | Informar a quantidade em litros do produto | number($double) | Não há |
| codCest | Código CEST (Código Especificador de Substituição Tributária) | integer($int32) | Não há |
| indMaterialApoio | Indica Material de Apoio | string | Não há |
| perTributadoInt | Percentual Tributado | number($double) | Não há |
| situacaoNfCofinsSai | Situação Nota Fiscal Cofins Saída | string | Não há |
| indVasilhame | Indica se é vasilhame | string | Não há |
idFamiliaImportacaoERP | Código da Familia na importação ERP | integer($int32) | Não há |
| tipoCadastro | Sigla para indicar o Tipo de Cadastro | string | M = Manual, A = Via API, E = Importação de cadastros com base ERP Consinco, V = Importação de cadastros com base Vercer, S = Importação de cadastros com base Simplus |
...
| Bloco de código | ||
|---|---|---|
| ||
{
"expandables": [
"string"
],
"idFamilia": 0,
"idMarca": 0,
"nomeFamilia": "string",
"pesavel": "string",
"aliquotaIpi": 0,
"usuarioAlteracao": "string",
"dtaHorAlteracao": "2022-06-17T14:20:13.031Z",
"usuarioInclusao": "string",
"dtaHorInclusao": "2022-06-17T14:20:13.031Z",
"pmtDecimal": "string",
"indCalcIpiSaida": "string",
"perBaseIpi": 0,
"perIsentoIpi": 0,
"perOutroIpi": 0,
"perAliquotaIpi": 0,
"vlrIpiPauta": 0,
"codTipi": 0,
"indComplVlrImp": "string",
"codNbmsh": "string",
"situacaoNfPis": "string",
"situacaoNfCofins": "string",
"perBasePis": 0,
"perBaseCofins": 0,
"atualizNcmIpi": "string",
"aliqPadraoIcms": 0,
"codNatRec": 0,
"situacaoNfPisSai": "string",
"atualizaNcmImpImport": "string",
"perImpostoImport": 0,
"perRedImpostoImport": 0,
"perRedBaseIpiEnt": 0,
"seqNatRec": 0,
"indBebidaAlcoolica": "string",
"sitPisCofinsSimples": "string",
"situacaoNfIpi": "string",
"situacaoNfIpiSai": "string",
"aliqPadraoIcmsProtege": 0,
"indEscritOutrosEI": "string",
"codProdDacAl": 0,
"codNve": "string",
"classeEnquadramentoIpi": "string",
"codigoSeloIpi": "string",
"codigoEnquadramentoIpi": "string",
"litrosTabIpiPisCofins": 0,
"codCest": 0,
"indMaterialApoio": "string",
"perTributadoInt": 0,
"situacaoNfCofinsSai": "string",
"indVasilhame": "string",
"indCadastroAtivo": "string",
"idFamiliaImportacaoErp": 0,
"marca": {
"expandables": [
"string"
],
"idMarca": 0,
"nomeMarca": "string",
"status": "string",
"tipoMarca": "string"
},
"ncm": {
"codNcm": "string",
"descricao": "string",
"descReduzida": "string",
"perImpostoImport": 0,
"aliquotaIpi": 0,
"indControlePf": "string",
"codTabGenero": "string",
"codTipiNcm": 0,
"indPermExcecao": "string",
"status": "string",
"dtaInicioVigencia": "2022-06-17T14:20:13.031Z",
"dtaFimVigencia": "2022-06-17T14:20:13.031Z",
"usuarioAlteracao": "string",
"indSubIcmsDifDi": "string",
"dtaAlteracao": "2022-06-17T14:20:13.031Z",
"tabelaAuxiliarPCItensNcm": [
{
"idCodigoNCM": 0,
"idTabelaAuxiliar": 0,
"idItem": 0,
"codigoNCM": "string",
"codigoNCMNumerico": "string",
"tabelaAuxiliarPCItens": {
"idItem": 0,
"idTabelaAuxiliar": 0,
"codigo": "string",
"descricao": "string",
"parametro": "string",
"indUtilizaNCM": "string"
}
}
]
},
"informacaoNutricionalinformacaoNutricionalFamilia": [
{
"idInformacaoNutricional": 0,
"descricao": "string",
"obsInfNutric": "string",
"qtdPorcao": 0,
"unidPorcao": "string",
"intMedCaseira": "string",
"decMedCaseira": "string",
"medCaseira": "string",
"altoEmAcuAdic": "string",
"altoEmGordSat": "string",
"altoEmSodio": "string",
"tabelaNutricional": [
{
"idInformacaoNutricional": 0,
"idAtributoFixo": 0,
"descricaoQuantidadePorcao": "string",
"percVlrDiaRef": 0
}
]
}
],
"familiaEmbalagem": [
{
"expandables": [
"string"
],
"idFamilia": 0,
"qtdPorEmbalagem": 0,
"embalagem": "string",
"pesoBruto": 0,
"pesoLiquido": 0,
"altura": 0,
"largura": 0,
"profundidade": 0,
"status": "string",
"qtdUnidEmbalagem": 0,
"multEquipQtdEmbalagem": 0,
"fatorMultVolume": 0,
"multEquipEmbalagem": "string",
"percToleranciaPeso": 0
}
],
"familiaDivisao": [
{
"expandables": [
"string"
],
"idFamilia": 0,
"idDivisao": 0,
"padraoEmbTransf": 0,
"padraoEmbCompra": 0,
"idComprador": 0,
"idTributacao": 0,
"finalidadeFamilia": "string",
"formaAbastecimento": "string",
"dtaHorInclusao": "2022-06-17T14:20:13.031Z",
"usuarioInclusao": "string",
"dtaHorAlteracao": "2022-06-17T14:20:13.031Z",
"usuarioAlteracao": "string",
"codOrigemTrib": "string",
"idPauta": 0,
"idPautaIcms": 0,
"familia": {
"expandables": [
"string"
],
"idFamilia": 0,
"nomeFamilia": "string"
},
"divisao": {
"expandables": [
"string"
],
"idDivisao": 0,
"nomeDivisao": "string"
},
"comprador": {
"expandables": [
"string"
],
"idComprador": 0,
"nomeComprador": "string",
"apelido": "string"
},
"pautaImposto": {
"expandables": [
"string"
],
"idPauta": 0,
"descricao": "string",
"observacao": "string",
"status": "string",
"pautaUfLog": [
{
"idPautaUfLog": 0,
"idPauta": 0,
"idRegimeTributacao": 0,
"ufOrigem": "string",
"ufDestino": "string",
"dataInicio": "2022-06-17T14:20:13.031Z",
"dataFim": "2022-06-17T14:20:13.031Z",
"vlrUnitarioBaseST": 0,
"dataAlteracao": "2022-06-17T14:20:13.031Z",
"usuarioAlteracao": "string",
"aplicAcrescST": "string",
"tipoCalcPauta": "string",
"fatorConversao": 0,
"regimeTributacao": {
"idRegTributacao": 0,
"descricao": "string",
"geraDebRecIcmsAntecip": "string",
"status": "string",
"indBaseCalcIcmsAntecip": "string",
"utilRegIcmsVlrItemCalcIcmsSt": "string",
"indSimplesNac": "string",
"indCalcDifAliq": "string",
"indUsaPdv": "string",
"utilOficioCstBrutoBaseSt": "string",
"utilRegimeCargaMedia": "string",
"utilRegimeAtac": "string",
"tipoCalFicioCstBrutoBaseSt": "string",
"indTipoCalcSimples": 0,
"regimeTributacaoUF": [
{
"expandables": [
"string"
],
"idRegTributacao": 0,
"uf": "string",
"status": "string",
"indGnreFatPed": "string"
}
]
}
}
]
},
"pautaImpostoIcms": {
"expandables": [
"string"
],
"idPautaIcms": 0,
"descricao": "string",
"status": "string",
"observacao": "string",
"pautaIcmsUfLog": [
{
"idPautaIcmsUfLog": 0,
"idPautaIcms": 0,
"idRegTributacao": 0,
"ufOrigem": "string",
"ufDestino": "string",
"dataInicio": "2022-06-17T14:20:13.031Z",
"dataFim": "2022-06-17T14:20:13.031Z",
"vlrBaseIcms": 0,
"dataAlteracao": "2022-06-17T14:20:13.031Z",
"usuarioAlteracao": "string",
"tipCalcPautaIcms": "string",
"regimeTributacao": {
"idRegTributacao": 0,
"descricao": "string",
"geraDebRecIcmsAntecip": "string",
"status": "string",
"indBaseCalcIcmsAntecip": "string",
"utilRegIcmsVlrItemCalcIcmsSt": "string",
"indSimplesNac": "string",
"indCalcDifAliq": "string",
"indUsaPdv": "string",
"utilOficioCstBrutoBaseSt": "string",
"utilRegimeCargaMedia": "string",
"utilRegimeAtac": "string",
"tipoCalFicioCstBrutoBaseSt": "string",
"indTipoCalcSimples": 0,
"regimeTributacaoUF": [
{
"expandables": [
"string"
],
"idRegTributacao": 0,
"uf": "string",
"status": "string",
"indGnreFatPed": "string"
}
]
}
}
]
},
"tributacao": {
"expandables": [
"string"
],
"idTributacao": 0,
"descricao": "string",
"descAplicacao": "string",
"advEntradaNf": "string",
"situacEspecialTrib": "string",
"status": "string",
"aceitaPauta": "string",
"tributacaoUf": [
{
"idTributacao": 0,
"ufEmpresa": "string",
"ufClienteFornecedor": "string",
"tipo": "string",
"idRegTributacao": 0,
"percTributado": 0,
"percIsento": 0,
"percOutro": 0,
"percAliqIcms": 0,
"percAcrescSt": 0,
"percAliqSt": 0,
"tipoApropriacaoSt": "string",
"pautaIcms": "string",
"percAntecipado": 0,
"percPresumido": 0,
"observacao": "string",
"sitTribNf": "string",
"aliqIcmsCalculo": 0,
"somaIPIBaseIcms": "string",
"percAcrescIcmsAntec": 0,
"percDespIcms": 0,
"somaIpiBaseSt": "string",
"percAliqIcmsDiferido": 0,
"reducaoCalculoBaseSt": "string",
"ressarcimentoSt": "string",
"percAliqTare": 0,
"percTributadoSt": 0,
"reducaoBaseIcmsCalculoSt": "string",
"aliqBaseIcmsCalculoSt": "string",
"sitTribPis": "string",
"sitTribCofins": "string",
"codAntecipacaoTrib": 0,
"diaVencimentoSt": 0,
"calculaStConformeAliqCalculoPreco": "string",
"tipoCalculoIcms": 0,
"baseIcmsLivroFiscal": "string",
"aliqDifPis": 0,
"aliqDifCofins": 0,
"aliqStCargaLiquida": 0,
"calculaStConformeEntrada": "string",
"sitTribIpi": "string",
"obsPadraoNf": "string",
"percAcrescIcmsRetido": 0,
"percIcmsRetido": 0,
"percIsentoSt": 0,
"percOutrosSt": 0,
"baseIcmsReduzidaCemPorcento": "string",
"percReducaoBasePis": 0,
"percReducaoBaseCofins": 0,
"sitTribSimplesNacional": "string",
"reduzBaseStAntesSomarIpi": "string",
"calculoIcmsParaDescSuframa": "string",
"calculoDescSuframaParaCalculoSt": "string",
"percReducaoPmc": 0,
"somaIpiBaseIcmsAntecipadoOuResumido": "string",
"codNaturezaReceita": 0,
"idNaturezaReceita": 0,
"deduzDescBaseSt": "string",
"percTributacaoIcmsSuframa": 0,
"percAcrescIcmsAntecipado": 0,
"percReducaoAliqEstornoRJ": 0,
"baseCalculoEstornoCreditoRJ": "string",
"sitTribDevolucao": "string",
"percIcmsResol13": 0,
"percIcmsDiferido": 0,
"somaIpiBaseApenasIcmsDiferido": "string",
"somaFreteBaseIpi": "string",
"percMajoracaoCofinsImportacao": 0,
"percCargaTriutariaMedia": 0,
"utilizaCustoMesBasePonderado": "string",
"percAcrescStResol13": 0,
"percMinimoStRetido": 0,
"percRegimeAtacadista": 0,
"percTributadoCalculado": 0,
"percIsentoCalculado": 0,
"percOutrosCalculado": 0,
"obsPadraoCtrcCte": "string",
"percTributadoAntecipado": 0,
"percIsentoAntecipado": 0,
"percOutrosAntecipado": 0,
"aplicaAcrescStCargaLiquidaSt": "string",
"aliqStCargaLiquidaResol13": 0,
"calculaStEmbutidoProduto": "string",
"percIcmsTare": 0,
"percTributadoResol13": 0,
"percIsentoResol13": 0,
"percOutrosResol13": 0,
"calculaIcmsDesoneradoOutros": "string",
"calculaIcmsCreditoCusto": "string",
"percReducaoCargaTribIcmsDI": 0,
"percMajoracaoPisImportacao": 0,
"aliqInternaUfDestino": 0,
"tipoCalculoPartilhaIcms": "string",
"tipoSomaIpiBaseIcmsAntecipado": "string",
"reduzCreditoIcmsAutoDevFornec": "string",
"tipoCalculoBaseIcmsPresumido": "string",
"permiteReducaoBaseIcmsCalculado": "string",
"sitTribIcmsCalculado": "string",
"aliqIcmsDesoneradoOutros": 0,
"agregaCustoIcmsAntecipado": "string",
"obsPadraoDevolucao": "string",
"percIcmsCalculoResol13": 0,
"baseFcpSt": 0,
"aliqFcpSt": 0,
"tipoCalculoFcpSt": "string",
"baseFcpIcms": 0,
"aliqFcpIcms": 0,
"tipoCalcloFcpIcms": "string",
"calculoIcmsEfetivo": "string",
"percReducaoIcmsEfetivo": 0,
"utilizaIcmsCalculadoReducaoFcpSt": "string",
"tipoCalculoIcmsBonificacao": "string",
"sitTribNfBonificacao": "string",
"contrapartidaStCusto": "string",
"codAjustesInfoAdicionais": "string",
"motivoDesoneracao": 0,
"percDiferido": 0,
"percLimiteReducaoPmc": 0,
"codAjustesInfoAdicionaisDevolucao": "string",
"tipoApropriacaoIcmsFrete": "string",
"dataAlteracao": "2022-06-17T14:20:13.032Z",
"usuarioAlteracao": "string",
"regimeTributacao": {
"idRegTributacao": 0,
"descricao": "string",
"geraDebRecIcmsAntecip": "string",
"status": "string",
"indBaseCalcIcmsAntecip": "string",
"utilRegIcmsVlrItemCalcIcmsSt": "string",
"indSimplesNac": "string",
"indCalcDifAliq": "string",
"indUsaPdv": "string",
"utilOficioCstBrutoBaseSt": "string",
"utilRegimeCargaMedia": "string",
"utilRegimeAtac": "string",
"tipoCalFicioCstBrutoBaseSt": "string",
"indTipoCalcSimples": 0,
"regimeTributacaoUF": [
{
"expandables": [
"string"
],
"idRegTributacao": 0,
"uf": "string",
"status": "string",
"indGnreFatPed": "string"
}
]
}
}
]
},
"familiaFinalidade": {
"expandables": [
"string"
],
"finalidade": "string",
"descricao": "string"
},
"formaAbastec": {
"expandables": [
"string"
],
"forma": "string",
"descricao": "string",
"tipoCalcAbastec": "string"
}
}
],
"familiaFornecedor": [
{
"expandables": [
"string"
],
"idFamilia": 0,
"idFornecedor": 0,
"principal": "string",
"tipoAvaria": "string",
"tipoFornecedor": "string",
"embalagemCompra": 0,
"embalagemImportacaoXML": 0,
"fatorConversaoImportacaoXML": 0,
"dataAlteracao": "2022-06-17T14:20:13.032Z",
"fornecedor": {
"idFornecedor": 0,
"tipo": "string",
"microEmpresa": "string",
"condicaoFrete": "string",
"status": "string",
"dadosAdicionais": "string",
"pessoa": {
"idPessoa": 0,
"nomeRazaoSocial": "string",
"fantasia": "string",
"tipoPessoa": "string",
"sexo": "string",
"status": "string",
"nomeCidade": "string",
"ufCidade": "string",
"paisCidade": "string",
"nomeBairro": "string",
"tipoLogradouro": "string",
"nomeLogradouro": "string",
"numeroLogradouro": "string",
"complementoLogradouro": "string",
"cep": "string",
"telefoneDDD1": "string",
"telefoneNumero1": "string",
"telefoneComplemento1": "string",
"telefoneDDD2": "string",
"telefoneNumero2": "string",
"telefoneComplemento2": "string",
"telefoneDDD3": "string",
"telefoneNumero3": "string",
"telefoneComplemento3": "string",
"numeroCPFCNPJ": 0,
"digitoCPFCNPJ": 0,
"inscricaoEstadualRG": "string",
"email": "string",
"homePage": "string",
"estadoCivil": "string",
"contribuinteICMS": "string",
"produtorRural": "string",
"microEmpresa": "string",
"inscricaoProdutorRural": "string",
"numeroCNPJProdutorRural": 0,
"digitoCNPJProdutorRural": 0,
"produtorRuralComCPF": "string",
"numeroCPFProdutorRural": 0,
"digitoCPFProdutorRural": 0
},
"fornecedorDivisao": [
{
"idFornecedor": 0,
"idDivisao": 0,
"numeroRegimeTributacao": 0,
"idComprador": 0,
"prazoMedioVisita": 0,
"prazoMedioEntrega": 0,
"prazoMedioAtrasoEntrega": 0,
"prazoPagamento": "string",
"formaPagamento": "string",
"valorMinimoPedidoCompra": 0,
"classificacaoComercialABC": "string",
"status": "string",
"tipoDataBaseVencimento": "string",
"tipoValorMinimo": "string"
}
]
}
}
],
"familiaCategoria": [
{
"idFamilia": 0,
"idCategoria": 0,
"nroDivisao": 0,
"status": "string",
"dataHoraAlteracao": "2022-06-17T14:20:13.032Z",
"usuarioAlteracao": "string",
"categoria": {
"expandables": [
"string"
],
"idCategoria": 0,
"nroDivisao": 0,
"tipo": "string",
"nivelHierarquia": 0,
"descricao": "string",
"aceitaFamilia": "string",
"objetivoNoNegocio": "string",
"idCategoriaPai": 0,
"status": "string",
"dataHoraAlteracao": "string",
"caminhoCompleto": "string",
"idCategoriaImportacaoERP": 0,
"nroDivisaoImportacaoERP": 0
}
}
],
"listaVenda": [
{
"idFamilia": 0,
"idLista": 0,
"status": "string"
}
]
} |
...
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas