Histórico da Página

Objetivo

Método de consulta que retorna uma lista de família com base nos filtrospara atualização dos dados de família.

Chamada

PATCH [URLAPI]/CadastrosEstruturaisAPI/api/v1/Familia

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

Parâmetros URI (URI Parameters)

...

integer($int64)

...

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

Image Added

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)

Parâmetros URI (URI Parameters)

Nome (Name)	Descrição (Description)	Tipo (Type)	Informações

Parâmetros do Corpo (Body Parameters)

Nome (Name)Descrição (Description)Tipo (Type)Informações

Adicionais (Adittional Information)

path

idFamilia

Caminhostring

Código da família

integer($int64)

Não há.

Parâmetros do Corpo (Body Parameters)

op

Nome (Name)	Descrição (Description)	Tipo (Type)	Informações Adicionais (Adittional Information)
path	Caminho	string	Não há.
op

Tipo de Operação - “add”, “remove”, “replace”, “move”, “copy” e “test”	string	Não há.
value	Valor	string	Não há.

Informações para Resposta (Response Information)

...

OK (200)
BadRequest (400)

Formatos de Resposta (Response Formats)

application/json, text/json

CODE 200 - SUCCESS

(Response Formats)

application/json, text/json

CODE 200 - SUCCESS

Bloco de código

language	actionscript3

{
  "hasNext": true,
  "items": [
    {
      "expandables": [
        "string"
      ],
      "idFamilia": 0,
      "idMarca": 0,
      "nomeFamilia": "string",
      "pesavel": "string",

Bloco de código

language	actionscript3

{
  "hasNext": true,
  "items": [
    {
      "expandablesaliquotaIpi": [0,
      "usuarioAlteracao":  "string"
      ],
      "idFamiliadtaHorAlteracao": 0"2021-01-21T19:37:55.414Z",
      "idMarcausuarioInclusao": 0"string",
      "dtaHorInclusao"nomeFamilia": "string: "2021-01-21T19:37:55.414Z",
      "pesavelpmtDecimal": "string",
      "aliquotaIpiindCalcIpiSaida": 0"string",
      "usuarioAlteracaoperBaseIpi": "string"0,
      "dtaHorAlteracaoperIsentoIpi": "2021-01-21T19:37:55.414Z"0,
      "usuarioInclusaoperOutroIpi": "string"0,
      "dtaHorInclusao": "2021-01-21T19:37:55.414Z"perAliquotaIpi": 0,
      "pmtDecimalvlrIpiPauta": "string"0,
      "indCalcIpiSaidacodTipi": "string"0,
      "perBaseIpiindComplVlrImp": 0"string",
      "perIsentoIpicodNbmsh": 0"string",
      "perOutroIpisituacaoNfPis": 0"string",
      "perAliquotaIpisituacaoNfCofins": 0"string",
      "vlrIpiPautaperBasePis": 0,
      "codTipiperBaseCofins": 0,
      "indComplVlrImpatualizNcmIpi": "string",
      "codNbmshaliqPadraoIcms": "string"0,
      "situacaoNfPis": "string"codNatRec": 0,
      "situacaoNfCofinssituacaoNfPisSai": "string",
      "perBasePisatualizaNcmImpImport": 0"string",
      "perBaseCofinsperImpostoImport": 0,
      "atualizNcmIpiperRedImpostoImport": "string"0,
      "aliqPadraoIcmsperRedBaseIpiEnt": 0,
      "codNatRecseqNatRec": 0,
      "situacaoNfPisSaiindBebidaAlcoolica": "string",
      "atualizaNcmImpImportsitPisCofinsSimples": "string",
      "perImpostoImportsituacaoNfIpi": 0"string",
      "perRedImpostoImportsituacaoNfIpiSai": 0,
      "perRedBaseIpiEnt": 0"string",
      "seqNatRecaliqPadraoIcmsProtege": 0,
      "indBebidaAlcoolicaindEscritOutrosEI": "string",
      "sitPisCofinsSimplescodProdDacAl": "string"0,
      "situacaoNfIpicodNve": "string",
      "situacaoNfIpiSaiclasseEnquadramentoIpi": "string",
      "aliqPadraoIcmsProtegecodigoSeloIpi": 0"string",
      "indEscritOutrosEIcodigoEnquadramentoIpi": "string",
      "codProdDacAllitrosTabIpiPisCofins": 0,
      "codNvecodCest": "string"0,
      "classeEnquadramentoIpiindMaterialApoio": "string",
      "codigoSeloIpiperTributadoInt": "string"0,
      "codigoEnquadramentoIpisituacaoNfCofinsSai": "string",
      "litrosTabIpiPisCofinsindVasilhame": 0"string",
      "codCestmarca": 0,{
      "indMaterialApoio": "string",
      "perTributadoIntexpandables": 0,[
         "situacaoNfCofinsSai": "string",
      "indVasilhame": "string"  ],
        "marcaidMarca": {0,
        "expandablesnomeMarca": ["string",
         "status": "string"
      },
  ],    "familiaEmbalagem": [
        "idMarca": 0,
 {
          "nomeMarcaexpandables": "string",[
        "status":    "string"
      },
    ],
  "familiaEmbalagem": [
        {"idFamilia": 0,
          "expandablesqtdPorEmbalagem": [0,
          "embalagem":  "string",
          "pesoBruto": ]0,
          "idFamiliapesoLiquido": 0,
          "qtdPorEmbalagemaltura": 0,
          "embalagemlargura": "string"0,
          "pesoBrutoprofundidade": 0,
          "pesoLiquidostatus": 0"string",
          "alturaqtdUnidEmbalagem": 0,
          "larguramultEquipQtdEmbalagem": 0,
          "profundidadefatorMultVolume": 0,
          "statusmultEquipEmbalagem": "string",
          "qtdUnidEmbalagempercToleranciaPeso": 0,
        }
  "multEquipQtdEmbalagem": 0,
   ],
       "fatorMultVolumeinformacaoNutricionalFamilia": 0,[
          "multEquipEmbalagem": "string",{
          "percToleranciaPesoidInformacaoNutricional": 0,
        }
  "descricao": "string",
   ],
       "informacaoNutricionalFamiliaobsInfNutric": ["string",
        {   "qtdPorcao": 0,
          "idInformacaoNutricionalunidPorcao": 0"string",
          "descricaointMedCaseira": "string",
          "obsInfNutricdecMedCaseira": "string",
          "qtdPorcaomedCaseira": 0"string",
          "unidPorcao": "string",
tabelaNutricional": [
           "intMedCaseira": "string", {
              "decMedCaseiraidInformacaoNutricional": "string"0,
              "medCaseiraidAtributoFixo": "string"0,
              "tabelaNutricionaldescricaoQuantidadePorcao": ["string",
            {
  "percVlrDiaRef": 0
           "idInformacaoNutricional": 0, }
          ]
    "idAtributoFixo": 0,
   }
      ],
      "descricaoQuantidadePorcaofamiliaDivisao": "string",[
        {
          "percVlrDiaRefexpandables": 0[
            }"string"
          ],
        }
  "idFamilia": 0,
   ],
       "familiaDivisaoidDivisao": [
 0,
           {"padraoEmbTransf": 0,
          "expandablespadraoEmbCompra": [0,
            "stringidComprador": 0,
          "idTributacao": ]0,
          "idFamiliafinalidadeFamilia": 0"string",
          "idDivisaoformaAbastecimento": 0"string",
          "padraoEmbTransf": 0"dtaHorInclusao": "2021-01-21T19:37:55.414Z",
          "padraoEmbComprausuarioInclusao": 0"string",
          "idCompradordtaHorAlteracao": 0"2021-01-21T19:37:55.414Z",
          "idTributacaousuarioAlteracao": 0"string",
          "finalidadeFamiliacodOrigemTrib": "string",
          "formaAbastecimentoidPauta": "string"0,
          "dtaHorInclusaoidPautaIcms": "2021-01-21T19:37:55.414Z"0,
          "usuarioInclusaofamilia": "string",{
            "dtaHorAlteracaoexpandables": "2021-01-21T19:37:55.414Z",
[
             "usuarioAlteracao": "string"
            ],
            "codOrigemTribidFamilia": "string"0,
            "idPautanomeFamilia": 0,"string"
          "idPautaIcms": 0},
          "familiadivisao": {
            "expandables": [
              "string"
            ],
            "idFamiliaidDivisao": 0,
            "nomeFamilianomeDivisao": "string"
          },
          "divisaocomprador": {
            "expandables": [
              "string"
            ],
            "idDivisaoidComprador": 0,
            "nomeDivisaonomeComprador": "string",
          },
  "apelido": "string"
       "comprador": {
  },
          "expandablespautaImposto": [{
              "stringexpandables": [
              ],"string"
            "idComprador": 0],
            "nomeCompradoridPauta": "string"0,
            "apelidodescricao": "string"
          },
          "pautaImpostopautaImpostoIcms": {
            "expandables": [
              "string"
            ],
            "idPautaidPautaIcms": 0,
            "descricao": "string"
          },
          "pautaImpostoIcmstributacao": {
            "expandables": [
              "string"
            ],
            "idPautaIcmsidTributacao": 0,
            "descricao": "string"
          },
          "tributacaofamiliaFinalidade": {
            "expandables": [
              "string"
            ],
            "idTributacaofinalidade": 0"string",
            "descricao": "string"
          },
          "familiaFinalidadeformaAbastec": {
            "expandables": [
              "string"
            ],
  "string"
            ]"forma": "string",
            "finalidadedescricao": "string",
            "descricaotipoCalcAbastec": "string"
          },
        }
   "formaAbastec": {
  ]
        }
  ]
}

application/json, text/json

CODE 400 - BAD

Bloco de código

language	actionscript3

{
  "expandablescode": ["string",
  "message": "string",
  "detailedMessage": "string",
        "helpUrl": "string",
  "details": [
         ],
      {
      "formaguid": "string3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "notificationType": 0,
      "descricaocode": "string",
            "tipoCalcAbastecmessage": "string",
          }"detailedMessage": "string",
        }
      ]"status": 0
    }
  ]
}

Árvore de páginas

Versões comparadas

Versão antiga 1

Nova versão 4

Chave

Objetivo

Chamada

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

Parâmetros URI (URI Parameters)

Permissionamento

Assuntos Relacionados

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

Parâmetros URI (URI Parameters)

Parâmetros do Corpo (Body Parameters)

Parâmetros do Corpo (Body Parameters)

Informações para Resposta (Response Information)

Formatos de Resposta (Response Formats)

application/json, text/json

(Response Formats)

application/json, text/json