Objetivo

Método para inclusão de dados gerais e fiscais das famílias.

Chamada

POST /api/v1/Familia

Informações para Requisição (Request Information)

Parâmetros URI (URI Parameters)

Nome (Name)Descrição (Description)Tipo (Type)Informações Adicionais (Adittional Information)
idFamilia*Código da Famíliainteger($int64)
idMarcaCódigo da Marcainteger($int64)
nomeFamilia*Nome da Famíliastring
pesavel*Produto pesávelstring
aliquotaIpi*Alíquota IPInumber($double)
pmtDecimal*Permite Quantidade Decimalstring
indCalcIpiSaidaIndica Calcula IPI de Saídastring
perBaseIpiPercentual de Base IPInumber($double)
perOutroIpiPercentual de Outro IPInumber($double)
perAliquotaIpiPercentual de Alíquota IPInumber($double)
vlrIpiPautaValor de Pauta IPInumber($double)
codTipiCódigo TIPIinteger($int32)

indComplVlrImpIndica Complemento de Valor de Impostostring
codNbmshCódigo NCM/SHstring
situacaoNfPisSituação da Nota Fiscal PISstring
situacaoNfCofinsSituação da Nota Fiscal Cofinsstring
perBasePisPercentual de Base PISnumber($double)

perBaseCofinsPercentual de Base Cofinsnumber($double)

atualizNcmIpiAtualiza NCM IPIstring
aliqPadraoIcmsAlíquota Padrão ICMSnumber($double)

codNatRecCódigo da Natureza da receitainteger($int32)

situacaoNfPisSaiSituação Nota Fiscal PIS Saídastring
atualizaNcmImpImportAtualiza NCM de Imposto de Importaçãostring
perImpostoImportPercentual de Imposto de Importaçãonumber($double)
perRedImpostoImportPercentual de Redução Imposto de Importaçãonumber($double)
perRedBaseIpiEntPercentual de Redução Base IPI Entradanumber($double)
seqNatRecCódigo Sequencial da Natureza da Receitainteger($int32)
indBebidaAlcoolicaIndica se é bebida alcoólicastring
sitPisCofinsSimples Situação PIS COFINS Simplesstring
situacaoNfIpiSituação Nota Fiscal IPIstring
situacaoNfIpiSaiSituação Nota Fiscal IPI Saídastring
aliqPadraoIcmsProtegeAlíquota Padrão de ICMS para o cálculo do PROTEGE GO (Fundo de proteção Social do estado de Goiás)integer($int32)
indEscritOutrosEIIndica se o valor do ICMS será demonstrado em "Outros" para Notas Fiscais com o produto farinhastring
codProdDacAlCódigo de produto para a DAC (Declaração de Atividades do Contribuinte)integer($int32)
codNveCódigo NVE (Nomenclatura de Valor Aduaneiro e Estatística)string
classeEnquadramentoIpiClase de Enquadramento IPIstring
codigoSeloIpiCódigo de Selo IPIstring
codigoEnquadramentoIpiCódigo de Enquadramento IPIstring
litrosTabIpiPisCofinsInformar a quantidade em litros do produtonumber($double)

codCestCódigo CEST (Código Especificador de Substituição Tributária)integer($int32)
indMaterialApoioIndica Material de Apoiostring
perTributadoIntPercentual Tributado number($double)
situacaoNfCofinsSaiSituação Nota Fiscal Cofins Saídastring
indVasilhameIndica se é vasilhamestring

Parâmetros do Corpo (Body Parameters)

Não há.

Informações para Resposta (Response Information)

Códigos do Recurso (Response Codes)

Formatos de Resposta (Response Formats)

application/json, text/json

CODE 201 - SUCCESS

{
  "expandables": [
    "string"
  ],
  "idFamilia": 0,
  "marca": {
    "expandables": [
      "string"
    ],
    "idMarca": 0,
    "nomeMarca": "string",
    "status": "string"
  },
  "nomeFamilia": "string",
  "pesavel": "string",
  "aliquotaIpi": 0,
  "usuarioAlteracao": "string",
  "dtaHorAlteracao": "2020-11-05T17:05:04.030Z",
  "usuarioInclusao": "string",
  "dtaHorInclusao": "2020-11-05T17:05:04.030Z",
  "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"
}
application/json, text/json

CODE 400 - BAD


{
  "code": "string",
  "message": "string",
  "detailedMessage": "string",
  "helpUrl": "string",
  "details": [
    {
      "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "notificationType": 0,
      "code": "string",
      "message": "string",
      "detailedMessage": "string",
      "status": 0
    }
  ]
}