Obtenha configurações da conta

Retorna configurações e metadados da conta autenticada: usuários, origens de leads, tipos de tarefas, fases processuais, tipos de processos e dados financeiros.

Este endpoint fornece os IDs de referência necessários para criar/atualizar registros em outros endpoints.

Campos retornados:

users - Usuários do escritório (use id em: Customers, Lawsuits, Tasks, Transactions)
origins - Origens de leads (use id como customers_origins_id em: Customers)
tasks - Tipos de tarefas disponíveis (use id como tasks_id em: Tasks/Posts)
stages - Fases processuais (use id como stages_id em: Lawsuits)
type_lawsuits - Tipos de processos por área do direito (use id como type_lawsuits_id em: Lawsuits)
financial - Dados financeiros:
- banks - Contas bancárias (use id como debit_account em: Transactions)
- categories - Categorias financeiras com tipo CRÉDITO/DÉBITO (use id como categories_id em: Transactions)
- cost_centers - Centros de custo (use id como cost_centers_id em: Transactions)
- departments - Departamentos (use id como sectors_id em: Transactions)

Recomendação: Execute este endpoint ao inicializar sua integração e armazene os IDs em cache para uso nas operações subsequentes.

⚠️ Os IDs retornados são específicos da sua conta.

Authorization

BearerAuth

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://app.advbox.com.br/api/v1/settings"

{
  "users": [
    {
      "id": 100001,
      "name": "MARIA SILVA",
      "email": "maria.silva@escritorio.com.br",
      "cellphone": "(11) 99999-1234"
    },
    {
      "id": 100002,
      "name": "CARLOS SOUZA",
      "email": "carlos.souza@escritorio.com.br",
      "cellphone": "(11) 98888-5678"
    }
  ],
  "origins": [
    {
      "id": 422001,
      "origin": "ESCRITORIO"
    },
    {
      "id": 422002,
      "origin": "INDICACAO"
    },
    {
      "id": 422003,
      "origin": "INSTAGRAM"
    },
    {
      "id": 422004,
      "origin": "FACEBOOK"
    }
  ],
  "tasks": [
    {
      "id": 500001,
      "task": "AUDIENCIA",
      "reward": 150
    },
    {
      "id": 500002,
      "task": "PETICAO INICIAL",
      "reward": 100
    },
    {
      "id": 500003,
      "task": "RECURSO",
      "reward": 200
    }
  ],
  "stages": [
    {
      "id": 300001,
      "stage": "FASE INSTRUTORIA",
      "step": "JUDICIAL"
    },
    {
      "id": 300002,
      "stage": "AGUARDANDO AUDIENCIA",
      "step": "JUDICIAL"
    },
    {
      "id": 300003,
      "stage": "RECURSO PROTOCOLADO",
      "step": "RECURSAL"
    }
  ],
  "type_lawsuits": [
    {
      "id": 1234567,
      "type": "ACAO TRABALHISTA",
      "group": "TRABALHISTA"
    },
    {
      "id": 1234568,
      "type": "ACAO CIVIL PUBLICA",
      "group": "CIVEL"
    },
    {
      "id": 1234569,
      "type": "ACAO PENAL",
      "group": "CRIMINAL"
    }
  ],
  "financial": {
    "banks": [
      {
        "id": 135001,
        "name": "CONTA PRINCIPAL",
        "institution": "BANCO DO BRASIL"
      },
      {
        "id": 135002,
        "name": "CONTA POUPANCA",
        "institution": "CAIXA ECONOMICA"
      }
    ],
    "categories": [
      {
        "id": 1,
        "category": "HONORARIOS INICIAIS",
        "type": "income"
      },
      {
        "id": 2,
        "category": "HONORARIOS DE EXITO",
        "type": "income"
      },
      {
        "id": 101,
        "category": "CUSTAS PROCESSUAIS",
        "type": "expense"
      }
    ],
    "cost_centers": [
      {
        "id": 41001,
        "cost_center": "GERAL"
      },
      {
        "id": 41002,
        "cost_center": "CIVEL"
      },
      {
        "id": 41003,
        "cost_center": "TRABALHISTA"
      }
    ],
    "departments": [
      {
        "id": 10001,
        "department": "CONTENCIOSO"
      },
      {
        "id": 10002,
        "department": "CONSULTIVO"
      }
    ]
  }
}

{
  "error": "Unauthenticated."
}

Obtenha configurações da conta

Campos retornados:

Authorization

Response Body

200application/json

401application/json

`application/json`

`application/json`