Saldo

A solicitação nesta página refere-se ao saldo do cliente.

O saldo é a diferença entre as faturas pagas, que geram créditos, e todos os pedidos não cancelados criados para o cliente, além de informações detalhadas para dívidas futuras, que são os pedidos não faturados.

Saldo [GET]

BASE URL

https://api-b2b-hml.carbonext.com.br/v1/customers/balance

Esta solicitação retorna o saldo do cliente para cada moeda em que possui pedidos e/ou faturas.

Required permissions

financial_write
financial_read

Parâmetros de Requisição

Parâmetro (opcional)	Descrição
startDate Formato: AAAA-MM-DD	Define a data de início para realizar o cálculo do saldo. Este parâmetro é opcional, se omitido a API calculará o saldo desde o primeiro pedido e/ou fatura
endDate Formato: AAAA-MM-DD	Define a data final para realizar o cálculo do saldo. Este parâmetro é opcional, se omitido a API calculará o saldo até a data atual

Parâmetros de Resposta

Atributo	Descrição
startDate	A data em que a requisição começou a procurar dados. Só aparecerá na resposta se fizer parte da requisição
endDate	A data em que a requisição parou de procurar dados. Só aparecerá na resposta se fizer parte da requisição
balancesByCurrency	Um array de objetos, cada um contendo um objeto VcuBalance e a moeda usada para criar pedidos

Exemplo de Requisição

var axios = require('axios');

var config = {
        method: 'get',
        url: 'https://api-b2b-hml.carbonext.com.br/v1/customers/balance',
        headers: { 
                'Authorization': 'Bearer <access_token>'
        }
};

axios(config)
        .then(function (response) {
                console.log(JSON.stringify(response.data));
        })
        .catch(function (error) {
                console.log(error);
        });

Exemplo de Resposta

{
        "startDate": "2022-07-21T19:07:19.634916",
        "endDate": "2022-07-22T17:03:29.6645009Z",
        "balancesByCurrency": [
                {
                        "currency": "BRL",
                        "vcuBalance": {
                                "type": "VCU",
                                "balance": 1.0,
                                "credit": 1.0,
                                "debt": 0.0,
                                "futureDebt": 0.02
                        }
                }
        ]
}