GET/api/finances

Listar Finanças

Lista todas as finanças

Access Token

Para realizar requisições GET, POST, PUT, DELETE e PATCH nos endpoints da API você precisa de uma chave de autorização. Chamamos essa chave de accessToken.

Para ter acesso ao accessToken, é necessário que o usuário master da licença efetue a liberação deste pela interface do ImageMais Clinic. O accessToken tem validade de 1 hora.

Headers

AuthorizationOBRIGATÓRIO
Tipo:string
Token de autenticação no formato Bearer {accessToken}

Parâmetros

limitOPCIONAL
Tipo:number
Limite de finanças a serem retornados

Este parâmetro define o número máximo de finanças que serão retornadas na resposta. É um parâmetro opcional que permite controlar a paginação dos resultados.

Exemplo:

?limit=50

Observação: O parâmetro limit é geralmente usado em conjunto com o parâmetro offset para implementar paginação. Por exemplo: ?limit=50&offset=0 retorna as primeiras 50 finanças.

offsetOPCIONAL
Tipo:number
Offset de finanças a serem retornados

Este parâmetro define o número de finanças que serão ignoradas antes de começar a retornar os resultados. É um parâmetro opcional que permite controlar a paginação dos resultados, geralmente usado em conjunto com o parâmetro limit.

Exemplo:

?offset=0

Observação: O valor padrão do offset é 0. Para paginar os resultados, você pode usar combinações como ?limit=50&offset=0 para a primeira página, ?limit=50&offset=50 para a segunda página, e assim por diante.

searchOPCIONAL
Tipo:string
Busca por descrição da financeira

Este parâmetro permite filtrar as finanças pela descrição. A busca é realizada de forma parcial, ou seja, retornará todas as finanças cuja descrição contenha o texto informado.

Exemplo:

?search=desconto

Observação: A busca por descrição pode ser combinada com outros parâmetros como limit e offset para paginar os resultados filtrados. Por exemplo: ?search=agendamento&limit=10&offset=0.

isEveryoneOPCIONAL
Tipo:boolean
Busca por Orçamentos ou Procedimentos

Este parâmetro é um filtro booleano que permite buscar descontos filtrados por meio de orçamentos ou procedimentos. Quando definido como true, retorna apenas descontos relacionados a orçamentos. Quando definido como false, retorna apenas descontos relacionados a procedimentos.

Exemplo:

?isEveryone=true

Observação: Este filtro pode ser combinado com outros parâmetros como limit, offset e search para filtrar e paginar os resultados. Por exemplo: ?isEveryone=true&limit=10&offset=0.

Request URL

https://api-dev.imagemais.com/api/finances/discounts?limit=3&offset=0&search=Agendamento&isEveryone=true

Respostas

{
  "data": [
    {
  ...
{
  "data": [
    {
      "id": 3,
      "name": "Desconto nos procedimentos",
      "description": null,
      "percentage": null,
      "fixed": "13",
      "isActive": true,
      "expirationDate": null,
      "isEveryone": false,
      "procedures": [
        {
          "id": 3126,
          "name": "HEMOGRAMA SEM REVISAO",
          "price": "12"
        }
      ],
      "createdAt": "2025-09-17T17:53:55.769Z",
      "updatedAt": "2025-12-03T13:40:46.766Z"
    },
    {
      "id": 2,
      "name": "Agendamento",
      "description": "Desconto para procedimentos com agendamento",
      "percentage": null,
      "fixed": "10",
      "isActive": true,
      "expirationDate": null,
      "isEveryone": false,
      "procedures": [
        {
          "id": 3645,
          "name": "Ultrassom: Articulacao Cotovelo Direito",
          "price": "120"
        },
        {
          "id": 3646,
          "name": "Ultrassom: Articulacao Cotovelo Esquerdo",
          "price": "120"
        },
        {
          "id": 3657,
          "name": "Ultrassom: Articulacao Punho Direito",
          "price": "120"
        },
        {
          "id": 3658,
          "name": "Ultrassom: Articulacao Punho Esquerdo",
          "price": "120"
        },
        {
          "id": 3696,
          "name": "Ultrassom: Parede Abdominal",
          "price": "100"
        }
      ],
      "createdAt": "2025-09-17T17:53:55.769Z",
      "updatedAt": "2025-12-03T13:40:46.766Z"
    }
  ]
}
{
  "data": [
    {
  ...
{
  "data": [
    {
      "id": 2,
      "name": "Agendamento",
      "description": "Desconto para procedimentos com agendamento",
      "percentage": null,
      "fixed": "10",
      "isActive": true,
      "expirationDate": null,
      "isEveryone": true,
      "procedures": [
        {
          "id": 3645,
          "name": "Ultrassom: Articulacao Cotovelo Direito",
          "price": "120"
        },
        {
          "id": 3646,
          "name": "Ultrassom: Articulacao Cotovelo Esquerdo",
          "price": "120"
        },
        {
          "id": 3657,
          "name": "Ultrassom: Articulacao Punho Direito",
          "price": "120"
        },
        {
          "id": 3658,
          "name": "Ultrassom: Articulacao Punho Esquerdo",
          "price": "120"
        },
        {
          "id": 3696,
          "name": "Ultrassom: Parede Abdominal",
          "price": "100"
        }
      ],
      "createdAt": "2025-09-17T17:53:55.769Z",
      "updatedAt": "2025-12-10T17:57:06.431Z"
    }
  ]
}
{
  "data": []
}
{
  "data": []
}
{
  "message": "limit must not be greater than 100",
  "error": "Bad Request"
  ...
{
  "message": "limit must not be greater than 100",
  "error": "Bad Request"
}
{
  "statusCode": 401,
  "message": "invalid token"
  ...
{
  "statusCode": 401,
  "message": "invalid token"
}
{
  "statusCode": 401,
  "message": "jwt expired"
  ...
{
  "statusCode": 401,
  "message": "jwt expired"
}
{
  "statusCode": 500,
  "message": "Internal server error"
  ...
{
  "statusCode": 500,
  "message": "Internal server error"
}