Faturas

As faturas podem ser geradas comprando créditos VCU com cartão de crédito ou faturando pedidos em aberto (emitidos), neste caso, a fatura pode ser paga via boleto ou transferência bancária.

Faturas [GET]

BASE URL

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

Essa solicitação retorna uma lista paginada de faturas.

Atributos de resposta

Atributo	Descrição
items	Um objeto contendo todas as faturas relacionadas ao ID do cliente

Exemplo de Requisição

var axios = require('axios');

var config = {
        method: 'get',
        url: 'https://api-b2b-hml.carbonext.com.br/v1/invoices?page=1&page-size=10&sort-by=totalVcuAmount_desc&filter-by=totalPrice_ge:7000~status_in:Paid-pending~bla',
        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

{
        "items": [
                {
                        "id": "24882adc-d020-4e5a-ac26-36c12d24c507",
                        "status": "Paid",
                        "totalVcuAmount": 1.0,
                        "totalPrice": 137.5,
                        "currency": "BRL",
                        "customerId": "a2170dcf-a87f-4fdb-b4e6-54e4f0889324",
                        "createdAt": "2022-02-11T16:47:02.894999",
                        "paidAt": "2022-02-11T16:47:05.226771",
                        "dueDate": null
                }
        ],
        "pageIndex": 1,
        "totalPages": 1,
        "totalCount": 1,
        "aggregations": null,
        "hasPreviousPage": false,
        "hasNextPage": false
}

Fatura [GET]

BASE URL

https://api-b2b-hml.carbonext.com.br/v1/invoices/:id

Esta solicitação retornará informações sobre uma fatura específica.

Atributos de Resposta

Atributo	Descrição
id	ID de uma fatura
status	O status de uma fatura
totalVcuAmount	Quantas VCUs estão sendo negociadas nesta fatura
totalPrice	A quantidade de moeda negociada nesta fatura, na moeda especificada abaixo
currency	A moeda negociada nesta fatura
customerId	O ID do cliente que possui a fatura
createdAt	Data em que foi criado
paidAt	Data em que foi pago
dueDate	Data de vencimento

Exemplo de Requisição

var axios = require('axios');

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

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

PATH VARIABLES

id: 24882adc-d020-4e5a-ac26-36c12d24c507

Exemplo de Resposta

{
        "id": "b8a6c960-c21c-46fe-a2e9-1816217c3fa6",
        "status": "Paid",
        "totalVcuAmount": 1.0,
        "totalPrice": 110.00,
        "currency": "BRL",
        "customerId": "b377ea40-4563-46cf-8f7f-d15f15b8772d",
        "createdAt": "2023-03-02T17:33:22.292083",
        "paidAt": "2023-03-02T17:33:24.837946",
        "dueDate": "2023-03-12T17:33:22.287299",
        "paymentType": "creditCard",
        "generatesRetirement": true,
        "invoiceUploadUrl": "https://carbonext-b2b.s3.amazonaws.com/invoices",
        "paymentMethodId": "pm_1MhG0KJRcnwkuWspxFMi2UtO",
        "netSuiteIntegrationId": "29630",
        "purchaseType": "prePaid",
        "paymentData": [],
        "orders": []
}