# Command reference


Commands record evidenced changes in one business. Each page explains what the
command does, what to supply, its effects and result, and how to verify acceptance.
The descriptions, examples and field definitions come from the same public
command catalog that the live API advertises; exact request and receipt schemas
come from OpenAPI.

Submit commands through `POST /v1/commands`, or use the
[CLI](/docs/cli/) with `commands execute`. Read the
[concepts](/docs/concepts/) and [request and recovery rules](/docs/api/)
before your first write. Billing, payment and recognition are separate facts.

Fetch `GET /v1/catalog/commands/{name}` for the current business's permitted
schema before acting. A public listing grants no access. Browser-only commands
require a signed-in human; practice writes belong in a disposable sandbox.

For agents, fetch a command page's `index.md` mirror and retain the exact
input names, integer-string amounts and stable idempotency key. The
[HTTP reference](/docs/api-reference/) describes transport and shared errors;
the [report reference](/docs/report-reference/) describes reads of the books.


## Targeted reference pages for agents

Fetch only the operation or variant you need. These Markdown pages preserve
its exact OpenAPI schemas and link back to shared parameters and errors.
The full export is at https://economi.co/docs/api-reference/full/index.md.







- [accounts.archive](https://economi.co/docs/command-reference/accounts-archive/index.md): Archive a financial account; past postings remain in the books. accounts.restore brings it back.

- [accounts.register](https://economi.co/docs/command-reference/accounts-register/index.md): Register a bank account, card or wallet for bookkeeping; this does not connect a provider or move funds. Use ownerPartyId for a personal account, so the books record what the business owes its owner.

- [accounts.restore](https://economi.co/docs/command-reference/accounts-restore/index.md): Restore an archived financial account, so payments can use it again; its history is unchanged.

- [accounts.set_opening_balance](https://economi.co/docs/command-reference/accounts-set-opening-balance/index.md): Set the first opening balance on a previously registered, unused company account.

- [accounts.update](https://economi.co/docs/command-reference/accounts-update/index.md): Update a financial account label, kind, provider, provider contract, last four digits, network, brand color, logo or default flag (null clears brandColor or logoDocumentId); currency and GL account are immutable, so a kind change must keep card on 2190 and every other kind off it.

- [activities.archive](https://economi.co/docs/command-reference/activities-archive/index.md): Archive a reusable activity for new catalog use.

- [activities.create](https://economi.co/docs/command-reference/activities-create/index.md): Register an immutable activity definition.

- [activities.replace](https://economi.co/docs/command-reference/activities-replace/index.md): Replace an immutable activity definition.

- [business.change_fiscal_year](https://economi.co/docs/command-reference/business-change-fiscal-year/index.md): Record an evidenced fiscal-year change and its transition period. Preview it with business_fiscal_year_change_preview first; earlier history is preserved.

- [business.change_functional_currency](https://economi.co/docs/command-reference/business-change-functional-currency/index.md): Correct the signup currency while the books have no postings. Opens a ledger in the selected currency; refused after the first posting.

- [business.change_legal_form](https://economi.co/docs/command-reference/business-change-legal-form/index.md): Record an evidenced change of legal form or jurisdiction. Country-specific registrations are cleared when the country changes; no legal filing is made.

- [business.change_legal_name](https://economi.co/docs/command-reference/business-change-legal-name/index.md): Record an evidenced change to the registered legal name. Owner authority is required; no legal filing is made.

- [business.deregister_sales_tax](https://economi.co/docs/command-reference/business-deregister-sales-tax/index.md): Record the evidenced end of a sales-tax registration. Requires an interactive owner; does not notify a tax authority or file a return.

- [business.elect_accounting_framework](https://economi.co/docs/command-reference/business-elect-accounting-framework/index.md): Record an evidenced accounting-framework election for this business. Requires owner authority and a framework supported in its jurisdiction.

- [business.incorporate](https://economi.co/docs/command-reference/business-incorporate/index.md): Record an incorporation that already occurred, using its certificate and contract-assignment evidence. Carries project balances into successor ledgers; does not form or register a legal entity.

- [business.record_formation_date](https://economi.co/docs/command-reference/business-record-formation-date/index.md): Record or correct a directly registered company's formation date from its source document.

- [business.register_sales_tax](https://economi.co/docs/command-reference/business-register-sales-tax/index.md): Record an evidenced sales-tax registration and create its standard tax codes. Requires an interactive owner; does not register with an authority or file a return.

- [business.set_registration](https://economi.co/docs/command-reference/business-set-registration/index.md): Record an evidenced company registration number for its jurisdiction. Requires owner authority; does not obtain a number or register the company.

- [business.update](https://economi.co/docs/command-reference/business-update/index.md): Update the business description, website, logo or postal address, or submit a YC verification link. Legal identity and the business slug are separate from these profile fields.

- [card_statements.pay](https://economi.co/docs/command-reference/card-statements-pay/index.md): Record an evidenced partial or full repayment of a received card statement bill.

- [card_statements.record](https://economi.co/docs/command-reference/card-statements-record/index.md): Record a received issuer statement as a bill over the card debt already booked on 2190.

- [card_statements.reverse_payment](https://economi.co/docs/command-reference/card-statements-reverse-payment/index.md): Reverse a whole card statement payment with evidence.

- [card_statements.void](https://economi.co/docs/command-reference/card-statements-void/index.md): Void a received card statement with evidence and a reason.

- [categories.create](https://economi.co/docs/command-reference/categories-create/index.md): Create a revenue category with a unique code for organizing accounting classifications.

- [concessions.assign](https://economi.co/docs/command-reference/concessions-assign/index.md): Assign a concession offer to an email: the person who accepts an agreement under it receives the offer.

- [concessions.create_offer](https://economi.co/docs/command-reference/concessions-create-offer/index.md): Create a concession offer: a discount the business gives customers off what their agreement would otherwise charge, with its purpose (acquisition, retention, service or research) and attribution (a campaign name, a partner party).

- [concessions.reassign](https://economi.co/docs/command-reference/concessions-reassign/index.md): Move a concession offer's assignment from one email to another, while it is unused.

- [concessions.record_given](https://economi.co/docs/command-reference/concessions-record-given/index.md): Record that a contract was given a concession offer, when the contract was written with the offer's discount already in its rights' `concession` reduction terms.

- [concessions.reserve](https://economi.co/docs/command-reference/concessions-reserve/index.md): Hold a concession offer for one enrollment before its contracts are written, so a single use cannot discount two.

- [concessions.retire](https://economi.co/docs/command-reference/concessions-retire/index.md): Retire a concession offer: no contract can take it from now on.

- [connections.accept](https://economi.co/docs/command-reference/connections-accept/index.md): Accept a pending connection request from another business, naming the party in these books it is (`partyId`; create one with parties.create first).

- [connections.decline](https://economi.co/docs/command-reference/connections-decline/index.md): Decline a pending connection request from another business.

- [connections.end](https://economi.co/docs/command-reference/connections-end/index.md): End a connection with another business; neither can message the other through it again.

- [connections.request](https://economi.co/docs/command-reference/connections-request/index.md): Ask another business on Economico to establish a connection so the two businesses can exchange messages. The recipient must accept.

- [contracts.accept](https://economi.co/docs/command-reference/contracts-accept/index.md): Accept a priced-rights contract with evidence and an expected version/state.

- [contracts.add_granted_credit](https://economi.co/docs/command-reference/contracts-add-granted-credit/index.md): Add a right to a vendor contract for credit the vendor grants, such as a startup program's.

- [contracts.add_usage_meter](https://economi.co/docs/command-reference/contracts-add-usage-meter/index.md): Add a zero-priced monthly meter to a vendor contract, to count that a tool or seat was used.

- [contracts.adopt](https://economi.co/docs/command-reference/contracts-adopt/index.md): Adopt a vendor plan version into the books: reuse or create its template and seller party, resolve tax, create a contract and optionally accept it, atomically.

- [contracts.amend](https://economi.co/docs/command-reference/contracts-amend/index.md): Amend resolved terms with an effective date and acceptance evidence.

- [contracts.cancel](https://economi.co/docs/command-reference/contracts-cancel/index.md): Cancel a priced-rights contract with evidence and an expected version/state.

- [contracts.change_quantity](https://economi.co/docs/command-reference/contracts-change-quantity/index.md): Record an evidenced absolute seat or quantity count under the right's declared proration and decrease rules. expectedQuantity must match the count in force.

- [contracts.create](https://economi.co/docs/command-reference/contracts-create/index.md): Bind a template document or inline template to actual parties, resolved terms and native ledgers.

- [contracts.discard](https://economi.co/docs/command-reference/contracts-discard/index.md): Discard an unused draft contract. Its history remains; an accepted contract must end through its lifecycle instead.

- [contracts.give_notice](https://economi.co/docs/command-reference/contracts-give-notice/index.md): Record evidenced notice of non-renewal, including late notice.

- [contracts.observe_usage](https://economi.co/docs/command-reference/contracts-observe-usage/index.md): Record vendor usage observations (1–200) against a metered right of a vendor contract, each priced as an estimate and attributed to a customer, person, team or project. Re-sending an observation is safe.

- [contracts.offer](https://economi.co/docs/command-reference/contracts-offer/index.md): Offer a priced-rights contract with evidence and an expected version/state.

- [contracts.reconcile_usage](https://economi.co/docs/command-reference/contracts-reconcile-usage/index.md): Reconcile a vendor invoice or statement to the usage estimates of one vendor contract: clear the accrual, post the difference and spread it over the customers, people and teams the usage served.

- [contracts.record](https://economi.co/docs/command-reference/contracts-record/index.md): Record an evidenced activity or priced-right phase against an existing contract. Read the contract first for its facts and allowed phases. Billing, delivery, recognition and payment are distinct; no invoice is sent or money moved.

- [contracts.renew](https://economi.co/docs/command-reference/contracts-renew/index.md): Record the next term on the same contract, preserving billing calendars and historical prices.

- [contracts.resolve_usage_review](https://economi.co/docs/command-reference/contracts-resolve-usage-review/index.md): Record the business's decision and reason for selected contract usage attention items, amendment price checks or unmatched vendor lines. Changes no bill or posting.

- [contracts.reverse_economics](https://economi.co/docs/command-reference/contracts-reverse-economics/index.md): Reverse a priced service obligation or a single recognition with correction evidence, preserving history. Resolve dependent payments for whole-obligation reversals; no cash moves.

- [contracts.terminate](https://economi.co/docs/command-reference/contracts-terminate/index.md): Terminate a priced-rights contract with evidence and an expected version/state.

- [contracts.void](https://economi.co/docs/command-reference/contracts-void/index.md): Void a contract entered in error: reverse everything it recorded at each fact's own date and keep its payments as the party's unapplied funds. Preview first.

- [contracts.withdraw_notice](https://economi.co/docs/command-reference/contracts-withdraw-notice/index.md): Record withdrawal of a non-renewal notice with evidence, flagging late withdrawals.

- [documents.receive](https://economi.co/docs/command-reference/documents-receive/index.md): Save exact document bytes as an immutable artifact. Identical bytes reuse the existing document; saving evidence alone creates no invoice, bill or payment.

- [documents.relate](https://economi.co/docs/command-reference/documents-relate/index.md): Add one immutable typed link between two registered artifacts.

- [ingestions.agreement_proposal](https://economi.co/docs/command-reference/ingestions-agreement-proposal/index.md): Prepare a manual contract draft from a complete retained agreement extraction. Returns a proposal only; does not accept an agreement or record financial activity.

- [ingestions.amendment_proposal](https://economi.co/docs/command-reference/ingestions-amendment-proposal/index.md): Prepare a manual amendment from a complete retained agreement extraction. Returns a proposal only; does not change the contract.

- [ingestions.attach_original](https://economi.co/docs/command-reference/ingestions-attach-original/index.md): Request one optional original for an ingestion.

- [ingestions.credit_proposal](https://economi.co/docs/command-reference/ingestions-credit-proposal/index.md): Prepare a full vendor-credit reversal from a complete retained credit extraction. Returns a proposal only; does not reverse entries or move money.

- [ingestions.invoice_candidates](https://economi.co/docs/command-reference/ingestions-invoice-candidates/index.md): Read source-backed invoice field candidates from a completed document extraction. Returns suggestions only; does not record an invoice or payment.

- [ingestions.receipt_proposal](https://economi.co/docs/command-reference/ingestions-receipt-proposal/index.md): Prepare a bill-and-payment proposal from a complete, evidenced vendor receipt. Requires a matching existing funding account, or a person's own card in the company's currency, and same-time full payment; incomplete receipts, fees and other FX need review. Does not post the proposal.

- [ingestions.reissue_upload](https://economi.co/docs/command-reference/ingestions-reissue-upload/index.md): Issue a replacement short-lived upload URL for your still-pending source or attachment. Uploading exact bytes starts processing; it does not authorize financial recording.

- [ingestions.resolve](https://economi.co/docs/command-reference/ingestions-resolve/index.md): Revise a completed expense proposal using existing targets and its expected revision. Original evidence is preserved; no bill, payment or automatic delivery is created.

- [ingestions.start](https://economi.co/docs/command-reference/ingestions-start/index.md): Retain a document and inspect its contents. Default propose mode creates no financial entries. Explicit auto_record mode can record eligible bills or paid receipts under an explicit recordingPolicy and current authority; unsupported or uncertain sources require review.

- [ingestions.statement_matches](https://economi.co/docs/command-reference/ingestions-statement-matches/index.md): Suggest matches between a retained structured statement and current claims. Matches are review candidates, not proof of payment; no allocation or financial entry is created.

- [journal.post](https://economi.co/docs/command-reference/journal-post/index.md): Record an explicitly supplied, evidenced journal whose postings balance within each ledger. Prefer the relevant business command for ordinary invoices, bills and payments.

- [journal.void](https://economi.co/docs/command-reference/journal-void/index.md): Reverse an existing journal once with a linked counter-entry.

- [members.grant](https://economi.co/docs/command-reference/members-grant/index.md): Grant explicit scoped membership to a known principal.

- [members.revoke](https://economi.co/docs/command-reference/members-revoke/index.md): Revoke a principal's access to this business.

- [messages.send](https://economi.co/docs/command-reference/messages-send/index.md): Send a message to another connected business on Economico, including support messages. This queues delivery to the recipient; use only on the user's instruction.

- [opportunities.link](https://economi.co/docs/command-reference/opportunities-link/index.md): Link one specific contract document and acceptance occurrence, or omit activity/occurrence keys to link an accepted amendment.

- [opportunities.lose](https://economi.co/docs/command-reference/opportunities-lose/index.md): Close an open opportunity as lost with a reason.

- [opportunities.open](https://economi.co/docs/command-reference/opportunities-open/index.md): Open one pipeline package with a stable opportunity key.

- [opportunities.stage](https://economi.co/docs/command-reference/opportunities-stage/index.md): Update an open opportunity's stage and optional estimates using its current revision.

- [parties.add_contact](https://economi.co/docs/command-reference/parties-add-contact/index.md): Add a named contact to a counterparty.

- [parties.archive](https://economi.co/docs/command-reference/parties-archive/index.md): Archive a counterparty while preserving its history.

- [parties.create](https://economi.co/docs/command-reference/parties-create/index.md): Create a customer, vendor, founder or other counterparty.

- [parties.rebind_vendor_identity](https://economi.co/docs/command-reference/parties-rebind-vendor-identity/index.md): Correct a catalog seller's party with a recorded reason. expectedPartyId guards the current binding; null binds an unbound seller in catalog <vendor>/<seller> key format.

- [parties.remove_contact](https://economi.co/docs/command-reference/parties-remove-contact/index.md): Remove one contact from a counterparty by its contactId; the party and its history remain.

- [parties.set_address](https://economi.co/docs/command-reference/parties-set-address/index.md): Replace a counterparty's postal address.

- [parties.update](https://economi.co/docs/command-reference/parties-update/index.md): Update a counterparty name, legal name, URL, logo, categories or related-party marker; historical documents remain immutable.

- [payment_endpoints.register](https://economi.co/docs/command-reference/payment-endpoints-register/index.md): Register a payment instruction and its supported rails.

- [payment_endpoints.update](https://economi.co/docs/command-reference/payment-endpoints-update/index.md): Change a payment instruction's label or active status.

- [payments.allocate](https://economi.co/docs/command-reference/payments-allocate/index.md): Match unapplied funds from an existing payment to identified open claims. No new cash movement, revenue or expense is recorded.

- [payments.process](https://economi.co/docs/command-reference/payments-process/index.md): Record an existing payment and its evidenced provider processing fee, with gross/net reconciliation. Does not process or initiate a payment; fee taxes and cross-currency fees are unsupported.

- [payments.record](https://economi.co/docs/command-reference/payments-record/index.md): Record evidenced money that already moved and allocate it to explicit claims, or leave an identified amount unapplied. Does not initiate a payment or recognize revenue or expense.

- [payments.reverse](https://economi.co/docs/command-reference/payments-reverse/index.md): Reverse a whole recorded payment using correction evidence. Restores its claims and funding balances while preserving history; does not send money back.

- [payments.transfer](https://economi.co/docs/command-reference/payments-transfer/index.md): Record an evidenced transfer that already occurred between company accounts. Records both sides and any supported FX; does not move funds.

- [payments.unallocate](https://economi.co/docs/command-reference/payments-unallocate/index.md): Undo all or part of a payment allocation. Reopens the claim and restores unapplied funds without moving cash.

- [payroll.attribute_cost](https://economi.co/docs/command-reference/payroll-attribute-cost/index.md): Attribute an existing unattributed provider cost line, or a linked cost, using later worker/work-period evidence.

- [payroll.link_funding](https://economi.co/docs/command-reference/payroll-link-funding/index.md): Label an actual outgoing unapplied provider payment as refundable deposit or payroll prefunding.

- [payroll.link_recorded_cost](https://economi.co/docs/command-reference/payroll-link-recorded-cost/index.md): Link an already booked expense posting to People without another expense or debt.

- [payroll.record_statement](https://economi.co/docs/command-reference/payroll-record-statement/index.md): Record one evidenced provider invoice or payroll register atomically.

- [payroll.reverse_statement](https://economi.co/docs/command-reference/payroll-reverse-statement/index.md): Record an evidenced full or partial provider credit without undoing payments.

- [people.link_identity](https://economi.co/docs/command-reference/people-link-identity/index.md): Map a named vendor-account-scoped holder to a person for a dated period, or identify it as external, shared or an agent.

- [people.record_arrangement](https://economi.co/docs/command-reference/people-record-arrangement/index.md): Record a person's dated employee, contractor, PEO or EOR arrangement, separately from team membership.

- [people.set_membership](https://economi.co/docs/command-reference/people-set-membership/index.md): Record an evidenced team-membership period for an existing party. through is exclusive.

- [presentation_rate.record](https://economi.co/docs/command-reference/presentation-rate-record/index.md): Freeze one exact, human-approved presentation-currency rate, optionally verified against a dated shared-store observation.

- [receipts.record](https://economi.co/docs/command-reference/receipts-record/index.md): Record one evidenced bill and its full same-time payment together. Use for a paid purchase, not settlement of an existing bill; does not send a payment.

- [report_definitions.archive](https://economi.co/docs/command-reference/report-definitions-archive/index.md): Archive a whole custom report definition permanently.

- [report_definitions.pin](https://economi.co/docs/command-reference/report-definitions-pin/index.md): Show a published custom report in the workspace for every member: in the sidebar under Reports, by its title, and with overview true also on the overview page.

- [report_definitions.publish](https://economi.co/docs/command-reference/report-definitions-publish/index.md): Publish an immutable custom report definition, or a new version by id.

- [report_definitions.unpin](https://economi.co/docs/command-reference/report-definitions-unpin/index.md): Take a custom report out of the workspace sidebar and off the overview.

- [reporting_adjustment.post](https://economi.co/docs/command-reference/reporting-adjustment-post/index.md): Post a balanced, evidenced framework adjustment for the business's selected reporting package.

- [reporting_adjustment.void](https://economi.co/docs/command-reference/reporting-adjustment-void/index.md): Reverse an evidenced reporting adjustment once while preserving its package and requirement provenance.

- [reporting_profile.select](https://economi.co/docs/command-reference/reporting-profile-select/index.md): Pin the business to one exact reporting-profile package and scope using an immutable approval document.

- [shared_views.create](https://economi.co/docs/command-reference/shared-views-create/index.md): Create a link to selected reports or documents. Anyone holding it can read that data without an account until expiry or revocation.

- [shared_views.revoke](https://economi.co/docs/command-reference/shared-views-revoke/index.md): Revoke a shared view: the link stops resolving immediately.

- [subscription.cancel_request](https://economi.co/docs/command-reference/subscription-cancel-request/index.md): Request cancellation of this business's Economico subscription. The owner must approve it through the returned link before the plan changes.

- [subscription.revoke_cancellation](https://economi.co/docs/command-reference/subscription-revoke-cancellation/index.md): Undo a pending or approved cancellation before it takes effect.

- [tax_codes.create](https://economi.co/docs/command-reference/tax-codes-create/index.md): Create a tax code with an evidenced rate, role and effective period. Does not register the business, file a return or pay tax.

- [tax_codes.update](https://economi.co/docs/command-reference/tax-codes-update/index.md): Update a tax code's name, rate or active flag, or close it with effectiveUntil.

- [templates.archive](https://economi.co/docs/command-reference/templates-archive/index.md): Archive a reusable template for new catalog use.

- [templates.create](https://economi.co/docs/command-reference/templates-create/index.md): Register an immutable template definition.

- [templates.replace](https://economi.co/docs/command-reference/templates-replace/index.md): Replace an immutable template definition.





















































































































