Pular para o conteúdo principal

Lancamentos Financeiros

Gerencie lancamentos financeiros (contas a receber e a pagar) da sua empresa.

Listar Lancamentos

GET /external/v1/financial-entries

Retorna uma lista paginada de lancamentos financeiros.

Query Parameters:

ParametroTipoObrigatorioDescricao
pagenumberNaoPagina atual (default: 1)
limitnumberNaoItens por pagina (default: 20, max: 100)
searchstringNaoBusca por titulo
typeCategorystringNaoREVENUE (receita) ou EXPENSE (despesa)
statusstringNaoPENDING, SETTLED, OVERDUE, CANCELLED
personIdstringNaoFiltro por pessoa vinculada
dueDateFromstringNaoVencimento a partir de (ISO 8601: YYYY-MM-DD)
dueDateTostringNaoVencimento ate (ISO 8601: YYYY-MM-DD)
orderBystringNaoCampo: title, originalDueDate, originalAmount, createdAt (default: createdAt)
orderstringNaoASC ou DESC (default: DESC)

Exemplo de requisicao:

curl -X GET "https://api.tesselys.com.br/external/v1/financial-entries?typeCategory=REVENUE&status=PENDING&dueDateFrom=2026-03-01&dueDateTo=2026-03-31&limit=20" \
-H "Authorization: Bearer {accessToken}" \
-H "x-company-token: {companyToken}"

Resposta (200):

{
"data": [
{
"id": "clx5e6f7g8h9i0j1k2l3m4n5",
"code": "REC-2030",
"title": "Fatura Mensal - Tech Solutions",
"personId": "clx1a2b3c4d5e6f7g8h9i0j1",
"personName": "Tech Solutions Ltda",
"typeCategory": "REVENUE",
"status": "PENDING",
"originalAmount": 8500.00,
"paidAmount": null,
"originalDueDate": "2026-03-31T00:00:00.000Z",
"paymentDate": null,
"financialCategoryId": "clxcat001",
"financialCategoryName": "Servicos Prestados",
"bankAccountId": "clxbank001",
"bankAccountName": "Conta Principal - Itau",
"paymentMethod": "BANK_SLIP",
"installmentNumber": 1,
"totalInstallments": 1,
"isActive": true,
"createdAt": "2026-03-01T09:00:00.000Z",
"updatedAt": "2026-03-01T09:00:00.000Z"
}
],
"meta": {
"total": 34,
"page": 1,
"limit": 20,
"totalPages": 2
}
}

Buscar Lancamento por ID

GET /external/v1/financial-entries/:id

Exemplo de requisicao:

curl -X GET "https://api.tesselys.com.br/external/v1/financial-entries/clx5e6f7g8h9i0j1k2l3m4n5" \
-H "Authorization: Bearer {accessToken}" \
-H "x-company-token: {companyToken}"

Resposta (200):

{
"id": "clx5e6f7g8h9i0j1k2l3m4n5",
"code": "REC-2030",
"title": "Fatura Mensal - Tech Solutions",
"personId": "clx1a2b3c4d5e6f7g8h9i0j1",
"personName": "Tech Solutions Ltda",
"typeCategory": "REVENUE",
"status": "PENDING",
"originalAmount": 8500.00,
"paidAmount": null,
"discountAmount": 0,
"interestAmount": 0,
"fineAmount": 0,
"originalDueDate": "2026-03-31T00:00:00.000Z",
"paymentDate": null,
"financialCategoryId": "clxcat001",
"financialCategoryName": "Servicos Prestados",
"bankAccountId": "clxbank001",
"bankAccountName": "Conta Principal - Itau",
"paymentMethod": "BANK_SLIP",
"installmentNumber": 1,
"totalInstallments": 1,
"notes": "Referente ao contrato mensal de suporte tecnico.",
"isActive": true,
"createdAt": "2026-03-01T09:00:00.000Z",
"updatedAt": "2026-03-01T09:00:00.000Z"
}

Criar Lancamento

POST /external/v1/financial-entries

Body:

CampoTipoObrigatorioDescricao
personIdstringSimID da pessoa vinculada
titlestringSimTitulo do lancamento (max: 255)
typeCategorystringSimREVENUE (receita) ou EXPENSE (despesa)
originalAmountnumberSimValor original (deve ser maior que zero)
originalDueDatestringSimData de vencimento (ISO 8601: YYYY-MM-DD)
financialCategoryIdstringSimID da categoria financeira
bankAccountIdstringSimID da conta bancaria
paymentMethodstringNaoMetodo de pagamento (ver enum abaixo)
totalInstallmentsnumberNaoNumero de parcelas (default: 1, max: 120)
notesstringNaoObservacoes

Exemplo — Lancamento avista:

curl -X POST "https://api.tesselys.com.br/external/v1/financial-entries" \
-H "Authorization: Bearer {accessToken}" \
-H "x-company-token: {companyToken}" \
-H "Content-Type: application/json" \
-d '{
"personId": "clx1a2b3c4d5e6f7g8h9i0j1",
"title": "Consultoria Tributaria - Marco/2026",
"typeCategory": "REVENUE",
"originalAmount": 4500.00,
"originalDueDate": "2026-04-10",
"financialCategoryId": "clxcat001",
"bankAccountId": "clxbank001",
"paymentMethod": "PIX"
}'

Resposta (201):

{
"id": "clx6f7g8h9i0j1k2l3m4n5o6",
"code": "REC-2031",
"title": "Consultoria Tributaria - Marco/2026",
"personId": "clx1a2b3c4d5e6f7g8h9i0j1",
"personName": "Tech Solutions Ltda",
"typeCategory": "REVENUE",
"status": "PENDING",
"originalAmount": 4500.00,
"paidAmount": null,
"originalDueDate": "2026-04-10T00:00:00.000Z",
"paymentDate": null,
"financialCategoryId": "clxcat001",
"financialCategoryName": "Servicos Prestados",
"bankAccountId": "clxbank001",
"bankAccountName": "Conta Principal - Itau",
"paymentMethod": "PIX",
"installmentNumber": 1,
"totalInstallments": 1,
"isActive": true,
"createdAt": "2026-03-25T10:30:00.000Z",
"updatedAt": "2026-03-25T10:30:00.000Z"
}

Exemplo — Lancamento parcelado:

curl -X POST "https://api.tesselys.com.br/external/v1/financial-entries" \
-H "Authorization: Bearer {accessToken}" \
-H "x-company-token: {companyToken}" \
-H "Content-Type: application/json" \
-d '{
"personId": "clx1a2b3c4d5e6f7g8h9i0j1",
"title": "Licenca Anual de Software",
"typeCategory": "EXPENSE",
"originalAmount": 24000.00,
"originalDueDate": "2026-04-01",
"financialCategoryId": "clxcat005",
"bankAccountId": "clxbank001",
"paymentMethod": "CREDIT_CARD",
"totalInstallments": 12,
"notes": "Licenca anual do software de gestao. 12x de R$ 2.000,00."
}'
Parcelamento

Quando totalInstallments > 1, o sistema cria automaticamente as parcelas com vencimentos mensais a partir da originalDueDate. O valor de cada parcela e calculado automaticamente (originalAmount / totalInstallments).

Valores de Enum

typeCategory

ValorDescricao
REVENUEReceita (conta a receber)
EXPENSEDespesa (conta a pagar)

status (somente leitura)

ValorDescricao
PENDINGPendente — aguardando pagamento
SETTLEDLiquidado — pagamento confirmado
OVERDUEVencido — passou da data de vencimento sem pagamento
CANCELLEDCancelado

paymentMethod

ValorDescricao
PIXPIX
CREDIT_CARDCartao de credito
DEBIT_CARDCartao de debito
BANK_SLIPBoleto bancario
BANK_TRANSFERTransferencia bancaria
CASHDinheiro
CHECKCheque
OTHEROutro