Skip to main content
GET
Chart an account's weekly spending
startDate and endDate are required, at most 366 days apart. Pix (sent and received) and transfers between wallets are left out, and so are transactions that moved no money; card purchases, boletos, TED transfers and fees count. A week with no transactions is still listed, with totalAmount 0. Weeks are counted from January 1 of each year, in UTC — days 1 to 7 are the year’s first week, 8 to 14 the second, and so on, with the year’s last one or two days in its 52nd — so a week never spans two years, and the first and last weeks are cut at startDate and endDate. Send x-environment: LIVE for production transactions. Only organization admins can chart the account.

Headers

x-environment
enum<string>

Environment of the transactions: LIVE (production) or TEST (sandbox). When you omit it, you get the TEST totals; any other value is rejected.

Available options:
LIVE,
TEST

Path Parameters

realmId
string<uuid>
required

ID of your realm.

Format: UUID

organizationId
string<uuid>
required

ID of the organization the account belongs to.

Format: UUID

accountId
string
required

ID of the organization's account (24 hexadecimal characters).

Pattern: ^[0-9a-fA-F]{24}$

Query Parameters

startDate
string
required

Start of the period, inclusive, compared with each transaction's effectiveAt: an ISO 8601 date-time (2026-10-01T03:00:00.000Z) or date (2026-10-01, read as midnight UTC).

endDate
string
required

End of the period, inclusive, in the same format as startDate: not before startDate, and at most 366 days after it.

Response

Successful response

week
string
required

The week, as DD/MM - DD/MM: seven days counted from January 1 of its year (the year's last week runs to December 31); the first starts on startDate and the last ends on endDate.

Example:

"15/10 - 21/10"

totalAmount
number
required

Money out minus money in that week, in cents (BRL) — negative when more came in. Pix and transfers between wallets are left out.

Example:

184320