Saldo

Como solicitar um relatório de saldo?

Lembrando que, para garantir o êxito da requisição, é essencial incluir o access_token. Este token é adquirido durante o processo de autenticação da conta e deve ser incorporado à solicitação.

Para solicitar um relatório de saldo basta você enviar uma solicitação Get para o endpoint a seguir:

Saldos

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

successful

No content

401

authorization failed

422

validation failed

500

unknown server error

get

/internal/api/v1/balances

HTTPcURLJavaScriptPython

GET /internal/api/v1/balances HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

A consulta gera um objeto JSON que apresenta detalhadamente as informações do saldo relacionadas à conta consultada.

{
	"total_current": 1,
	"current_page": 1,
	"total_pages": 1,
	"total_per_pages": 10,
	"list": [
		{
			"id": 4142401,
			"balance": "321.15",
			"credit": "1007.46",
			"debit": "686.31",
			"dt_balance": "2024-02-26T17:22:57.706Z",
			"company_id": {
				"id": 361,
				"ispb": "",
				"corporateName": "REVIVE CARE DESCARTAVEIS HOPITALARES DO BRASIL LTDA",
				"cpfCnpj": "41014420000104",
				"address": "Rua André Rebouças",
				"n_address": "55",
				"complementary_address": "",
				"cep": "13478131",
				"city": "Americana",
				"state": "SP",
				"comercialEmail": "[email protected]",
				"comercialPhone": "(19) 99891-5273",
				"agency": "",
				"account": "",
				"accountType": "",
				"inclusionDate": "2023-12-13T03:01:12.000Z",
				"companyType": "CUSTOMER",
				"status": "VERIFICADO",
				"clientToken": "352db55b-298f-450c-a14e-e569880b6a7e",
				"created_at": "2023-11-17T06:23:31.401Z",
				"updated_at": "2024-02-19T05:22:50.527Z",
				"deleted_at": null,
				"type": "PJ"
			}
		}
	]
}

Descrição dos campos:

Os campos que são de mais importância para essa requisição serão descritos a seguir:

corporateName (string): Razão social da empresa.

balance (decimal): Saldo total da conta.

credit (decimal): valor creditado na conta.

debit (decimal): valor debitado na conta.

dtBalance (string): Data e hora do último saldo registrado.

company_id (list): Dados da empresa em que está fazendo a requisição.