Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Parâmetros do Corpo (Body Parameters)

Não há.

Informações para

...

Requisição (

...

Request Information)

Códigos do Recurso (Response Codes)

  • OK (201)
  • BadRequest (400)

...


...

Formato de Requisição (Request Format)

application/json, text/json

...




language
Bloco de código
actionscript3
{
  "expandables": [
    "string"
  ],
  "idFamilia": 0,
  "idMarca": 0,
  "nomeFamilia": "string",
  "pesavel": "string",
  "aliquotaIpi": 0,
  "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",
  "idFamiliaImportacaoERP": 0,
  "tipoCadastro": "string"
}


Informações para Resposta (Response Information)

Códigos do Recurso (Response Codes)

  • OK (201)
  • BadRequest (400)

Formatos de Resposta (Response Formats)

application/json, text/json

CODE 201 - SUCCESS

Bloco de código
languageactionscript3
{
  "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"
        }
      }
    ]
  },
  "informacaoNutricional": [
    {
      "idInformacaoNutricional": 0,
      "descricao": "string",
      "obsInfNutric": "string",
      "qtdPorcao": 0,
      "unidPorcao": "string",
      "intMedCaseira": "string",
      "decMedCaseira": "string",
      "medCaseira": "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"
    }
  ]
}
application/json, text/json

CODE 400 - BAD


Bloco de código
languageactionscript3
{
  "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
    }
  ]
}