API docs by Redocly

Organizze REST API v2 (2.0.0)

Download OpenAPI specification:

URL: https://www.organizze.com.br License: Proprietary

Public REST API for Organizze, a Brazilian personal-finance app. This is the surface that agent tooling (@organizze/api-client, @organizze/mcp, @organizze/cli) is built on.

Authentication

Every request uses HTTP Basic auth: your account email as the username and an API key as the password. Generate keys in Organizze under Configurações → Chaves de API. A User-Agent header is mandatory and the account must have an active license.

curl https://api.organizze.com.br/rest/v2/accounts \
  -u "you@example.com:YOUR_API_KEY" \
  -H "User-Agent: my-app (you@example.com)"

Keys can be read-only: any write (POST/PUT/PATCH/DELETE) with a read-only key returns 403.

Conventions

  • Money is expressed in cents as integers (e.g. amount_cents, limit_cents), unless a field name says otherwise.
  • Pagination (where supported) uses the standard Link header with rel="first|last|next|prev" and a page query parameter.
  • Successful create and update return 201 (not 200) for most resources; see each operation.

Accounts

Bank and cash accounts.

List accounts

Authorizations:
basicAuth
header Parameters
User-Agent
required
string

Mandatory client identifier, e.g. my-app/1.0 (you@example.com).

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create an account

Authorizations:
basicAuth
header Parameters
User-Agent
required
string

Mandatory client identifier, e.g. my-app/1.0 (you@example.com).

Request Body schema: application/json
required
name
string
description
string or null
type
string
Enum: "checking" "savings" "other" "credit_card"
archived
boolean
institution_id
integer or null
institution_name
string or null

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "type": "checking",
  • "archived": true,
  • "institution_id": 0,
  • "institution_name": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "institution_id": 0,
  • "institution_name": "string",
  • "description": "string",
  • "type": "checking",
  • "archived": true,
  • "default": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Get an account

Authorizations:
basicAuth
path Parameters
id
required
integer
header Parameters
User-Agent
required
string

Mandatory client identifier, e.g. my-app/1.0 (you@example.com).

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "institution_id": 0,
  • "institution_name": "string",
  • "description": "string",
  • "type": "checking",
  • "archived": true,
  • "default": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "balance": "string"
}

Update an account

Authorizations:
basicAuth
path Parameters
id
required
integer
header Parameters
User-Agent
required
string

Mandatory client identifier, e.g. my-app/1.0 (you@example.com).

Request Body schema: application/json
required
name
string
description
string or null
type
string
Enum: "checking" "savings" "other" "credit_card"
archived
boolean
institution_id
integer or null
institution_name
string or null

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "type": "checking",
  • "archived": true,
  • "institution_id": 0,
  • "institution_name": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "institution_id": 0,
  • "institution_name": "string",
  • "description": "string",
  • "type": "checking",
  • "archived": true,
  • "default": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete an account

Authorizations:
basicAuth
path Parameters
id
required
integer
header Parameters
User-Agent
required
string

Mandatory client identifier, e.g. my-app/1.0 (you@example.com).

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "deleted": true
}

Archive an account

Authorizations:
basicAuth
path Parameters
id
required
integer
header Parameters
User-Agent
required
string

Mandatory client identifier, e.g. my-app/1.0 (you@example.com).

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "institution_id": 0,
  • "institution_name": "string",
  • "description": "string",
  • "type": "checking",
  • "archived": true,
  • "default": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Unarchive an account

Authorizations:
basicAuth
path Parameters
id
required
integer
header Parameters
User-Agent
required
string

Mandatory client identifier, e.g. my-app/1.0 (you@example.com).

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "institution_id": 0,
  • "institution_name": "string",
  • "description": "string",
  • "type": "checking",
  • "archived": true,
  • "default": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Credit cards

Credit cards and their settings.

List credit cards

Authorizations:
basicAuth
header Parameters
User-Agent
required
string

Mandatory client identifier, e.g. my-app/1.0 (you@example.com).

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a credit card

Authorizations:
basicAuth
header Parameters
User-Agent
required
string

Mandatory client identifier, e.g. my-app/1.0 (you@example.com).

Request Body schema: application/json
required
name
string
due_day
integer
closing_day
integer
limit_cents
integer
card_network
string
archived
boolean
update_invoices_since
string or null <date>
institution_id
integer or null
institution_name
string or null

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "due_day": 0,
  • "closing_day": 0,
  • "limit_cents": 0,
  • "card_network": "string",
  • "archived": true,
  • "update_invoices_since": "2019-08-24",
  • "institution_id": 0,
  • "institution_name": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "card_network": "string",
  • "closing_day": 0,
  • "due_day": 0,
  • "limit_cents": 0,
  • "type": "credit_card",
  • "archived": true,
  • "default": true,
  • "institution_id": 0,
  • "institution_name": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Get a credit card

Authorizations:
basicAuth
path Parameters
id
required
integer
header Parameters
User-Agent
required
string

Mandatory client identifier, e.g. my-app/1.0 (you@example.com).

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "card_network": "string",
  • "closing_day": 0,
  • "due_day": 0,
  • "limit_cents": 0,
  • "type": "credit_card",
  • "archived": true,
  • "default": true,
  • "institution_id": 0,
  • "institution_name": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update a credit card

Authorizations:
basicAuth
path Parameters
id
required
integer
header Parameters
User-Agent
required
string

Mandatory client identifier, e.g. my-app/1.0 (you@example.com).

Request Body schema: application/json
required
name
string
due_day
integer
closing_day
integer
limit_cents
integer
card_network
string
archived
boolean
update_invoices_since
string or null <date>
institution_id
integer or null
institution_name
string or null

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "due_day": 0,
  • "closing_day": 0,
  • "limit_cents": 0,
  • "card_network": "string",
  • "archived": true,
  • "update_invoices_since": "2019-08-24",
  • "institution_id": 0,
  • "institution_name": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "card_network": "string",
  • "closing_day": 0,
  • "due_day": 0,
  • "limit_cents": 0,
  • "type": "credit_card",
  • "archived": true,
  • "default": true,
  • "institution_id": 0,
  • "institution_name": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete a credit card

Authorizations:
basicAuth
path Parameters
id
required
integer
header Parameters
User-Agent
required
string

Mandatory client identifier, e.g. my-app/1.0 (you@example.com).

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "deleted": true
}

Archive a credit card

Authorizations:
basicAuth
path Parameters
id
required
integer
header Parameters
User-Agent
required
string

Mandatory client identifier, e.g. my-app/1.0 (you@example.com).

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "card_network": "string",
  • "closing_day": 0,
  • "due_day": 0,
  • "limit_cents": 0,
  • "type": "credit_card",
  • "archived": true,
  • "default": true,
  • "institution_id": 0,
  • "institution_name": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Unarchive a credit card

Authorizations:
basicAuth
path Parameters
id
required
integer
header Parameters
User-Agent
required
string

Mandatory client identifier, e.g. my-app/1.0 (you@example.com).

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "card_network": "string",
  • "closing_day": 0,
  • "due_day": 0,
  • "limit_cents": 0,
  • "type": "credit_card",
  • "archived": true,
  • "default": true,
  • "institution_id": 0,
  • "institution_name": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Invoices

Credit-card invoices and their payments.

List a credit card's invoices

Defaults to the current calendar year when start_date/end_date are omitted. The list form does not embed transactions or payments.

Authorizations:
basicAuth
path Parameters
credit_card_id
required
integer
query Parameters
start_date
string <date>

Inclusive start date (YYYY-MM-DD).

end_date
string <date>

Inclusive end date (YYYY-MM-DD).

header Parameters
User-Agent
required
string

Mandatory client identifier, e.g. my-app/1.0 (you@example.com).

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get an invoice (with transactions and payments)

Authorizations:
basicAuth
path Parameters
credit_card_id
required
integer
id
required
integer
header Parameters
User-Agent
required
string

Mandatory client identifier, e.g. my-app/1.0 (you@example.com).

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "date": "2019-08-24",
  • "starting_date": "2019-08-24",
  • "closing_date": "2019-08-24",
  • "amount_cents": 0,
  • "payment_amount_cents": 0,
  • "balance_cents": 0,
  • "previous_balance_cents": 0,
  • "credit_card_id": 0,
  • "transactions": [
    ],
  • "payments": [
    ]
}

List payments registered against an invoice

Authorizations:
basicAuth
path Parameters
credit_card_id
required
integer
invoice_id
required
integer
header Parameters
User-Agent
required
string

Mandatory client identifier, e.g. my-app/1.0 (you@example.com).

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Register a payment against an invoice

Authorizations:
basicAuth
path Parameters
credit_card_id
required
integer
invoice_id
required
integer
header Parameters
User-Agent
required
string

Mandatory client identifier, e.g. my-app/1.0 (you@example.com).

Request Body schema: application/json
required
description
string
date
string <date>
amount_cents
required
integer
account_id
integer or null

Source account. If omitted, the payment is registered against a hidden account.

category_id
integer or null
notes
string or null
billing_date
string or null <date>

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "date": "2019-08-24",
  • "amount_cents": 0,
  • "account_id": 0,
  • "category_id": 0,
  • "notes": "string",
  • "billing_date": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "description": "string",
  • "date": "2019-08-24",
  • "paid": true,
  • "amount_cents": 0,
  • "total_installments": 0,
  • "installment": 0,
  • "recurring": true,
  • "account_id": 0,
  • "account_type": "string",
  • "category_id": 0,
  • "notes": "string",
  • "attachments_count": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "tags": "string"
}

Transactions

Income and expense entries.

List transactions

Defaults to the current month when start_date/end_date are omitted. Paginated via the Link header.

Authorizations:
basicAuth
query Parameters
start_date
string <date>

Inclusive start date (YYYY-MM-DD).

end_date
string <date>

Inclusive end date (YYYY-MM-DD).

account_id
integer

Restrict results to a single account.

page
integer >= 1

Page number for Link-header pagination.

header Parameters
User-Agent
required
string

Mandatory client identifier, e.g. my-app/1.0 (you@example.com).

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a transaction

Authorizations:
basicAuth
header Parameters
User-Agent
required
string

Mandatory client identifier, e.g. my-app/1.0 (you@example.com).

Request Body schema: application/json
required
description
required
string
date
required
string <date>
paid
boolean
amount_cents
required
integer
account_id
integer or null
category_id
integer or null
notes
string or null
credit_card_id
integer or null
credit_card_invoice_id
integer or null
update_future
boolean

When updating/deleting a recurring series, apply to this and future occurrences.

update_all
boolean

When updating/deleting a recurring series, apply to all occurrences.

object

Create a finite (installment) series.

object

Create an infinite (recurring) series.

Array of objects (Tag)

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "date": "2019-08-24",
  • "paid": true,
  • "amount_cents": 0,
  • "account_id": 0,
  • "category_id": 0,
  • "notes": "string",
  • "credit_card_id": 0,
  • "credit_card_invoice_id": 0,
  • "update_future": true,
  • "update_all": true,
  • "installments_attributes": {
    },
  • "recurrence_attributes": {
    },
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "description": "string",
  • "date": "2019-08-24",
  • "paid": true,
  • "amount_cents": 0,
  • "total_installments": 0,
  • "installment": 0,
  • "recurring": true,
  • "account_id": 0,
  • "category_id": 0,
  • "notes": "string",
  • "attachments_count": 0,
  • "credit_card_id": 0,
  • "credit_card_invoice_id": 0,
  • "paid_credit_card_id": 0,
  • "paid_credit_card_invoice_id": 0,
  • "oposite_transaction_id": 0,
  • "oposite_account_id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "tags": [
    ],
  • "attachments": [
    ],
  • "recurrence_id": 0
}

Get a transaction

Authorizations:
basicAuth
path Parameters
id
required
integer
header Parameters
User-Agent
required
string

Mandatory client identifier, e.g. my-app/1.0 (you@example.com).

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "description": "string",
  • "date": "2019-08-24",
  • "paid": true,
  • "amount_cents": 0,
  • "total_installments": 0,
  • "installment": 0,
  • "recurring": true,
  • "account_id": 0,
  • "category_id": 0,
  • "notes": "string",
  • "attachments_count": 0,
  • "credit_card_id": 0,
  • "credit_card_invoice_id": 0,
  • "paid_credit_card_id": 0,
  • "paid_credit_card_invoice_id": 0,
  • "oposite_transaction_id": 0,
  • "oposite_account_id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "tags": [
    ],
  • "attachments": [
    ],
  • "recurrence_id": 0
}

Update a transaction

For recurring/installment transactions, use update_future or update_all to choose the scope. These are ignored for one-off ("permanent") transactions.

Authorizations:
basicAuth
path Parameters
id
required
integer
header Parameters
User-Agent
required
string

Mandatory client identifier, e.g. my-app/1.0 (you@example.com).

Request Body schema: application/json
required
description
required
string
date
required
string <date>
paid
boolean
amount_cents
required
integer
account_id
integer or null
category_id
integer or null
notes
string or null
credit_card_id
integer or null
credit_card_invoice_id
integer or null
update_future
boolean

When updating/deleting a recurring series, apply to this and future occurrences.

update_all
boolean

When updating/deleting a recurring series, apply to all occurrences.

object

Create a finite (installment) series.

object

Create an infinite (recurring) series.

Array of objects (Tag)

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "date": "2019-08-24",
  • "paid": true,
  • "amount_cents": 0,
  • "account_id": 0,
  • "category_id": 0,
  • "notes": "string",
  • "credit_card_id": 0,
  • "credit_card_invoice_id": 0,
  • "update_future": true,
  • "update_all": true,
  • "installments_attributes": {
    },
  • "recurrence_attributes": {
    },
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "description": "string",
  • "date": "2019-08-24",
  • "paid": true,
  • "amount_cents": 0,
  • "total_installments": 0,
  • "installment": 0,
  • "recurring": true,
  • "account_id": 0,
  • "category_id": 0,
  • "notes": "string",
  • "attachments_count": 0,
  • "credit_card_id": 0,
  • "credit_card_invoice_id": 0,
  • "paid_credit_card_id": 0,
  • "paid_credit_card_invoice_id": 0,
  • "oposite_transaction_id": 0,
  • "oposite_account_id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "tags": [
    ],
  • "attachments": [
    ],
  • "recurrence_id": 0
}

Delete a transaction

Accepts update_future/update_all in the body for recurring series.

Authorizations:
basicAuth
path Parameters
id
required
integer
header Parameters
User-Agent
required
string

Mandatory client identifier, e.g. my-app/1.0 (you@example.com).

Request Body schema: application/json
optional
description
required
string
date
required
string <date>
paid
boolean
amount_cents
required
integer
account_id
integer or null
category_id
integer or null
notes
string or null
credit_card_id
integer or null
credit_card_invoice_id
integer or null
update_future
boolean

When updating/deleting a recurring series, apply to this and future occurrences.

update_all
boolean

When updating/deleting a recurring series, apply to all occurrences.

object

Create a finite (installment) series.

object

Create an infinite (recurring) series.

Array of objects (Tag)

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "date": "2019-08-24",
  • "paid": true,
  • "amount_cents": 0,
  • "account_id": 0,
  • "category_id": 0,
  • "notes": "string",
  • "credit_card_id": 0,
  • "credit_card_invoice_id": 0,
  • "update_future": true,
  • "update_all": true,
  • "installments_attributes": {
    },
  • "recurrence_attributes": {
    },
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "deleted": true
}

List a recurring transaction's occurrences

Authorizations:
basicAuth
path Parameters
transaction_id
required
integer
query Parameters
page
integer >= 1

Page number for Link-header pagination.

header Parameters
User-Agent
required
string

Mandatory client identifier, e.g. my-app/1.0 (you@example.com).

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Transfers

Money moved between accounts.

List transfers

Defaults to the current month. Paginated via the Link header.

Authorizations:
basicAuth
query Parameters
start_date
string <date>

Inclusive start date (YYYY-MM-DD).

end_date
string <date>

Inclusive end date (YYYY-MM-DD).

account_id
integer

Restrict results to a single account.

page
integer >= 1

Page number for Link-header pagination.

header Parameters
User-Agent
required
string

Mandatory client identifier, e.g. my-app/1.0 (you@example.com).

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a transfer

Authorizations:
basicAuth
header Parameters
User-Agent
required
string

Mandatory client identifier, e.g. my-app/1.0 (you@example.com).

Request Body schema: application/json
required
description
string
date
required
string <date>
paid
boolean
amount_cents
required
integer
credit_account_id
required
integer

Destination account (credited).

debit_account_id
required
integer

Source account (debited).

category_id
integer or null
notes
string or null
update_future
boolean
update_all
boolean
object
object
Array of objects (Tag)

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "date": "2019-08-24",
  • "paid": true,
  • "amount_cents": 0,
  • "credit_account_id": 0,
  • "debit_account_id": 0,
  • "category_id": 0,
  • "notes": "string",
  • "update_future": true,
  • "update_all": true,
  • "installments_attributes": {
    },
  • "recurrence_attributes": {
    },
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "description": "string",
  • "date": "2019-08-24",
  • "paid": true,
  • "amount_cents": 0,
  • "total_installments": 0,
  • "installment": 0,
  • "recurring": true,
  • "account_id": 0,
  • "category_id": 0,
  • "notes": "string",
  • "attachments_count": 0,
  • "credit_card_id": 0,
  • "credit_card_invoice_id": 0,
  • "paid_credit_card_id": 0,
  • "paid_credit_card_invoice_id": 0,
  • "oposite_transaction_id": 0,
  • "oposite_account_id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "tags": [
    ],
  • "attachments": [
    ],
  • "recurrence_id": 0
}

Get a transfer

Authorizations:
basicAuth
path Parameters
id
required
integer
header Parameters
User-Agent
required
string

Mandatory client identifier, e.g. my-app/1.0 (you@example.com).

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "description": "string",
  • "date": "2019-08-24",
  • "paid": true,
  • "amount_cents": 0,
  • "total_installments": 0,
  • "installment": 0,
  • "recurring": true,
  • "account_id": 0,
  • "category_id": 0,
  • "notes": "string",
  • "attachments_count": 0,
  • "credit_card_id": 0,
  • "credit_card_invoice_id": 0,
  • "paid_credit_card_id": 0,
  • "paid_credit_card_invoice_id": 0,
  • "oposite_transaction_id": 0,
  • "oposite_account_id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "tags": [
    ],
  • "attachments": [
    ],
  • "recurrence_id": 0
}

Update a transfer

Authorizations:
basicAuth
path Parameters
id
required
integer
header Parameters
User-Agent
required
string

Mandatory client identifier, e.g. my-app/1.0 (you@example.com).

Request Body schema: application/json
required
description
string
date
required
string <date>
paid
boolean
amount_cents
required
integer
credit_account_id
required
integer

Destination account (credited).

debit_account_id
required
integer

Source account (debited).

category_id
integer or null
notes
string or null
update_future
boolean
update_all
boolean
object
object
Array of objects (Tag)

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "date": "2019-08-24",
  • "paid": true,
  • "amount_cents": 0,
  • "credit_account_id": 0,
  • "debit_account_id": 0,
  • "category_id": 0,
  • "notes": "string",
  • "update_future": true,
  • "update_all": true,
  • "installments_attributes": {
    },
  • "recurrence_attributes": {
    },
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "description": "string",
  • "date": "2019-08-24",
  • "paid": true,
  • "amount_cents": 0,
  • "total_installments": 0,
  • "installment": 0,
  • "recurring": true,
  • "account_id": 0,
  • "category_id": 0,
  • "notes": "string",
  • "attachments_count": 0,
  • "credit_card_id": 0,
  • "credit_card_invoice_id": 0,
  • "paid_credit_card_id": 0,
  • "paid_credit_card_invoice_id": 0,
  • "oposite_transaction_id": 0,
  • "oposite_account_id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "tags": [
    ],
  • "attachments": [
    ],
  • "recurrence_id": 0
}

Delete a transfer

Authorizations:
basicAuth
path Parameters
id
required
integer
header Parameters
User-Agent
required
string

Mandatory client identifier, e.g. my-app/1.0 (you@example.com).

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "deleted": true
}

Categories

Categories used to classify transactions.

List categories

Authorizations:
basicAuth
header Parameters
User-Agent
required
string

Mandatory client identifier, e.g. my-app/1.0 (you@example.com).

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a category

Authorizations:
basicAuth
header Parameters
User-Agent
required
string

Mandatory client identifier, e.g. my-app/1.0 (you@example.com).

Request Body schema: application/json
required
name
required
string
parent_id
integer or null
color
string
group_id
integer or null

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "parent_id": 0,
  • "color": "string",
  • "group_id": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "color": "string",
  • "parent_id": 0,
  • "group_id": 0,
  • "fixed": false,
  • "essential": true,
  • "default": true,
  • "uuid": "string",
  • "kind": "string",
  • "archived": true
}

List the available category colors

Authorizations:
basicAuth
header Parameters
User-Agent
required
string

Mandatory client identifier, e.g. my-app/1.0 (you@example.com).

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

Get a category

Authorizations:
basicAuth
path Parameters
id
required
integer
header Parameters
User-Agent
required
string

Mandatory client identifier, e.g. my-app/1.0 (you@example.com).

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "color": "string",
  • "parent_id": 0,
  • "group_id": 0,
  • "fixed": false,
  • "essential": true,
  • "default": true,
  • "uuid": "string",
  • "kind": "string",
  • "archived": true
}

Update a category

Authorizations:
basicAuth
path Parameters
id
required
integer
header Parameters
User-Agent
required
string

Mandatory client identifier, e.g. my-app/1.0 (you@example.com).

Request Body schema: application/json
required
name
required
string
parent_id
integer or null
color
string
group_id
integer or null

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "parent_id": 0,
  • "color": "string",
  • "group_id": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "color": "string",
  • "parent_id": 0,
  • "group_id": 0,
  • "fixed": false,
  • "essential": true,
  • "default": true,
  • "uuid": "string",
  • "kind": "string",
  • "archived": true
}

Delete a category

Authorizations:
basicAuth
path Parameters
id
required
integer
query Parameters
replacement_id
integer

Optional category id to reassign this category's transactions to.

header Parameters
User-Agent
required
string

Mandatory client identifier, e.g. my-app/1.0 (you@example.com).

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "deleted": true
}

Budgets

Per-category spending budgets.

List budgets for the current month

Authorizations:
basicAuth
header Parameters
User-Agent
required
string

Mandatory client identifier, e.g. my-app/1.0 (you@example.com).

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List budgets for a year

Authorizations:
basicAuth
path Parameters
year
required
integer
Example: 2026
header Parameters
User-Agent
required
string

Mandatory client identifier, e.g. my-app/1.0 (you@example.com).

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List budgets for a specific month

Authorizations:
basicAuth
path Parameters
year
required
integer
Example: 2026
month
required
integer [ 1 .. 12 ]
Example: 6
header Parameters
User-Agent
required
string

Mandatory client identifier, e.g. my-app/1.0 (you@example.com).

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Balances

Aggregated balances and projections.

Get aggregated balances

Returns aggregated totals plus a per-period breakdown. All monetary values are integers in cents.

Authorizations:
basicAuth
query Parameters
start_date
string <date>

Inclusive start date (YYYY-MM-DD).

end_date
string <date>

Inclusive end date (YYYY-MM-DD).

periodicity
string
Default: "daily"
Enum: "daily" "weekly" "monthly" "yearly"

Period grouping. Defaults to daily.

account_id
integer

Restrict results to a single account.

header Parameters
User-Agent
required
string

Mandatory client identifier, e.g. my-app/1.0 (you@example.com).

Responses

Response samples

Content type
application/json
{
  • "previous_balance": 0,
  • "previous_predicted_balance": 0,
  • "balance": 0,
  • "predicted_balance": 0,
  • "outcomes": 0,
  • "predicted_outcomes": 0,
  • "incomes": 0,
  • "predicted_incomes": 0,
  • "expenses": 0,
  • "predicted_expenses": 0,
  • "earnings": 0,
  • "predicted_earnings": 0,
  • "initial_amounts": 0,
  • "predicted_initial_amounts": 0,
  • "result": 0,
  • "predicted_result": 0,
  • "balances": [
    ]
}

Bank connections

Open-finance / bank connections.

List bank connections

Authorizations:
basicAuth
header Parameters
User-Agent
required
string

Mandatory client identifier, e.g. my-app/1.0 (you@example.com).

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a bank connection

Authorizations:
basicAuth
header Parameters
User-Agent
required
string

Mandatory client identifier, e.g. my-app/1.0 (you@example.com).

Request Body schema: application/json
required
required
object (AccountConnectionInput)

Responses

Request samples

Content type
application/json
{
  • "account_connection": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "organizze_entity_id": 0,
  • "organizze_account_id": 0,
  • "organizze_credit_card_id": 0,
  • "pluggy_account_id": "string",
  • "pluggy_item_id": "string",
  • "disconnected_at": "2019-08-24T14:15:22Z",
  • "internal_epoch": "2019-08-24",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update a bank connection

Authorizations:
basicAuth
path Parameters
id
required
integer
header Parameters
User-Agent
required
string

Mandatory client identifier, e.g. my-app/1.0 (you@example.com).

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "account_connection": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "organizze_entity_id": 0,
  • "organizze_account_id": 0,
  • "organizze_credit_card_id": 0,
  • "pluggy_account_id": "string",
  • "pluggy_item_id": "string",
  • "disconnected_at": "2019-08-24T14:15:22Z",
  • "internal_epoch": "2019-08-24",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Disconnect a bank connection

Soft-disconnects (sets disconnected_at); the record is not removed.

Authorizations:
basicAuth
path Parameters
id
required
integer
header Parameters
User-Agent
required
string

Mandatory client identifier, e.g. my-app/1.0 (you@example.com).

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "organizze_entity_id": 0,
  • "organizze_account_id": 0,
  • "organizze_credit_card_id": 0,
  • "pluggy_account_id": "string",
  • "pluggy_item_id": "string",
  • "disconnected_at": "2019-08-24T14:15:22Z",
  • "internal_epoch": "2019-08-24",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Institutions

Supported financial institutions.

List supported institutions

Supports conditional requests (ETag / If-Modified-Since); may return 304.

Authorizations:
basicAuth
header Parameters
User-Agent
required
string

Mandatory client identifier, e.g. my-app/1.0 (you@example.com).

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Users

Users within the current entity.

List users in the current entity

Authorizations:
basicAuth
header Parameters
User-Agent
required
string

Mandatory client identifier, e.g. my-app/1.0 (you@example.com).

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a user

Authorizations:
basicAuth
path Parameters
id
required
integer
header Parameters
User-Agent
required
string

Mandatory client identifier, e.g. my-app/1.0 (you@example.com).

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "email": "user@example.com"
}

Entities

Financial spaces (entities) the user belongs to.

List entities (financial spaces)

Authorizations:
basicAuth
header Parameters
User-Agent
required
string

Mandatory client identifier, e.g. my-app/1.0 (you@example.com).

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get an entity

Authorizations:
basicAuth
path Parameters
id
required
integer
header Parameters
User-Agent
required
string

Mandatory client identifier, e.g. my-app/1.0 (you@example.com).

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "plan_key": "string",
  • "license_status": "string",
  • "owner_id": 0
}

Status

Service health check.

Service status

Health check. Can be called without auth by passing the shared key query parameter; otherwise normal authentication applies.

Authorizations:
basicAuth
query Parameters
key
string

Shared bypass key for unauthenticated health checks.

header Parameters
User-Agent
required
string

Mandatory client identifier, e.g. my-app/1.0 (you@example.com).

Responses

Response samples

Content type
application/json
{
  • "database": "ok",
  • "resque": [
    ]
}