Faturas

Route (Rota)

Método	Rota	Descrição
POST	`/webservice/invoices`	Lista todas as faturas da plataforma

Headers (Cabeçalho)

Param	Tipo	Descrição	Obrigatório
Accept	`String`	application/json	Sim
content-type	`String`	application/json	Sim
secret	`String`	*Secret Key	Sim
token	`String`	**Webservice Token	Sim

*Para conseguir a Secret Key acesse sua Plataforma, abra o Menu, vá na área de Usuários e acesse Webservice, lá você terá a lista de usuários com suas respectivas Secret Key

** Token gerado pela rota de autenticação

Query params (Parâmetros)

Param	Tipo	Descrição	Obrigatório
plan_id	`int`	id do plano	Não
status	`int`	Status da fatura - Ex: 0 = Paga; 1 = Aberta; 2 = Atrasada; 3 = Vencida; 4 = Processando; 5 = Em Análise; 6 = Cancelada;	Não
due_date	`Date`	Data de Vencimento - Ex.: 2025-06-25	Não
start_date	`Date`	Data para busca por periodo inicio - Ex.: 2025-06-25	Não
end_date	`Date`	Data para busca por periodo fim- Ex.: 2025-06-25	Não

Exemplos

cURL

				
					curl --location 'https://sua.plataforma.com/webservice/invoices?per_page=1&page=1&plan_id=3&due_date=2025-06-25&start_date=2025-06-24&end_date=2025-06-25' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'secret: {{ _.webservice_secret }}' \
--header 'token: {{ _.webservice_secret }}' \

Node.js

				
					const axios = require('axios');

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'https://sua.plataforma.com/webservice/invoices?per_page=1&page=1&plan_id=3&due_date=2025-06-25&start_date=2025-06-24&end_date=2025-06-25',
  headers: { 
    'Content-Type': 'application/json', 
    'Accept': 'application/json', 
    'secret': '{{ _.webservice_secret }}', 
    'token': '{{ _.webservice_secret }}'
  },
  data : data
};

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

PHP

				
					<?php
$client = new Client();
$headers = [
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'secret' => '{{ _.webservice_secret }}',
  'token' => '{{ _.webservice_secret }}'
];

$request = new Request('POST', 'https://sua.plataforma.com/webservice/invoices?per_page=1&page=1&plan_id=3&due_date=2025-06-25&start_date=2025-06-24&end_date=2025-06-25', $headers);
$res = $client->sendAsync($request)->wait();
echo $res->getBody();

Response (Respostas)

- Resposta ao criar um novo aluno (Status: 200)

				
					{
	"current_page": 1,
	"data": [
		{
			"id": 8220,
			"invoice_id": "2025110965f0da970",
			"attachment_id": null,
			"value": "100.00",
			"issue_date": "2025-09-11 00:00:00",
			"due_date": "2025-09-09",
			"pay_date": null,
			"paid_value": null,
			"payment_method": null,
			"payment_data": null,
			"status": 1,
			"duplicated": 0,
			"student_id": 54,
			"recurrence_id": 25,
			"plan_id": 15,
			"created_at": "2025-09-11T06:02:24.000000Z",
			"updated_at": "2025-09-11T06:02:24.000000Z",
			"pay_id": null,
			"currency": {
				"id": 1,
				"rate": 1,
				"name": "Real",
				"code": "BRL",
				"status": 1,
				"is_default": 1,
				"prefix": "R$ ",
				"suffix": "",
				"decimal": ",",
				"thousands": ".",
				"precision": 2,
				"auto_update": 1,
				"created_at": "2023-12-18T12:08:54.000000Z",
				"updated_at": "2023-12-18T12:08:54.000000Z"
			},
			"fee": null,
			"interest": null,
			"due_date_duplicate": null,
			"total": "100.00",
			"uuid_pattern": "0"
		}
	],
	"first_page_url": "https://sua.plataforma.com/webservice/invoices?page=1",
	"from": 1,
	"last_page": 1039,
	"last_page_url": "https://sua.plataforma.com/webservice/invoices?page=1039",
	"links": [
		{
			"url": null,
			"label": "pagination.previous",
			"active": false
		},
		{
			"url": "https://sua.plataforma.com/webservice/invoices?page=1",
			"label": "1",
			"active": true
		},
		{
			"url": "https://sua.plataforma.com/webservice/invoices?page=2",
			"label": "2",
			"active": false
		},
		{
			"url": "https://sua.plataforma.com/webservice/invoices?page=3",
			"label": "3",
			"active": false
		},
		{
			"url": "https://sua.plataforma.com/webservice/invoices?page=4",
			"label": "4",
			"active": false
		},
		{
			"url": "https://sua.plataforma.com/webservice/invoices?page=5",
			"label": "5",
			"active": false
		},
		{
			"url": "https://sua.plataforma.com/webservice/invoices?page=6",
			"label": "6",
			"active": false
		},
		{
			"url": "https://sua.plataforma.com/webservice/invoices?page=7",
			"label": "7",
			"active": false
		},
		{
			"url": "https://sua.plataforma.com/webservice/invoices?page=8",
			"label": "8",
			"active": false
		},
		{
			"url": "https://sua.plataforma.com/webservice/invoices?page=9",
			"label": "9",
			"active": false
		},
		{
			"url": "https://sua.plataforma.com/webservice/invoices?page=10",
			"label": "10",
			"active": false
		},
		{
			"url": null,
			"label": "...",
			"active": false
		},
		{
			"url": "https://sua.plataforma.com/webservice/invoices?page=1038",
			"label": "1038",
			"active": false
		},
		{
			"url": "https://sua.plataforma.com/webservice/invoices?page=1039",
			"label": "1039",
			"active": false
		},
		{
			"url": "https://sua.plataforma.com/webservice/invoices?page=2",
			"label": "pagination.next",
			"active": false
		}
	],
	"next_page_url": "https://sua.plataforma.com/webservice/invoices?page=2",
	"path": "https://sua.plataforma.com/webservice/invoices",
	"per_page": 1,
	"prev_page_url": null,
	"to": 1,
	"total": 1039
}