API Reference
Referência técnica completa dos endpoints da API Conta Simples
Sobre esta seção
A API Reference é a referência técnica dos endpoints da API Conta Simples. Aqui você encontra:
- Todos os endpoints disponíveis com parâmetros e schemas
- Exemplos de request e response
- Códigos de resposta HTTP
- Playground interativo para testar chamadas
Novo por aqui? Recomendamos começar pelos Guides antes de explorar a referência técnica. Os guias explicam os conceitos e fluxos — esta seção foca nos detalhes técnicos de cada endpoint.
Como usar esta referência
Entenda o fluxo nos Guides
Leia o Fluxo de Integração Recomendado para entender a jornada completa.
Consulte o endpoint específico
Use esta referência para ver parâmetros, tipos e exemplos de cada endpoint.
Teste no playground
Use o playground interativo ao lado de cada endpoint para testar chamadas diretamente.
Consulte o Dicionário de Dados
Para entender o significado de cada campo, consulte o Dicionário de Dados.
Endpoints disponíveis
Anexos
| Método | Endpoint | Descrição |
|---|---|---|
POST | /attachments/v1 | Vincular Comprovante ou Nota Fiscal |
GET | /attachments/v1/content/{attachmentId} | Download de Anexo |
Autenticação
| Método | Endpoint | Descrição |
|---|---|---|
POST | /oauth/v1/access-token | Obter Token de Acesso |
Cartões
| Método | Endpoint | Descrição |
|---|---|---|
GET | /credit-cards/v1/cards | Listar Cartões |
GET | /credit-cards/v1/cashback | Consultar saldo de cashback |
POST | /credit-cards/v1/{id}/block | Bloquear Cartão |
POST | /credit-cards/v1/{id}/unblock | Desbloquear Cartão |
Categorias
| Método | Endpoint | Descrição |
|---|---|---|
GET | /categories/v1/categories | Listar Categorias |
POST | /categories/v1/categories | Criar Categoria |
DELETE | /categories/v1/categories | Deletar categorias |
GET | /categories/v1/categories/{id} | Obter Categoria por ID |
PATCH | /categories/v1/categories/{id} | Atualizar nome da categoria |
Centros de Custo
| Método | Endpoint | Descrição |
|---|---|---|
GET | /cost-centers/v1/cost-centers | Listar Centros de Custo |
POST | /cost-centers/v1/cost-centers | Criar Centro de Custo |
GET | /cost-centers/v1/cost-centers/{id} | Consultar Centro de Custo por ID |
PATCH | /cost-centers/v1/cost-centers/{id} | Atualizar Centro de Custo |
DELETE | /cost-centers/v1/cost-centers/{id} | Excluir Centro de Custo |
Contas
| Método | Endpoint | Descrição |
|---|---|---|
GET | /accounts/v1/balance | Saldo da Conta |
Faturas
| Método | Endpoint | Descrição |
|---|---|---|
GET | /credit-cards/v1/bills | Listar faturas |
GET | /credit-cards/v1/bills/{dueDate} | Detalhes da fatura |
Fornecedores
| Método | Endpoint | Descrição |
|---|---|---|
GET | /suppliers/v1/suppliers | Listar Fornecedores |
POST | /suppliers/v1/suppliers | Criar Fornecedor |
GET | /suppliers/v1/suppliers/{id} | Consultar Fornecedor por ID |
PUT | /suppliers/v1/suppliers/{id} | Atualizar Fornecedor |
DELETE | /suppliers/v1/suppliers/{id} | Excluir Fornecedor |
Transações
| Método | Endpoint | Descrição |
|---|---|---|
GET | /statements/v1/banking | Extrato Bancário |
PATCH | /statements/v1/banking/{transactionId} | Atualizar Transação Bancária |
GET | /statements/v1/banking/{transactionId}/receipt | Comprovante de Transação Bancária |
GET | /statements/v1/credit-card | Extrato de Cartão |
PATCH | /statements/v1/credit-card/{transactionId} | Atualizar Transação de Cartão |
Usuários
| Método | Endpoint | Descrição |
|---|---|---|
GET | /users/v1/invites | Listar Convites |
GET | /users/v1/roles | Listar Papéis (Roles) |
GET | /users/v1/users | Listar Usuários |
GET | /users/v1/users/{userId} | Consultar Usuário por ID |
DELETE | /users/v1/users/{userId} | Excluir Usuário |
PATCH | /users/v1/users/{userId} | Atualizar Usuário |
VCN
| Método | Endpoint | Descrição |
|---|---|---|
POST | /credit-cards/v1/vcns | Criar VCN (Em breve) |
PATCH | /credit-cards/v1/vcns/{vcnId} | Atualizar VCN (Em breve) |
GET | /credit-cards/v1/vcns/{vcnId}/reveal | Revelar dados do VCN (Em breve) |
Autenticação
Todas as requisições requerem autenticação via Bearer token no header Authorization:
curl -X GET https://api-sandbox.contasimples.com/statements/v1/credit-card \
-H "Authorization: Bearer {TOKEN}" \
-H "Content-Type: application/json" \
-H "User-Agent: {nome-do-seu-app}/{versao}"
| Header | Valor | Obrigatório |
|---|---|---|
Authorization | Bearer {TOKEN} | Sim |
Content-Type | application/json | Sim (para POST) |
Guia de Autenticação
Como obter e renovar tokens de acesso.
Convenções
Datas
| Contexto | Formato | Exemplo |
|---|---|---|
| Parâmetros de entrada | YYYY-MM-DD | 2025-01-15 |
| Campos de resposta | ISO 8601 | 2025-01-15T14:30:00.000Z |
Valores monetários
Valores vêm como number (decimais) em Reais (BRL).
Paginação
Paginação baseada em cursor via nextPageStartKey. Veja Boas Práticas — Paginação para implementação completa.