Documentação do MCP

get_guide

How Fazmie works, what each tool does and the rules. Read it before starting.

Parâmetros

Sem parâmetros.

get_cycle

Shows the pay cycle (from payday until the day before the next one): overdue bills, payday provisions (savings pots), upcoming bills, paid ones, warnings, free spending and monthly fixed cost. Free-spending weeks come separately in freeSpendingWeeks: they are NOT bills and are not paid. No 'date' = current cycle.

Parâmetros

• date
  string

  Any day inside the cycle you want to see

list_items

Lists every entry, largest first, with the total monthly fixed cost.

Parâmetros

Sem parâmetros.

get_settings

Cycle start, fixed investment per cycle, reference weekly amount, members and per-cycle overrides.

Parâmetros

Sem parâmetros.

get_investments

The household's net worth (already had + contributions to every investment − withdrawals + returns) and, per investment, how much was contributed (contributions marked as invested) and withdrawn. Amounts in reais.

Parâmetros

Sem parâmetros.

get_week_events

Free-spending telemetry: how each week closed (zeroed, leftover, short) and when the person took money from the next week (borrow; spentBefore = the balance the week had when the person chose 'Reset the current one'). A shortfall can leave the next week negative; in the last week it goes on the next cycle as a one-time entry. Returns the facts and a summary with counts and sums. Amounts in reais. Use it to find patterns (e.g. in how many weeks money ran short).

Parâmetros

• since
  string

  Only facts from cycles starting on this date or later

get_changes

History of changes to entries and marks (app, AI and spreadsheet): when, who and what, newest first. Use it to answer 'what was done yesterday?' and to find the id of something to undo.

Parâmetros

• days
  integer

  How many days back. Default: 7

simulate

Simulates a cycle without saving anything: what if the income, the investment or the bills change? Useful to see the effect of cutting or adding a bill on the weekly amount and the fixed cost.

Parâmetros

• date
  string

  A day inside the simulated cycle. Default: today

• salary
  number
• investAmount
  number
• removeItemIds
  uuid[]

  Entries to remove in the simulation

• addItems
  object[]

  New entries in the simulation

• addItems[].nameobrigatório
  string

  Name of the bill, income or investment

• addItems[].kindobrigatório
  "bill" | "provision" | "income" | "investment"

  bill = a bill paid on a date; income = income (monthly salary, or once: 13th salary, bonus, vacation pay); investment = a repeating investment contribution (not spending); provision = old type

• addItems[].frequencyobrigatório
  "monthly" | "weekly" | "yearly" | "once"

  monthly, weekly, yearly or once (one time)

• addItems[].amountobrigatório
  number

  Amount in reais. For weekly, the amount of each week

• addItems[].variable
  boolean

  An amount that changes (electricity, water, card)

• addItems[].cardId
  uuid

  Paid by card: id of the credit card bill entry (e.g. a gym charged to the Nubank card). It doesn't add to the cycle's bills, because the money leaves with the card bill; it stays in the fixed cost. null removes it

• addItems[].businessDay
  integer

  Monthly on the Nth business day (e.g. salary on the 5th business day = 5), instead of dueDay. The date changes every month (no Saturdays, Sundays or national holidays). null goes back to dueDay

• addItems[].dueDay
  integer

  Due day (monthly bills, and yearly). When changed, the past (until yesterday) stays on the old day

• addItems[].dueMonth
  integer

  Due month (yearly)

• addItems[].weekday
  integer

  Weekday, 0 = Sunday ... 6 = Saturday (weekly)

• addItems[].date
  string

  Single date (once)

• addItems[].node
  string

  Name of the savings pot. Empty = uses the name

• addItems[].yearlyMode
  "spread" | "warn"

  Yearly bill: spread sets aside 1/12 per cycle; warn only warns ahead

• addItems[].active
  boolean

  false = paused, not in the cycle

• addItems[].endsOn
  string

  Installments: date of the last one. null = never ends

• addItems[].startsOn
  string

  First date it applies. Before that it didn't exist. On create, empty (missing or null) = the first occurrence that has not happened yet (never an infinite past); send a past date to charge the past. On update, null = always. With installmentsTotal (and no endsOn) it is the date of installment 1 and the last installment is calculated from it

• addItems[].category
  string

  Category by name (uppercase). Prefer the app's fixed ones (see the guide; stored names are Portuguese): MORADIA, SAÚDE, FILHOS, ASSINATURAS, CARTÕES... A new name creates a category of the person's own. Card bills go in CARTÕES

• addItems[].installmentsTotal
  integer

  Installments: the purchase's total count (with endsOn shows 'installment 5/48')

• addItems[].countsAsFixed
  boolean

  Fixed cost, marked by the person. No end: default true. With an end date (installments): default false; true for a long contract (e.g. land). One-time is never fixed

• addItems[].owner
  string

  Who pays: a member's email (see get_settings → members). null = the household (everyone)

• addItems[].shift
  "before" | "after"

  Income and investment: if the date falls on a weekend or holiday, before moves it earlier, after moves it later, null = stays. Only monthly/yearly. Bills ignore it: they always move to the next business day

create_item

Creates a bill, income or investment. monthly needs dueDay (or businessDay); weekly needs weekday; yearly needs dueDay and dueMonth; once needs date. A financing or any plan with many installments (even 400) is ONE entry: monthly + installmentsTotal + startsOn (the date of installment 1) + dueDay. Never create one entry per month.

Parâmetros

• nameobrigatório
  string

  Name of the bill, income or investment

• kindobrigatório
  "bill" | "provision" | "income" | "investment"

  bill = a bill paid on a date; income = income (monthly salary, or once: 13th salary, bonus, vacation pay); investment = a repeating investment contribution (not spending); provision = old type

• frequencyobrigatório
  "monthly" | "weekly" | "yearly" | "once"

  monthly, weekly, yearly or once (one time)

• amountobrigatório
  number

  Amount in reais. For weekly, the amount of each week

• variable
  boolean

  An amount that changes (electricity, water, card)

• cardId
  uuid

  Paid by card: id of the credit card bill entry (e.g. a gym charged to the Nubank card). It doesn't add to the cycle's bills, because the money leaves with the card bill; it stays in the fixed cost. null removes it

• businessDay
  integer

  Monthly on the Nth business day (e.g. salary on the 5th business day = 5), instead of dueDay. The date changes every month (no Saturdays, Sundays or national holidays). null goes back to dueDay

• dueDay
  integer

  Due day (monthly bills, and yearly). When changed, the past (until yesterday) stays on the old day

• dueMonth
  integer

  Due month (yearly)

• weekday
  integer

  Weekday, 0 = Sunday ... 6 = Saturday (weekly)

• date
  string

  Single date (once)

• node
  string

  Name of the savings pot. Empty = uses the name

• yearlyMode
  "spread" | "warn"

  Yearly bill: spread sets aside 1/12 per cycle; warn only warns ahead

• active
  boolean

  false = paused, not in the cycle

• endsOn
  string

  Installments: date of the last one. null = never ends

• startsOn
  string

  First date it applies. Before that it didn't exist. On create, empty (missing or null) = the first occurrence that has not happened yet (never an infinite past); send a past date to charge the past. On update, null = always. With installmentsTotal (and no endsOn) it is the date of installment 1 and the last installment is calculated from it

• category
  string

  Category by name (uppercase). Prefer the app's fixed ones (see the guide; stored names are Portuguese): MORADIA, SAÚDE, FILHOS, ASSINATURAS, CARTÕES... A new name creates a category of the person's own. Card bills go in CARTÕES

• installmentsTotal
  integer

  Installments: the purchase's total count (with endsOn shows 'installment 5/48')

• countsAsFixed
  boolean

  Fixed cost, marked by the person. No end: default true. With an end date (installments): default false; true for a long contract (e.g. land). One-time is never fixed

• owner
  string

  Who pays: a member's email (see get_settings → members). null = the household (everyone)

• shift
  "before" | "after"

  Income and investment: if the date falls on a weekend or holiday, before moves it earlier, after moves it later, null = stays. Only monthly/yearly. Bills ignore it: they always move to the next business day

create_items

Creates several entries at once (e.g. importing a spreadsheet). Same rules as create_item.

Parâmetros

• itemsobrigatório
  object[] (max 200)
• items[].nameobrigatório
  string

  Name of the bill, income or investment

• items[].kindobrigatório
  "bill" | "provision" | "income" | "investment"

  bill = a bill paid on a date; income = income (monthly salary, or once: 13th salary, bonus, vacation pay); investment = a repeating investment contribution (not spending); provision = old type

• items[].frequencyobrigatório
  "monthly" | "weekly" | "yearly" | "once"

  monthly, weekly, yearly or once (one time)

• items[].amountobrigatório
  number

  Amount in reais. For weekly, the amount of each week

• items[].variable
  boolean

  An amount that changes (electricity, water, card)

• items[].cardId
  uuid

  Paid by card: id of the credit card bill entry (e.g. a gym charged to the Nubank card). It doesn't add to the cycle's bills, because the money leaves with the card bill; it stays in the fixed cost. null removes it

• items[].businessDay
  integer

  Monthly on the Nth business day (e.g. salary on the 5th business day = 5), instead of dueDay. The date changes every month (no Saturdays, Sundays or national holidays). null goes back to dueDay

• items[].dueDay
  integer

  Due day (monthly bills, and yearly). When changed, the past (until yesterday) stays on the old day

• items[].dueMonth
  integer

  Due month (yearly)

• items[].weekday
  integer

  Weekday, 0 = Sunday ... 6 = Saturday (weekly)

• items[].date
  string

  Single date (once)

• items[].node
  string

  Name of the savings pot. Empty = uses the name

• items[].yearlyMode
  "spread" | "warn"

  Yearly bill: spread sets aside 1/12 per cycle; warn only warns ahead

• items[].active
  boolean

  false = paused, not in the cycle

• items[].endsOn
  string

  Installments: date of the last one. null = never ends

• items[].startsOn
  string

  First date it applies. Before that it didn't exist. On create, empty (missing or null) = the first occurrence that has not happened yet (never an infinite past); send a past date to charge the past. On update, null = always. With installmentsTotal (and no endsOn) it is the date of installment 1 and the last installment is calculated from it

• items[].category
  string

  Category by name (uppercase). Prefer the app's fixed ones (see the guide; stored names are Portuguese): MORADIA, SAÚDE, FILHOS, ASSINATURAS, CARTÕES... A new name creates a category of the person's own. Card bills go in CARTÕES

• items[].installmentsTotal
  integer

  Installments: the purchase's total count (with endsOn shows 'installment 5/48')

• items[].countsAsFixed
  boolean

  Fixed cost, marked by the person. No end: default true. With an end date (installments): default false; true for a long contract (e.g. land). One-time is never fixed

• items[].owner
  string

  Who pays: a member's email (see get_settings → members). null = the household (everyone)

• items[].shift
  "before" | "after"

  Income and investment: if the date falls on a weekend or holiday, before moves it earlier, after moves it later, null = stays. Only monthly/yearly. Bills ignore it: they always move to the next business day

propose_item

Proposes a bill, income or investment for the user to review and confirm interactively with buttons in the chat, instead of directly saving it to the database. Use this when the user is asking for suggestions, planning, or asking how to log a new bill. The app renders an interactive confirmation card with [Criar lançamento] and [Descartar] buttons.

Parâmetros

• nameobrigatório
  string

  Name of the bill, income or investment

• kindobrigatório
  "bill" | "provision" | "income" | "investment"

  bill = a bill paid on a date; income = income (monthly salary, or once: 13th salary, bonus, vacation pay); investment = a repeating investment contribution (not spending); provision = old type

• frequencyobrigatório
  "monthly" | "weekly" | "yearly" | "once"

  monthly, weekly, yearly or once (one time)

• amountobrigatório
  number

  Amount in reais. For weekly, the amount of each week

• variable
  boolean

  An amount that changes (electricity, water, card)

• cardId
  uuid

  Paid by card: id of the credit card bill entry (e.g. a gym charged to the Nubank card). It doesn't add to the cycle's bills, because the money leaves with the card bill; it stays in the fixed cost. null removes it

• businessDay
  integer

  Monthly on the Nth business day (e.g. salary on the 5th business day = 5), instead of dueDay. The date changes every month (no Saturdays, Sundays or national holidays). null goes back to dueDay

• dueDay
  integer

  Due day (monthly bills, and yearly). When changed, the past (until yesterday) stays on the old day

• dueMonth
  integer

  Due month (yearly)

• weekday
  integer

  Weekday, 0 = Sunday ... 6 = Saturday (weekly)

• date
  string

  Single date (once)

• node
  string

  Name of the savings pot. Empty = uses the name

• yearlyMode
  "spread" | "warn"

  Yearly bill: spread sets aside 1/12 per cycle; warn only warns ahead

• active
  boolean

  false = paused, not in the cycle

• endsOn
  string

  Installments: date of the last one. null = never ends

• startsOn
  string

  First date it applies. Before that it didn't exist. On create, empty (missing or null) = the first occurrence that has not happened yet (never an infinite past); send a past date to charge the past. On update, null = always. With installmentsTotal (and no endsOn) it is the date of installment 1 and the last installment is calculated from it

• category
  string

  Category by name (uppercase). Prefer the app's fixed ones (see the guide; stored names are Portuguese): MORADIA, SAÚDE, FILHOS, ASSINATURAS, CARTÕES... A new name creates a category of the person's own. Card bills go in CARTÕES

• installmentsTotal
  integer

  Installments: the purchase's total count (with endsOn shows 'installment 5/48')

• countsAsFixed
  boolean

  Fixed cost, marked by the person. No end: default true. With an end date (installments): default false; true for a long contract (e.g. land). One-time is never fixed

• owner
  string

  Who pays: a member's email (see get_settings → members). null = the household (everyone)

• shift
  "before" | "after"

  Income and investment: if the date falls on a weekend or holiday, before moves it earlier, after moves it later, null = stays. Only monthly/yearly. Bills ignore it: they always move to the next business day

• reason
  string

  Short explanation of why this entry is proposed

propose_change

Proposes ONE change that eases this week or this cycle, shown in the chat as a card with [Aplicar] and [Descartar]; nothing is saved until the person taps Aplicar. Kinds: borrow_week (take an amount from the following week; in the last week, from the next cycle), skip_bill (skip a bill that isn't fixed cost, this cycle only; actionKey from get_cycle), skip_investment (skip this cycle's contribution; offer it only next to other options, never alone), spread_yearly (a yearly bill starts setting aside 1/12 per cycle; itemId from list_items). One call per option: to offer two ways out, call it twice.

Parâmetros

• kindobrigatório
  "borrow_week" | "skip_bill" | "skip_investment" | "spread_yearly"
• amount
  number

  borrow_week: amount in reais

• weekNumber
  integer

  borrow_week: the week that receives the money (default: today's week)

• actionKey
  string

  skip_bill / skip_investment: the actionKey from get_cycle

• itemId
  uuid

  spread_yearly: the yearly bill's id

• reason
  string

  One short sentence: why this option

update_item

Changes an entry's fields. Send only what changes. Use active=false to pause.

Parâmetros

• idobrigatório
  uuid
• name
  string

  Name of the bill, income or investment

• kind
  "bill" | "provision" | "income" | "investment"

  bill = a bill paid on a date; income = income (monthly salary, or once: 13th salary, bonus, vacation pay); investment = a repeating investment contribution (not spending); provision = old type

• frequency
  "monthly" | "weekly" | "yearly" | "once"

  monthly, weekly, yearly or once (one time)

• amount
  number

  Amount in reais. For weekly, the amount of each week

• variable
  boolean

  An amount that changes (electricity, water, card)

• cardId
  uuid

  Paid by card: id of the credit card bill entry (e.g. a gym charged to the Nubank card). It doesn't add to the cycle's bills, because the money leaves with the card bill; it stays in the fixed cost. null removes it

• businessDay
  integer

  Monthly on the Nth business day (e.g. salary on the 5th business day = 5), instead of dueDay. The date changes every month (no Saturdays, Sundays or national holidays). null goes back to dueDay

• dueDay
  integer

  Due day (monthly bills, and yearly). When changed, the past (until yesterday) stays on the old day

• dueMonth
  integer

  Due month (yearly)

• weekday
  integer

  Weekday, 0 = Sunday ... 6 = Saturday (weekly)

• date
  string

  Single date (once)

• node
  string

  Name of the savings pot. Empty = uses the name

• yearlyMode
  "spread" | "warn"

  Yearly bill: spread sets aside 1/12 per cycle; warn only warns ahead

• active
  boolean

  false = paused, not in the cycle

• endsOn
  string

  Installments: date of the last one. null = never ends

• startsOn
  string

  First date it applies. Before that it didn't exist. On create, empty (missing or null) = the first occurrence that has not happened yet (never an infinite past); send a past date to charge the past. On update, null = always. With installmentsTotal (and no endsOn) it is the date of installment 1 and the last installment is calculated from it

• category
  string

  Category by name (uppercase). Prefer the app's fixed ones (see the guide; stored names are Portuguese): MORADIA, SAÚDE, FILHOS, ASSINATURAS, CARTÕES... A new name creates a category of the person's own. Card bills go in CARTÕES

• installmentsTotal
  integer

  Installments: the purchase's total count (with endsOn shows 'installment 5/48')

• countsAsFixed
  boolean

  Fixed cost, marked by the person. No end: default true. With an end date (installments): default false; true for a long contract (e.g. land). One-time is never fixed

• owner
  string

  Who pays: a member's email (see get_settings → members). null = the household (everyone)

• shift
  "before" | "after"

  Income and investment: if the date falls on a weekend or holiday, before moves it earlier, after moves it later, null = stays. Only monthly/yearly. Bills ignore it: they always move to the next business day

delete_item

Deletes an entry. It isn't gone for good: it goes to the history and can be undone with undo_change. Before deleting something that looks duplicated, compare name, day and amount and ask the person: two similar entries on different days are NOT duplicates. To pause, prefer update_item with active=false.

Parâmetros

• idobrigatório
  uuid

delete_items

Deletes several entries at once (up to 500), for example the one-per-month entries created by mistake for a plan that should be a single entry. They aren't gone for good: they go to the history and each can be undone with undo_change. Show the person what will be deleted and wait for them to confirm. Compare names, days and amounts first: similar entries on different days are NOT duplicates.

Parâmetros

• idsobrigatório
  uuid[] (max 500)

rename_category

Renames a category in every entry. Using another category's name merges both. Empty to = deletes it (entries end up without a category).

Parâmetros

• fromobrigatório
  string
• toobrigatório
  string

audit_categories

Audits the household's entries and finds categorization discrepancies without calling external AI (zero cost): 1) detects items in OUTROS that match known semantic keywords, 2) detects conflicting categories for entries with similar names across the household (e.g. partner logged 'Obra' in one category and 'Reforma' in another, or one logged in MORADIA and another in OUTROS).

Parâmetros

Sem parâmetros.

list_projects

Lists every project (a named plan for a life event: trip, wedding, renovation, party) with its summary: ring (paid vs budget or planned), next payment due, days to the event, planned amount per cycle and budget alert. A project only groups entries so the person sees insight on those expenses; it never changes the cycle math.

Parâmetros

Sem parâmetros.

get_project

One project with its summary and its entries.

Parâmetros

• idobrigatório
  uuid

create_project

Creates a project (a named plan grouping entries). kind is trip, wedding, renovation, party or blank. budget is optional and only a reference (it never blocks anything); eventOn is the optional event date (YYYY-MM-DD).

Parâmetros

• nameobrigatório
  string

  Name of the plan (e.g. Trip to Japan)

• kindobrigatório
  "trip" | "wedding" | "renovation" | "party" | "blank"

  What kind of life event it is

• budget
  number

  Optional budget in reais (reference only)

• eventOn
  string

  Optional event date (YYYY-MM-DD)

update_project

Changes a project. Send only what changes. budget or eventOn as null clears it.

Parâmetros

• idobrigatório
  uuid
• name
  string
• kind
  "trip" | "wedding" | "renovation" | "party" | "blank"
• budget
  number

  Budget in reais (reference only). null clears it

• eventOn
  string

  Event date. null clears it

close_project

Marks a project closed (it lives in a collapsed section) or reopens it. Deleting is separate (delete_project).

Parâmetros

• idobrigatório
  uuid
• closedobrigatório
  boolean

  true closes, false reopens

set_items_project

Attaches many entries to projects at once (up to 500): { itemId, projectId }. projectId null detaches. Only one-time and installment entries can join a project (recurring monthly, weekly and yearly are refused); an entry must have a date. Closed, deleted and foreign projects are refused. Prefer it over repeating a single attach.

Parâmetros

• itemsobrigatório
  object[] (max 500)
• items[].itemIdobrigatório
  uuid
• items[].projectIdobrigatório
  uuid

  The project, or null to detach

delete_project

Deletes a project (soft delete: its entries keep their project and it can be undone with undo_change). Show the person what you will delete and wait for them to confirm.

Parâmetros

• idobrigatório
  uuid

mark_done

Marks a cycle action as done (bill paid, money set aside, investment made). Use payDate and actionKey from get_cycle. For amounts that change, send paidAmount.

Parâmetros

• payDateobrigatório
  string
• actionKeyobrigatório
  string
• paidAmount
  number

  Real amount paid, in reais

• doneBy
  string

  Who did it. Default: the AI's name

• status
  "paid" | "provisioned" | "skipped" | "pending"

  paid = paid (default); provisioned = money set aside, not paid yet; skipped = skip this month only; pending = to pay with a different amount this month (send paidAmount)

unmark_done

Undoes an action marked as done.

Parâmetros

• payDateobrigatório
  string
• actionKeyobrigatório
  string

record_payments

Records many payments of ONE entry at once, by month (e.g. a financing statement: '2022-03: R$ 1,850.12'). Use it after create_item for a plan that already has history, instead of creating one entry per month. Each month becomes 'paid' with the amount given; months with no installment are returned in `skipped`. Up to 600 months per call. Only bills and investments (not income).

Parâmetros

• itemIdobrigatório
  uuid
• paymentsobrigatório
  object[] (max 600)
• payments[].monthobrigatório
  string
• payments[].paidAmountobrigatório
  number

  Real amount paid, in reais

• payments[].paidOn
  string

  The day it was paid, if the statement says. Default: the due date

• doneBy
  string

  Who did it. Default: the AI's name

confirm_incomes

Says how much will really come in for each income of a cycle (variable income). No 'date' = the next cycle. Use the income's name (e.g. 'Salary 1'). Amounts in reais.

Parâmetros

• date
  string

  Any day inside the cycle. Default: the next cycle

• amountsobrigatório
  object[]
• amounts[].nameobrigatório
  string
• amounts[].amountobrigatório
  number

import_spreadsheet

Step 1 of importing a spreadsheet or statement. YOU read the file; send its rows here and the server decides how they fit Fazmie: one entry per thing (not one per month), installment plans, fixed or variable amounts, the app's categories, and which rows are payments already made. Nothing is saved yet. Send rows in chunks of up to 400 (call again with the same importId; do not resend a chunk), with done=false while more rows are coming and done=true on the last chunk to get the review. Show the review to the person, fix what they say with `overrides` in commit_import, then call commit_import.

Parâmetros

• importId
  uuid

  From the first call. Omit it to start a new import

• rows
  object[] (max 400)
• rows[].nameobrigatório
  string

  The name as written in the sheet (keep '3/12' if it is there)

• rows[].amountobrigatório
  number

  Amount in reais, positive

• rows[].dateobrigatório
  string

  The due date if the sheet has it; otherwise the day it was paid or received. YYYY-MM-DD

• rows[].paid
  boolean

  true if this row was already paid / received

• rows[].paidAmount
  number

  Amount really paid, if different from amount

• rows[].paidOn
  string

  The day it was paid, if the sheet has it apart from date

• rows[].type
  "expense" | "income" | "investment"

  Default expense

• rows[].category
  string

  The sheet's category column, as written

• rows[].installment
  string

  '3/12', if the sheet has it in its own column

• done
  boolean

  true on the last chunk: returns the full review

commit_import

Step 2: saves what import_spreadsheet proposed, after the person agreed. Creates the entries and records the payments already made. `overrides` fix single entries by ref (name, category, amount, dueDay, variable, countsAsFixed, skip). Entries marked SKIPPED (already in the app) are not created unless an override says skip=false. Returns the created ids: pass them to delete_items to undo the whole import.

Parâmetros

• importIdobrigatório
  uuid
• overrides
  object[] (max 500)
• overrides[].refobrigatório
  string
• overrides[].name
  string
• overrides[].category
  string
• overrides[].amount
  number
• overrides[].dueDay
  integer
• overrides[].variable
  boolean
• overrides[].countsAsFixed
  boolean
• overrides[].skip
  boolean

update_settings

Changes settings for every cycle. Send only what changes. Amounts in reais.

Parâmetros

• cycleMode
  "income" | "day"

  income = the cycle starts when a monthly income comes in; day = a fixed day (no fixed salary)

• cycleIncomeId
  uuid

  income mode: id of the income entry that starts the cycle (list_items, kind = income)

• paydayDay
  integer

  day mode: the fixed day the cycle starts

• investAmount
  number
• referenceWeekly
  number

set_cycle_override

Sets the income total and/or investment for one cycle only (13th salary, bonus, vacation pay). payDate is the real payday (see get_cycle). Send both as null to remove.

Parâmetros

• payDateobrigatório
  string
• salary
  number
• investAmount
  number
• note
  string

list_content_deliveries

Lists all communication and notification templates (morning summary, payday, friday close, partner actions) with their active status, delivery channels (push, email, whatsapp) and localized copies.

Parâmetros

Sem parâmetros.

update_content_delivery

Updates the channels (push, email, whatsapp), the pause (active) or the localized copy of a message, with no deploy. Copy can only be edited for cycle_payday ({amount}, {date}), monday_plan ({amount}) and friday_week_close ({amount}); the other messages are built by the system (channels and pause only). partner_action only has push.

Parâmetros

• idobrigatório
  string

  ID of the message template, e.g. morning_summary, cycle_payday, friday_week_close, partner_action

• channels
  "push" | "email" | "whatsapp"[]

  Active delivery channels for this notification

• active
  boolean

  Whether this notification template is active or paused

• copyPt
  object

  Portuguese copy template

• copyEn
  object

  English copy template

undo_change

Undoes a change from the history (id from get_changes): puts the entry or the mark back as it was. Show the person what you will undo and wait for them to confirm.

Parâmetros

• idobrigatório
  uuid