Briefcase

One archived item by archive id.

briefcase_get_archived_document

Short-lived download URL for a client-bound attachment, including a raised sales invoice PDF (pdf.attachment_id from briefcase_get_sales_invoice). Signed links stop working at expires_at.

briefcase_get_attachment_download

Balance sheet for a Briefcase Ledger client as at a date (default today), by asset, liability and equity account, with retained earnings and an optional comparison date. Accounts with a zero balance are left out. Connect clients return UNSUPPORTED_CAPABILITY.

briefcase_get_balance_sheet

Bank statement detail and lines.

briefcase_get_bank_statement

One client: name, ledger type (Xero, QuickBooks or Briefcase Ledger), document-forwarding email, whether Autopilot is on, and for Briefcase Ledger clients the general ledger lock date.

briefcase_get_client

One financial-close item for the given module. Schedules return up to 120 periods, starting a year before the next unposted period; pass period_start_date and period_end_date for others. A schedule created from a document has a negative first period moving the unreleased amount to the balance sheet; one created without a document holds it in opening_balance. For accruals, identify whether the target is a parent recurring expense or an adjustment, including archived adjustments.

briefcase_get_close_item

Period grid for prepayment, deferred income and fixed assets. Accrual tracker math is not that grid. Default range is the current calendar year.

briefcase_get_close_tracker

Identify the signed-in Briefcase user, workspace and this assistant grant.

briefcase_get_connection

Contact detail for a client-bound id.

briefcase_get_contact

Expense claim detail, membership and publish state.

briefcase_get_expense_claim

Published help article or product update body.

briefcase_get_help_article

One general ledger journal with its lines, source document links and reversal links. Connect clients return UNSUPPORTED_CAPABILITY.

briefcase_get_journal

Durable status for a write or denied write. Successful reads are not stored.

briefcase_get_operation

Profit and loss for a Briefcase Ledger client over a date range, by revenue and expense account, with an optional comparison range. Accounts with no movement are left out. Account ids work as account_id in briefcase_list_journals. Connect clients return UNSUPPORTED_CAPABILITY.

briefcase_get_profit_and_loss

Lookup accounts, tax rates, tracking categories, currencies, businesses, properties, claimants or sales items (Briefcase Ledger; used by briefcase_raise_sales_invoice). Returns up to 150 items with the full total; narrow accounts with account_class or search_term.

briefcase_get_reference_data

One raised sales invoice with lines, totals, outstanding balance, payments and emails. Download the PDF with briefcase_get_attachment_download using pdf.attachment_id. Connect clients return UNSUPPORTED_CAPABILITY.

briefcase_get_sales_invoice

Customer-visible transaction detail, line items, attachments, Autopilot explanation and publish blockers.

briefcase_get_transaction

The active AI memories for a client: processing rules Briefcase applies to its documents, such as how to code a supplier or which due date convention to use.

briefcase_list_ai_memories

Archived transactions, candidates, bank statements, supplier statements and sales invoices.

briefcase_list_archived_documents

Bank statements for a client, with match status.

briefcase_list_bank_statements

Ledger bank feed lines for a Briefcase bank account. Connect clients return UNSUPPORTED_CAPABILITY.

briefcase_list_bank_transactions

List clients this user can access under the grant, with awaiting-review, processing, failed and published counts.

briefcase_list_clients

List prepayments, deferred income, fixed assets or accruals. Schedules carry a period_summary, not their periods; get one with briefcase_get_close_item for its periods. Accruals include typed parent and adjustment references; archived accrual reads return archived adjustments, not archived parents.

briefcase_list_close_items

Search suppliers, customers and claimants for a client.

briefcase_list_contacts

List expense claims for a client.

briefcase_list_expense_claims

General ledger journals for a Briefcase Ledger client, newest first. Pass account_id for account activity: debit, credit and totals then cover that account only. Connect clients return UNSUPPORTED_CAPABILITY.

briefcase_list_journals

Sales invoices raised in Briefcase for a Briefcase Ledger client, newest first. Default statuses are all. Connect clients return UNSUPPORTED_CAPABILITY.

briefcase_list_sales_invoices

Search and filter awaiting-review, processing, published or archived transactions.

briefcase_list_transactions

List permitted workspace or client users with roles, effective permissions and visible client assignments. Existing user-directory restrictions apply.

briefcase_list_users

Publish a close item and post its schedule or accrual.

briefcase_publish_close_item

Publish an expense claim using its stored claimant, date and currency unless overridden. Preview returns blockers and the values that would be used.

briefcase_publish_expense_claim

Publish a reviewed transaction to the ledger. Preview returns blockers and the ledger action; execute posts to the Briefcase ledger or creates the Xero/QuickBooks document.

briefcase_publish_transaction

Raise and post a sales invoice for a Briefcase Ledger customer from sales items (briefcase_get_reference_data kind items). Preview shows lines and totals and blocks locked periods and missing issuer or customer details. Never emails the customer; reversal is web-only. Connect clients return UNSUPPORTED_CAPABILITY.

briefcase_raise_sales_invoice

Remove a transaction from an unpublished claim.

briefcase_remove_claim_transaction

Search published help articles and product updates.

briefcase_search_help

Submit a file uploaded through briefcase_create_document_upload for processing, exactly like an upload in the Briefcase app. Returns an operation to follow with briefcase_get_operation; a document that produces no transaction is reported as a failure.

briefcase_submit_document

Restore an archived close item so it can be edited or published again. Nothing is posted when it is restored.

briefcase_unarchive_close_item

Restore an archived transaction, candidate or statement. Sales invoices cannot be unarchived.

briefcase_unarchive_document

Save edits to a close item that is still in review; nothing posts. Only the fields supplied change. Changing amount, dates, frequency or opening balance regenerates the periods unless periods are supplied. Accrual edits target the draft adjustment (close_item_id is the adjustment_id) and keep linked draft reversals in step.

briefcase_update_close_item

Save transaction edits without publishing. Last write wins. Only the fields supplied are changed. When line_items is supplied it is the full set to keep: existing line items left out are removed; omit line_items to leave them unchanged.

briefcase_update_transaction