Consulta saldos de um colaborador

GET 
/v1/saldo

Retorna os saldos do colaborador identificado por empresa e matrícula, ordenados pela competência. A consulta pode selecionar uma competência específica ou limitar um intervalo. Quando presente, dtComp deve ser o último dia do mês.

Authorization

Autentique-se em POST /v1/autenticacao e informe no campo Bearer Token somente o valor da propriedade token retornada. A interface enviará o cabeçalho Authorization: Bearer TOKEN automaticamente.

Request

Query Parameters

Responses

200

Saldos encontrados; data é uma lista vazia quando não há resultados.

application/json

Schema

Schema

success booleanrequired
message stringnullablerequired
total int64required

data

object[]

required

Array [

id int64required

colaborador

object

required

id int64required

empCod int64required

matricula int64required

dtComp daterequired

dtIniVig daterequired

dtFimVig daterequired

vlrSaldo doublerequired

]

Example (from schema)

{
  "success": true,
  "message": "string",
  "total": 0,
  "data": [
    {
      "id": 0,
      "colaborador": {
        "id": 0,
        "empCod": 0,
        "matricula": 0
      },
      "dtComp": "2024-07-29",
      "dtIniVig": "2024-07-29",
      "dtFimVig": "2024-07-29",
      "vlrSaldo": 0
    }
  ]
}

sucesso

{
  "success": true,
  "message": null,
  "total": 1,
  "data": [
    {
      "id": 1,
      "colaborador": {
        "id": 10,
        "empCod": 1,
        "matricula": 1069
      },
      "dtComp": "2026-06-30",
      "dtIniVig": "2026-05-16",
      "dtFimVig": "2026-06-15",
      "vlrSaldo": 1260.28
    }
  ]
}

semResultados

{
  "success": true,
  "message": null,
  "total": 0,
  "data": []
}

400

Regra de negócio não atendida ou chamada inválida.

application/json

Schema

Schema

success booleanrequired
message stringrequired
total int64
data undefined[]
cause stringnullable

Example (from schema)

{
  "success": false,
  "message": "Invalid call of API.",
  "total": 0,
  "data": [
    null
  ],
  "cause": "string"
}

422

Falha de binding ou validação dos parâmetros recebidos.

application/json

Schema

Schema

success booleanrequired
message stringrequired
total int64
data undefined[]
cause stringnullable

Example (from schema)

{
  "success": false,
  "message": "Invalid call of API.",
  "total": 0,
  "data": [
    null
  ],
  "cause": "string"
}

Loading...