Proposals

Journal entries suggested by an AI assistant, and what AI agents sent for approval, waiting for a person.

List proposed entries

GET /proposals

Sends Vortex-Entity.

Newest first. Requires ledger:read.

Parameters

NameInTypeAbout
statusquerystring
limitqueryinteger

Answers

  • 200 object. The proposals.
  • 4XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what
  • 5XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what

Propose a journal entry

POST /proposals

Sends Vortex-Entity and Idempotency-Key.

Changes nothing until a person approves it. The entry is tried against the ledger first and refused if the ledger wouldn't take it. Requires proposals:write.

Body

FieldTypeAbout
reason requiredstring

Up to 1000 characters.

entry requiredobject

The same shape as posting a journal entry.

Answers

  • 201 Proposal. The proposal.
  • 4XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what
  • 5XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what

Get a proposed entry

GET /proposals/{proposal_id}

Sends Vortex-Entity.

Requires ledger:read.

Parameters

NameInTypeAbout
proposal_id requiredpathstring (uuid)

Answers

  • 200 Proposal. The proposal.
  • 4XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what
  • 5XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what

Approve and post a proposed entry

POST /proposals/{proposal_id}/approve

Sends Vortex-Entity and Idempotency-Key.

Posts the entry with the approver as its author. Whoever proposed it can't approve it. Requires journal:write.

Parameters

NameInTypeAbout
proposal_id requiredpathstring (uuid)

Body

FieldTypeAbout
notestring

Up to 500 characters.

Answers

  • 200 Proposal. The proposal.
  • 4XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what
  • 5XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what

Reject a proposed entry

POST /proposals/{proposal_id}/reject

Sends Vortex-Entity and Idempotency-Key.

Requires journal:write.

Parameters

NameInTypeAbout
proposal_id requiredpathstring (uuid)

Body

FieldTypeAbout
notestring

Up to 500 characters.

Answers

  • 200 Proposal. The proposal.
  • 4XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what
  • 5XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what

List what AI agents sent for approval

GET /approval-requests

Sends Vortex-Entity.

Bills, bill payments, invoices, expenses, bank lines and vendors an AI agent sent for an owner or admin to approve, newest first. An owner or admin approves or rejects them in the app; approving runs the agent's call as that person. Journal entries an agent sends are proposals instead. Requires ledger:read.

Parameters

NameInTypeAbout
statusquerystring
limitqueryinteger

Answers

  • 200 object. The requests.
  • 4XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what
  • 5XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what

Get one thing an AI agent sent for approval

GET /approval-requests/{approval_request_id}

Sends Vortex-Entity.

Requires ledger:read.

Parameters

NameInTypeAbout
approval_request_id requiredpathstring (uuid)

Answers

  • 200 ApprovalRequest. The request.
  • 4XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what
  • 5XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what