16. Consultar Centros Financeiros

Os centros financeiros são organizados em uma estrutura em árvore, como na imagem abaixo.

Captura de tela de 2024-10-01 16-47-33.png

Cada centro financeiro de um nível mais profundo tem seu código concatenado com o de seus pais. Por exemplo, o de nome “POA - Bancada de Teste” tem código “ESTQ.2.103”.

É possível buscar a partir de um nó específico passando o parâmetro de query “codigo-cf”. Por exemplo, com o valor “ESTQ”, serão retornados os filhos de ESTQ que são ESTQ.1, ESTQ.2 e ESTQ.41 da imagem.

Pode-se buscar por mais níveis de uma só vez, passando-se o parâmetro de query “depth-limit” que por padrão é 1.

Retorno da requisição

Um json com o status da requisição: sucesso ou erro. E com os dados dos centros financeiros em uma coleção (array). No caso de erro, é retornada uma mensagem descritiva do erro.

Exemplo 1: Sucesso 200 OK

/centro-financ?codigo-cf=ESTQ&depth-limit=2

Busca a partir de ESTQ com dois níveis de profundidade. Retorno relativo à última imagem de exemplo.

{
    "status": "success",
    "data": {
   	 "centro_financ": [
   		 {
   			 "ID_CENTRO_FINANC": 3465,
   			 "COD_CENTRO_FINANC_PAI": "ESTQ",
   			 "COD_SUB_CENTRO_FINANC": "1",
   			 "COD_CENTRO_FINANC": "ESTQ.1",
   			 "DESC_CENTRO_FINANC": "Novos",
   			 "DESC_TIPO_CENTRO_FINANC": "Centro de Estoque"
   		 },
   		 {
   			 "ID_CENTRO_FINANC": 3466,
   			 "COD_CENTRO_FINANC_PAI": "ESTQ",
   			 "COD_SUB_CENTRO_FINANC": "2",
   			 "COD_CENTRO_FINANC": "ESTQ.2",
   			 "DESC_CENTRO_FINANC": "Usados",
   			 "DESC_TIPO_CENTRO_FINANC": "Centro de Estoque",
   			 "CENTRO_FINANC": [
   				 {
   					 "ID_CENTRO_FINANC": 3478,
   					 "COD_CENTRO_FINANC_PAI": "ESTQ.2",
   					 "COD_SUB_CENTRO_FINANC": "103",
   					 "COD_CENTRO_FINANC": "ESTQ.2.103",
   					 "DESC_CENTRO_FINANC": "POA - Bancada de Teste",
   					 "DESC_TIPO_CENTRO_FINANC": "Centro de Estoque"
   				 }
   			 ]
   		 },
   		 {
   			 "ID_CENTRO_FINANC": 3467,
   			 "COD_CENTRO_FINANC_PAI": "ESTQ",
   			 "COD_SUB_CENTRO_FINANC": "41",
   			 "COD_CENTRO_FINANC": "ESTQ.41",
   			 "DESC_CENTRO_FINANC": "POA - Reciclados",
   			 "DESC_TIPO_CENTRO_FINANC": "Centro de Estoque"
   		 }
   	 ]
    }
}

Exemplo Posman:
Captura de tela de 2024-10-01 16-49-41.png

16. Consultar Centros Financeiros

Retorno da requisição#

Retorno da requisição