Último dia do mês

Segurança

Para acessar a API, é necessário obter um token de acesso através do fluxo de autenticação OAuth2. Veja mais detalhes em Como obter acesso?

info

Ao gerar o token JWT, não esqueça de utilizar o escopo correto. Caso contrário, a requisição será rejeitada com o código de erro 401 Unauthorized.

Descrição dos campos

Campo	Tipo	Descrição
contract_date	string	Data do contrato. No formato "YYYY-MM-DD"
first_payment_date	string	Data do primeiro pagamento. No formato "YYYY-MM-DD"
number_of_payments	number	Número de pagamentos

Requisição

POST https://api-sandbox.catalisa.com.br/calc-engine/api/loan-payment-dates-calculator/calculations JWT scope: calculations-engine/calculate

Parâmetros

Sem parâmetros

Cabeçalhos

Nome	Valor
Authorization	Bearer <token>
Content-Type	application/json

Exemplo de Requisição

Corpo da Requisição

{
  "data": {
      "type": "calculations",
      "attributes": {
          "contract_date": "2023-06-22",
          "first_payment_date": "2023-07-31",
          "number_of_payments": 12
      }
  }
}

Respostas

Código	Descrição
201	Criado com sucesso. Retorna os dados da tabela de amortização.
401	Não autorizado

Exemplo de uso

Javascript

const headers = new Headers();
headers.append("Authorization", "Bearer <token>");
headers.append("Content-Type", "application/json");

const body = JSON.stringify({
  data: {
      type: "calculations",
      attributes: {
          contract_date: "2023-06-22",
          first_payment_date: "2023-07-31",
          number_of_payments: 12
      }
  }
});

const requestOptions = {
  method: "POST",
  headers: headers,
  body: body,
};

const response = await fetch(
  "https://api-sandbox.catalisa.com.br/calc-engine/api/loan-payment-dates-calculator/calculations",
  requestOptions
);
const data = await response.json();
console.log(data);

CURL

curl --location 'https://api-sandbox.catalisa.com.br/calc-engine/api/loan-payment-dates-calculator/calculations' \
--header 'Authorization: Bearer <token>' \
--data '{
    "data": {
        "type": "calculations",
        "attributes": {
            "contract_date": "2023-06-22",
            "first_payment_date": "2023-07-31",
            "number_of_payments": 12
        }
    }
}'

Exemplo de Sucesso

{
  "data": {
    "id": "53e726ab-bf62-40df-9a28-a772edad4284",
    "type": "calculations",
    "attributes": {
      "dates": [
        "2023-07-31",
        "2023-08-31",
        "2023-09-30",
        "2023-10-31",
        "2023-11-30",
        "2023-12-31",
        "2024-01-31",
        "2024-02-29",
        "2024-03-31",
        "2024-04-30",
        "2024-05-31",
        "2024-06-30"
      ]
    }
  }
}