Método de consulta que retorna uma lista de família com base nos filtros.
GET /api/v1/Familia
Nome (Name) | Descrição (Description) | Tipo (Type) | Informações Adicionais (Adittional Information) |
IdFamilia | Código da família. | array[integer] | Não há. |
DtaHorAlteracao | Data e hora da alteração. | string($date-time) | Não há. |
Expand | Opção de expandir. | string | Não há. |
Fields | Campos. | string | Não há. |
Order | Ordenação dos campos. | string | Não há. |
Page | Número da página. | integer($int32) | Não há. |
PageSize | Tamanho da página. | integer($int32) | Não há. |
Não há.
CODE 200 - SUCCESS
Bloco de código | ||
---|---|---|
| ||
{ "hasNext": true, "items": [ { "expandables": [ "string" ], "idFamilia": 0, "marca": { "expandables": [ "string" ], "idMarca": 0, "nomeMarca": "string", "status": "string" }, "nomeFamilia": "string", "pesavel": "string", "aliquotaIpi": 0, "usuarioAlteracao": "string", "dtaHorAlteracao": "2020-12-10T18:50:26.228Z", "usuarioInclusao": "string", "dtaHorInclusao": "2020-12-10T18:50:26.228Z", "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", "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 } ], "informacaoNutricionalFamilia": [ { "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 } ] } ], "familiaDivisao": [ { "expandables": [ "string" ], "idFamilia": 0, "idDivisao": 0, "padraoEmbTransf": 0, "padraoEmbCompra": 0, "idComprador": 0, "idTributacao": 0, "finalidadeFamilia": "string", "formaAbastecimento": "string", "dtaHorInclusao": "2020-12-10T18:50:26.228Z", "usuarioInclusao": "string", "dtaHorAlteracao": "2020-12-10T18:50:26.228Z", "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" }, "pautaImpostoIcms": { "expandables": [ "string" ], "idPautaIcms": 0, "descricao": "string" }, "tributacao": { "expandables": [ "string" ], "idTributacao": 0, "descricao": "string" }, "familiaFinalidade": { "expandables": [ "string" ], "finalidade": "string", "descricao": "string" }, "formaAbastec": { "expandables": [ "string" ], "forma": "string", "descricao": "string", "tipoCalcAbastec": "string" } } ], "familiaFornecedor": [ { "expandables": [ "string" ], "idFornecedor": 0, "principal": "string", "tipoAvaria": "string", "tipoFornecedor": "string", "embalagemCompra": 0, "embalagemImportacaoXML": 0, "fatorConversaoImportacaoXML": 0, "dataAlteracao": "2020-12-10T18:50:26.229Z" } ] } ] } |
CODE 400 - BAD
Bloco de código | ||
---|---|---|
| ||
{ "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 } ] } |
...