API Reference

Full technical reference for the Conta Simples API endpoints

About this section

The API Reference is the technical description of the Conta Simples API endpoints. Here you will find:

All available endpoints with parameters and schemas
Request and response examples
HTTP response codes
An interactive playground to test calls

New here? We recommend starting with the Guides before exploring the technical reference. The guides cover concepts and flows — this section focuses on the technical details of each endpoint.

How to use this reference

Understand the flow in the Guides

Read the Recommended integration flow to see the end-to-end journey.

Open the specific endpoint

Use this reference to see parameters, types, and examples for each endpoint.

Try the playground

Use the interactive playground next to each endpoint to test calls.

Check the data dictionary

For field meanings, see the Data dictionary.

Available endpoints

POST /oauth/v1/access-token

Get a JWT access token with OAuth 2.0 Client Credentials to authenticate API calls.

GET /statements/v1/credit-card

Card transaction statement for a date range. Returns transactions with card, category, cost center, and attachments.

GET /attachments/v1/content/{attachmentId}

Download the binary content of an attachment (receipt, invoice, or document) as PNG, JPEG, or PDF.

Authentication

All requests require a Bearer token in the Authorization header:

curl -X GET https://api-sandbox.contasimples.com/statements/v1/credit-card \
  -H "Authorization: Bearer {TOKEN}" \
  -H "Content-Type: application/json" \
  -H "User-Agent: {your-app-name}/{version}"

Header	Value	Required
`Authorization`	`Bearer {TOKEN}`	Yes
`Content-Type`	`application/json`	Yes (for POST)

Authentication guide

How to obtain and refresh access tokens.

Notes per endpoint

POST /oauth/v1/access-token

First time? See the Authentication guide for the full OAuth 2.0 Client Credentials flow, token refresh, and credential security.

GET /statements/v1/credit-card

Context: For field definitions, use the Data dictionary. For pagination and retry patterns, see Best practices.

GET /attachments/v1/content/{attachmentId}

Context: Attachment IDs are returned in each transaction’s attachments array (GET /statements/v1/credit-card). For download examples, see Best practices — Attachments.