Inventory
  1. Docs
Inventory
  • Docs
    • 00. Autenticação
    • 01. Incluir Movimentação Especial
    • 02. Incluir Nota Fiscal de Entrada
    • 03. Cancelar Nota Fiscal de Entrada
    • 04. Gerar Lote de Garantia para Item da Nota Fiscal
    • 05. Incluir Fornecedor
    • 06. Consultar Materiais/Itens
    • 07. Incluir Material/Item
    • 08. Consultar Tipos de Item
    • 09. Incluir Tipo de Item
    • 10. Vincular Tipo de Item a Centro de Estoque
    • 11. Consultar Famílias
    • 12. Incluir Família de Itens
    • 13. Consultar Centros de Estoque
    • 14. Incluir Centro de Estoque
    • 15. Atualizar Centro de Estoque
    • 16. Consultar Centros Financeiros
    • 17. Incluir Centros Financeiros
  • RM
    • Incluir movimentação especial
      POST
    • Incluir nota fiscal de entrada
      POST
    • Cancelar nota fiscal de entrada
      POST
    • Gerar lote de garantia para item da nota fiscal
      POST
    • Incluir fornecedor
      POST
    • Consultar materiais
      GET
    • Incluir material
      POST
    • Consultar tipos de item
      GET
    • Incluir tipo de item
      POST
    • Vincular tipo de item a centro de estoque
      POST
    • Consultar famílias
      GET
    • Incluir família
      POST
    • Consultar centros de estoque
      GET
    • Incluir centro de estoque
      POST
    • Atualizar centro de estoque
      PATCH
    • Consultar centros financeiros
      GET
    • Incluir centros financeiros
      POST
  1. Docs

11. Consultar Famílias

Este método permite consultar todas as famílias cadastradas no sistema Exati. É possível filtrar a busca pelo tipo de item ao qual as famílias estão associadas.
Observe que cada família é identificada pelo seu COD_FAMILIA o qual é composto pelo COD_FAMILIA_PAI (se presente) e pelo COD_SUB_FAMILIA. Além disso, toda família é associada a um tipo de item que, por sua vez, engloba múltiplas famílias.

Retorno da requisição#

Um json com o status da requisição: sucesso ou erro. E com os dados das famílias em uma coleção (array). No caso de erro, é retornada uma mensagem descritiva do erro.
Exemplo 1: Sucesso 200 OK
{
    "status": "success",
    "data": {
   	 "familias": [
   		 {
   			 "ID_FAMILIA": 395,
   			 "ID_FAMILIA_PAI": 384,
   			 "COD_FAMILIA": "FRG.BARRA",
   			 "DESC_FAMILIA": "BARRAS DE COBRE",
   			 "COD_SUB_FAMILIA": "BARRA",
   			 "COD_FAMILIA_PAI": "FRG",
   			 "DESC_FAMILIA_PAI": "FERRAGEM E CONECTOR",
   			 "ID_TIPO_ITEM": 1,
   			 "DESC_TIPO_ITEM": "Material Elétrico",
   			 "SIGLA_TIPO_ITEM": "MTE",
   			 "ENTIDADE": "MATERIAL"
   		 },
   		 {
   			 "ID_FAMILIA": 191,
   			 "ID_FAMILIA_PAI": 189,
   			 "COD_FAMILIA": "CIV.CONC",
   			 "DESC_FAMILIA": "CONCRETO PRÉ MISTURADO",
   			 "COD_SUB_FAMILIA": "CONC",
   			 "COD_FAMILIA_PAI": "CIV",
   			 "DESC_FAMILIA_PAI": "CONSTRUÇÃO CIVIL",
   			 "ID_TIPO_ITEM": 2,
   			 "DESC_TIPO_ITEM": "Material Civil",
   			 "SIGLA_TIPO_ITEM": "MTC",
   			 "ENTIDADE": "MATERIAL"
   		 }
   	 ]
    }
}
Exemplo Postman:
Captura de tela de 2024-10-01 16-12-13.png
Previous
10. Vincular Tipo de Item a Centro de Estoque
Next
12. Incluir Família de Itens