get/api/v1/me
Who am I
The user the API key acts as, the workspace this request acts in, and the key's scopes. Works with any valid key. Any valid key.
Response 200
| data* | object |
Other responses: 401, 429, 500
Developers
Version 1, at https://ebrbe.com/api/v1. The machine-readable spec is openapi.json (OpenAPI 3.1).
Create a key in Settings → Developers and send it as a bearer token. A key acts as the person who created it, with their role, limited to its scopes (:write includes :read). Personal keys work in every workspace you belong to; pick one with the eBRBe-Workspace header (slug or id). Workspace keys only work in their own workspace.
curl https://ebrbe.com/api/v1/me \
-H "Authorization: Bearer $EBRBE_API_KEY"| time:read | Running timer, time entries and timesheets. |
| time:write | Start and stop the timer, log and edit time, submit timesheets (and their Proof Capture thumbnails, where enabled). |
| work:read | Clients, projects, work items and comments. |
| work:write | Create and update clients, projects, work items and comments. |
| agent_runs:read | The AI-agent cost ledger. |
| agent_runs:write | Log AI-agent runs and their costs. |
| reports:read | Summary reports, unbilled amounts, project status and insights. |
| invoices:read | Invoices and their lines. |
| invoices:write | Create draft invoices. |
| telemetry:write | Send OpenTelemetry gen-AI spans (OTLP); each model call becomes an agent run. |
| approvals:read | Proposals eBRBe's agents made and their decisions. |
| approvals:write | Approve internal proposals, reject proposals and ask agents to run. Client, money, rate and pay actions are never approved through the API. |
CORS is closed: the API and MCP endpoint never send Access-Control-Allow-Origin, so call them from servers, scripts and agents, not from web pages.
Every error has the same shape. Messages are written for people and safe to show to users.
{
"error": {
"code": "invalid",
"message": "model: Choose a model.",
"details": [{ "path": "model", "message": "Choose a model." }]
}
}400 malformed JSON · 401 missing or bad key · 402 plan limit · 403 role or scope · 404 not found (or not yours to see) · 409 locked, wrong state or Idempotency-Key conflict · 413 body over 1 MB · 415 not JSON · 422 validation · 429 rate limited · 501 not available yet · 500 our fault.
Lists take limit (1–200, default 50) and offset, and return pagination with total, has_more and next_offset. Fields are snake_case, timestamps ISO 8601 in UTC, dates YYYY-MM-DD. Money is an integer in minor units with a currency code (12000 USD is $120.00). Agent costs are micro-USD (cost_micros, one dollar is 1,000,000).
Send an Idempotency-Key header (e.g. a UUID) with any POST. Repeating the request with the same key and body within 24 hours returns the first response with Idempotent-Replayed: true instead of acting twice. The same key with a different body is a 409. Agent runs also dedupe on external_id.
Per key, per minute, by the workspace's plan: Free 60, Pro 300, Team 600, Business 1,200. Each IP address may make twice its key's limit, and repeated failed authentication from an address is blocked for the rest of the minute. Responses carry X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset; a 429 also has Retry-After (seconds).
Owners and admins add HTTPS endpoints in Settings → Webhooks. Each event is POSTed as JSON: { id, type, created_at, workspace_id, data }, where data has the same shape as the API resource. Any 2xx response is success; anything else (including redirects, which are never followed) is retried after 1 min, 5 min, 30 min, 2 h, 5 h, 7 h and 8 h: 8 attempts over about 23 hours. Endpoints whose last 5 deliveries all failed are disabled and admins are notified; every delivery can be replayed from the log.
time_entry.createdtime_entry.updatedtime_entry.deletedtimesheet.submittedtimesheet.approvedtimesheet.rejectedtimesheet.reopenedwork_item.createdwork_item.updatedwork_item.deletedagent_run.createdinvoice.createdinvoice.sentinvoice.paidinvoice.voidedpayment.succeededVerify every request. The eBRBe-Signature header is t=<unix seconds>,v1=<hex> where v1 = HMAC-SHA256(secret, t + "." + raw body). Reject timestamps more than 5 minutes from now. Requests also carry eBRBe-Event and eBRBe-Delivery.
import crypto from "node:crypto";
import express from "express";
const app = express();
const secret = process.env.EBRBE_WEBHOOK_SECRET; // whsec_…
// Use the raw body: re-serialised JSON won't match the signature.
app.post("/webhooks/ebrbe", express.raw({ type: "application/json" }), (req, res) => {
const header = req.get("eBRBe-Signature") ?? "";
const parts = Object.fromEntries(header.split(",").map((p) => p.split("=", 2)));
const t = Number(parts.t);
const expected = crypto.createHmac("sha256", secret).update(`${t}.${req.body}`).digest("hex");
const given = Buffer.from(parts.v1 ?? "", "hex");
const ok =
Number.isFinite(t) &&
Math.abs(Date.now() / 1000 - t) <= 300 && // 5-minute tolerance
given.length === 32 &&
crypto.timingSafeEqual(given, Buffer.from(expected, "hex"));
if (!ok) return res.status(400).send("bad signature");
const event = JSON.parse(req.body.toString("utf8"));
// event.id is stable across retries and replays: ignore ids you've already handled.
console.log(event.type, event.data);
res.sendStatus(200);
});The key's user and workspaces.
get/api/v1/me
The user the API key acts as, the workspace this request acts in, and the key's scopes. Works with any valid key. Any valid key.
| data* | object |
Other responses: 401, 429, 500
delete/api/v1/me/api-key
Signs a client out for good: the API key used for this request stops working at once (audit api_key.revoked). Works with any valid key and needs no scope. The browser extension calls it when you sign out. Any valid key.
Revoked.
Other responses: 401, 429, 500
get/api/v1/workspaces
Workspaces this key can act in. Personal keys work in every workspace the user belongs to (choose one per request with the eBRBe-Workspace header); workspace keys only in their own. Any valid key.
| limit | integer | |
| offset | integer |
| data* | Workspace[] | |
| pagination* | object |
Other responses: 401, 429, 500
get/api/v1/clients
Required scope: work:read.
| include_archived | "0" | "1" | "true" | "false" | |
| limit | integer | |
| offset | integer |
| data* | Client[] | |
| pagination* | object |
Other responses: 401, 429, 500
post/api/v1/clients
Owners, admins and managers. Free workspaces are limited to 3 active clients (402). Required scope: work:write.
| name* | string | |
| billing_email | string | null | |
| address | string | null | |
| tax_id | string | null | |
| currency | string | |
| default_rate | integer | null | |
| notes | string | null |
| data* | Client |
Other responses: 401, 402, 403, 413, 422, 429, 500
get/api/v1/clients/{id}
Required scope: work:read.
| id (path)* | string (uuid) |
| data* | Client |
Other responses: 401, 404, 429, 500
patch/api/v1/clients/{id}
Send only the fields to change. archived: true archives the client. Required scope: work:write.
| id (path)* | string (uuid) |
| name | string | |
| billing_email | string | null | |
| address | string | null | |
| tax_id | string | null | |
| currency | string | |
| default_rate | integer | null | |
| notes | string | null | |
| archived | boolean |
| data* | Client |
Other responses: 401, 402, 403, 404, 413, 422, 429, 500
get/api/v1/projects
Projects you can see: all for owners and admins, member projects for everyone else. Required scope: work:read.
| client_id | string (uuid) | |
| include_archived | "0" | "1" | "true" | "false" | |
| limit | integer | |
| offset | integer |
| data* | Project[] | |
| pagination* | object |
Other responses: 401, 429, 500
post/api/v1/projects
Owners, admins and managers. The creator becomes a project manager. Required scope: work:write.
| name* | string | |
| key | string | |
| client_id | string (uuid) | null | |
| description | string | null | |
| color | string | |
| billing_model | "hourly" | "fixed_fee" | "retainer" | "non_billable" | |
| hourly_rate | integer | null | |
| budget_minutes | integer | null | |
| budget_amount | integer | null | |
| fee_amount | integer | null | |
| currency | string | |
| start_date | string (date) | null | |
| end_date | string (date) | null | |
| lead_id | string (uuid) | null | |
| status | "active" | "on_hold" | "completed" |
| data* | object |
Other responses: 401, 403, 413, 422, 429, 500
get/api/v1/projects/{id}
Required scope: work:read.
| id (path)* | string (uuid) |
| data* | object |
Other responses: 401, 403, 404, 429, 500
patch/api/v1/projects/{id}
Send only the fields to change. Needs project manager rights. archived: true archives it. Required scope: work:write.
| id (path)* | string (uuid) |
| name | string | |
| key | string | |
| client_id | string (uuid) | null | |
| description | string | null | |
| color | string | |
| billing_model | "hourly" | "fixed_fee" | "retainer" | "non_billable" | |
| hourly_rate | integer | null | |
| budget_minutes | integer | null | |
| budget_amount | integer | null | |
| fee_amount | integer | null | |
| currency | string | |
| start_date | string (date) | null | |
| end_date | string (date) | null | |
| lead_id | string (uuid) | null | |
| status | "active" | "on_hold" | "completed" | |
| archived | boolean |
| data* | object |
Other responses: 401, 403, 404, 413, 422, 429, 500
get/api/v1/projects/{id}/status
Required scope: reports:read.
| id (path)* | string (uuid) |
| data* | object |
Other responses: 401, 403, 404, 429, 500
get/api/v1/work-items
With assigned=me: your open items across projects. With project_id (and no q): every item in the project you can see, in board order. With q: search titles, or a key like WEB-12. Required scope: work:read.
| project_id | string (uuid) | |
| q | string | |
| assigned | "me" | |
| open | "0" | "1" | "true" | "false" | |
| limit | integer | |
| offset | integer |
| data* | WorkItem[] | |
| pagination* | object |
Other responses: 401, 429, 500
post/api/v1/work-items
Required scope: work:write.
| project_id* | string (uuid) | |
| title* | string | |
| description | string | |
| status_id | string (uuid) | |
| parent_id | string (uuid) | |
| type | "epic" | "task" | "subtask" | |
| priority | "none" | "low" | "medium" | "high" | "urgent" | |
| estimate_minutes | integer | null | |
| due_date | string (date) | null | |
| assignee_ids | string (uuid)[] |
| data* | object |
Other responses: 401, 403, 404, 413, 422, 429, 500
get/api/v1/work-items/lookup
Matches a page (GitHub PR or issue, Linear or Jira ticket, Notion page, Google Doc, Figma file…) to work items you can see: evidence on that URL linked to an item, item keys (WEB-12) in the title or URL, then open items with a similar title. project is the project the page points at (evidence or your GitHub repo mapping), when there is one. Used by the browser extension. Required scope: work:read.
| url* | string | |
| title | string | |
| limit | integer |
| data* | object[] | |
| project* | object | null |
Other responses: 401, 422, 429, 500
get/api/v1/work-items/{id}
Required scope: work:read.
| id (path)* | string (uuid) |
| data* | object |
Other responses: 401, 403, 404, 429, 500
patch/api/v1/work-items/{id}
Send only the fields to change. Contractors may change only status_id on items assigned to them. Required scope: work:write.
| id (path)* | string (uuid) |
| title | string | |
| description | string | null | |
| status_id | string (uuid) | |
| parent_id | string (uuid) | null | |
| type | "epic" | "task" | "subtask" | |
| priority | "none" | "low" | "medium" | "high" | "urgent" | |
| estimate_minutes | integer | null | |
| due_date | string (date) | null | |
| assignee_ids | string (uuid)[] |
| data* | object |
Other responses: 401, 403, 404, 413, 422, 429, 500
delete/api/v1/work-items/{id}
Required scope: work:write.
| id (path)* | string (uuid) |
Deleted.
Other responses: 401, 403, 404, 429, 500
get/api/v1/work-items/{id}/comments
Required scope: work:read.
| id (path)* | string (uuid) | |
| limit | integer | |
| offset | integer |
| data* | Comment[] | |
| pagination* | object |
Other responses: 401, 403, 404, 429, 500
post/api/v1/work-items/{id}/comments
Required scope: work:write.
| id (path)* | string (uuid) |
| text* | string |
| data* | Comment |
Other responses: 401, 403, 404, 413, 422, 429, 500
Time entries.
get/api/v1/time-entries
Your own entries that start in [from, to). Defaults to the last 7 days; at most 92 days per request. Required scope: time:read.
| from | string (date-time) | string (date) | |
| to | string (date-time) | string (date) | |
| limit | integer | |
| offset | integer |
| data* | TimeEntry[] | |
| pagination* | object |
Other responses: 401, 429, 500
post/api/v1/time-entries
Give a duration, or a start and end time (or start/end plus a duration), on a date in your timezone. Required scope: time:write.
| project_id | string (uuid) | null | |
| work_item_id | string (uuid) | null | |
| description | string | |
| billable | boolean | |
| date | string (date) | |
| start | string | |
| end | string | |
| duration | string | |
| duration_seconds | integer |
| data* | TimeEntry |
Other responses: 401, 403, 404, 409, 413, 422, 429, 500
get/api/v1/time-entries/{id}
Required scope: time:read.
| id (path)* | string (uuid) |
| data* | TimeEntry |
Other responses: 401, 404, 429, 500
patch/api/v1/time-entries/{id}
Send only what changes. Changing times needs date plus start/end/duration. Approved and invoiced entries are locked (409). Required scope: time:write.
| id (path)* | string (uuid) |
| project_id | string (uuid) | null | |
| work_item_id | string (uuid) | null | |
| description | string | |
| billable | boolean | |
| date | string (date) | |
| start | string | |
| end | string | |
| duration | string | |
| duration_seconds | integer |
| data* | TimeEntry |
Other responses: 401, 403, 404, 409, 413, 422, 429, 500
delete/api/v1/time-entries/{id}
Required scope: time:write.
| id (path)* | string (uuid) |
Deleted.
Other responses: 401, 403, 404, 409, 429, 500
get/api/v1/timer
Required scope: time:read.
| data* | RunningTimer | null |
Other responses: 401, 429, 500
post/api/v1/timer/start
Starting while a timer runs stops it first and saves its entry (returned as stopped_entry). Required scope: time:write.
| project_id | string (uuid) | null | |
| work_item_id | string (uuid) | null | |
| description | string | |
| billable | boolean | |
| started_at | string (date-time) | |
| source | "api" | "desktop" |
| data* | RunningTimer | |
| stopped_entry* | TimeEntry | null |
Other responses: 401, 403, 404, 413, 422, 429, 500
post/api/v1/timer/stop
Saves the running timer as a time entry. data is null when nothing was running (or it ran under a second). Required scope: time:write.
| end_at | string (date-time) |
| data* | TimeEntry | null |
Other responses: 401, 413, 422, 429, 500
get/api/v1/timesheets
Required scope: time:read.
| limit | integer | |
| offset | integer |
| data* | Timesheet[] | |
| pagination* | object |
Other responses: 401, 429, 500
get/api/v1/timesheets/{week}
Required scope: time:read.
| week (path)* | string (date) |
Other responses: 401, 429, 500
post/api/v1/timesheets/{week}/submit
Required scope: time:write.
| week (path)* | string (date) |
| comment | string |
| data* | Timesheet |
Other responses: 401, 409, 413, 422, 429, 500
Opt-in, contractor-reviewed screen thumbnails from the desktop app (Business plan, off by default).
get/api/v1/proof-capture/projects
Projects you track on where an Admin turned Proof Capture on, with each project's settings, the transparency notice to show and whether you accepted it. available is false (and the list empty) when the workspace doesn't have Proof Capture. Required scope: time:read.
| available* | boolean | |
| data* | object[] |
Other responses: 401, 429, 500
post/api/v1/proof-capture/consents
Send the notice's version and sha256 exactly as GET /proof-capture/projects returned them; a changed notice is refused (409) so it can be shown again. Required scope: time:write.
| project_id* | string (uuid) | |
| notice_version* | string | |
| notice_sha256* | string |
| data* | object |
Other responses: 401, 404, 409, 413, 422, 429, 500
delete/api/v1/proof-capture/consents/{id}
id is the project id. Idempotent. Required scope: time:write.
| id (path)* | string (uuid) |
Withdrawn (or there was nothing to withdraw).
Other responses: 401, 429, 500
post/api/v1/proof-captures
One thumbnail the person reviewed and kept (≤ 512 KB JPEG, PNG or WebP, ≤ 1280px; the type and size are read from the bytes). Send client_capture_id as the Idempotency-Key too; the same id again returns the stored capture (200). Refused without a consent on record at captured_at, for an approved week, or unblurred where the project requires blur. Required scope: time:write.
| client_capture_id* | string (uuid) | |
| project_id* | string (uuid) | |
| work_item_id | string (uuid) | null | |
| captured_at* | string (date-time) | |
| reviewed_at | string (date-time) | null | |
| note | string | null | |
| mime_type* | "image/jpeg" | "image/png" | "image/webp" | |
| image_base64* | string | |
| width* | integer | |
| height* | integer | |
| blurred* | boolean | |
| activity | object[] |
| data* | object |
Other responses: 401, 402, 404, 409, 413, 415, 422, 429, 500
delete/api/v1/proof-captures/{id}
Required scope: time:write.
| id (path)* | string (uuid) |
Deleted.
Other responses: 401, 404, 429, 500
The AI-agent cost ledger.
post/api/v1/agent-runs
Records tokens and cost for one agent run. Cost is calculated from the model's list price unless you send cost_usd. Returns 201 for a new run, or 200 with the existing run when external_id was already logged. Required scope: agent_runs:write.
| provider | string | |
| model* | string | |
| tool | string | |
| description | string | |
| input_tokens | integer | |
| output_tokens | integer | |
| cache_read_tokens | integer | |
| cache_write_tokens | integer | |
| cost_usd | number | null | |
| duration_ms | integer | null | |
| started_at | string (date-time) | |
| project_id | string (uuid) | null | |
| client_id | string (uuid) | null | |
| work_item_id | string (uuid) | null | |
| external_id | string | null | |
| billable | boolean |
| data* | AgentRun |
Other responses: 401, 403, 404, 413, 422, 429, 500
get/api/v1/agent-runs
Your runs; managers also see runs on their projects; owners and admins see every run. Newest first, up to 1,000 per query window. Required scope: agent_runs:read.
| from | string (date-time) | string (date) | |
| to | string (date-time) | string (date) | |
| project_id | string (uuid) | |
| client_id | string (uuid) | |
| model | string | |
| tool | string | |
| limit | integer | |
| offset | integer |
| data* | AgentRun[] | |
| totals* | object | |
| pagination* | object |
Other responses: 401, 429, 500
get/api/v1/reports/summary
The same numbers as Reports in the app: totals and breakdowns by client, project and member, agent cost, and budget burn. Owners, admins and managers (their projects). Give a period preset, or from and to for a custom range (in your timezone). Required scope: reports:read.
| period | "this-week" | "last-week" | "this-month" | "last-month" | "last-30" | "this-quarter" | "this-year" | "custom" | |
| from | string (date) | |
| to | string (date) | |
| client_id | string (uuid) | |
| project_id | string (uuid) | |
| user_id | string (uuid) | |
| billable | "all" | "billable" | "non_billable" |
| data* | object |
Other responses: 401, 403, 429, 500
get/api/v1/reports/unbilled
Billable time and agent runs not yet on an invoice, per project, with values (agent costs after markup). Required scope: reports:read.
| client_id | string (uuid) | |
| project_id | string (uuid) |
| data* | object |
Other responses: 401, 429, 500
Read invoices and create drafts. Sending happens in the app, after a person reviews the draft.
get/api/v1/invoices
Owners and admins see every invoice; managers only when the workspace lets managers invoice, for their projects' clients. Required scope: invoices:read.
| status | "draft" | "sent" | "viewed" | "partially_paid" | "paid" | "overdue" | "void" | |
| client_id | string (uuid) | |
| limit | integer | |
| offset | integer |
| data* | Invoice[] | |
| pagination* | object |
Other responses: 401, 403, 429, 500
post/api/v1/invoices
Builds a draft for a client from approved, unbilled time and agent runs (with markup) in the period. Drafts only: a person reviews and sends it in the app. Free workspaces are limited to 5 invoices a month (402). Required scope: invoices:write.
| client_id* | string (uuid) | |
| period_start* | string (date) | |
| period_end* | string (date) | |
| group_by | "project" | "task" | "person" | "none" | |
| include_time | boolean | |
| include_agent | boolean | |
| fixed_project_ids | string (uuid)[] |
| data* | object |
Other responses: 401, 402, 403, 404, 413, 422, 429, 500
get/api/v1/invoices/{id}
Required scope: invoices:read.
| id (path)* | string (uuid) |
| data* | object |
Other responses: 401, 403, 404, 429, 500
| id* | string (uuid) | |
| name* | string | |
| email* | string | |
| timezone* | string |
| id* | string (uuid) | |
| slug* | string | |
| name* | string | |
| role* | string |
| id* | string (uuid) | |
| name* | string | |
| billing_email* | string | null | |
| address* | string | null | |
| tax_id* | string | null | |
| currency* | string | |
| default_rate* | integer | null | Default hourly bill rate in minor units of `currency`. |
| notes* | string | null | |
| archived* | boolean | |
| created_at* | string (date-time) | |
| updated_at* | string (date-time) |
| id* | string (uuid) | |
| key* | string | Short key used in work item references, e.g. WEB in WEB-12. |
| name* | string | |
| description* | string | null | |
| color* | string | |
| client_id* | string (uuid) | null | |
| billing_model* | "hourly" | "fixed_fee" | "retainer" | "non_billable" | |
| status* | string | |
| currency* | string | |
| budget_minutes* | integer | null | |
| budget_amount* | integer | null | Money budget in minor units of `currency`. |
| fee_amount* | integer | null | |
| start_date* | string (date) | null | |
| end_date* | string (date) | null | |
| lead_id* | string (uuid) | null | |
| archived* | boolean | |
| created_at* | string (date-time) | null |
| id* | string (uuid) | |
| project_id* | string (uuid) | |
| key* | string | null | |
| number* | integer | |
| title* | string | |
| type* | "epic" | "task" | "subtask" | |
| parent_id* | string (uuid) | null | |
| status_id* | string (uuid) | null | |
| priority* | "none" | "low" | "medium" | "high" | "urgent" | |
| estimate_minutes* | integer | null | |
| due_date* | string (date) | null | |
| assignee_ids* | string (uuid)[] | null | Null when not loaded (webhook payloads of updates). |
| completed_at* | string (date-time) | null | |
| created_at* | string (date-time) |
| id* | string (uuid) | |
| work_item_id* | string (uuid) | |
| author_id* | string (uuid) | null | |
| text* | string | |
| body* | object | |
| created_at* | string (date-time) |
| id* | string (uuid) | |
| user_id* | string (uuid) | |
| project_id* | string (uuid) | null | |
| work_item_id* | string (uuid) | null | |
| description* | string | |
| started_at* | string (date-time) | |
| ended_at* | string (date-time) | |
| duration_seconds* | integer | |
| billable* | boolean | |
| bill_rate* | integer | null | Hourly bill rate in minor units of `currency`. |
| cost_rate* | integer | null | Hourly cost rate in minor units of `currency`. |
| currency* | string | |
| source* | string | timer, manual, autopilot, mcp, api, import or desktop. |
| timesheet_id* | string (uuid) | null | |
| locked* | boolean | Approved (or invoiced) entries are locked. |
| invoiced* | boolean |
| id* | string (uuid) | |
| started_at* | string (date-time) | |
| elapsed_seconds* | integer | |
| description* | string | |
| billable* | boolean | |
| source* | string | |
| project_id* | string (uuid) | null | |
| project_name* | string | null | |
| work_item_id* | string (uuid) | null | |
| work_item_key* | string | null | |
| work_item_title* | string | null |
| id* | string (uuid) | null | |
| user_id* | string (uuid) | |
| week_start* | string (date) | |
| status* | "draft" | "submitted" | "approved" | "rejected" | |
| total_seconds* | integer | |
| billable_seconds* | integer | null | |
| submitted_at* | string (date-time) | null | |
| decided_at* | string (date-time) | null |
| id* | string (uuid) | |
| user_id* | string (uuid) | null | |
| provider* | string | |
| model* | string | |
| tool* | string | |
| description* | string | |
| input_tokens* | integer | |
| output_tokens* | integer | |
| cache_read_tokens* | integer | |
| cache_write_tokens* | integer | |
| cost_micros* | integer | |
| cost_usd* | number | |
| cost_source* | "calculated" | "supplied" | |
| duration_ms* | integer | null | |
| started_at* | string (date-time) | |
| project_id* | string (uuid) | null | |
| client_id* | string (uuid) | null | |
| work_item_id* | string (uuid) | null | |
| external_id* | string | null | |
| source* | string | |
| billable* | boolean | |
| invoiced* | boolean |
| id* | string (uuid) | |
| kind* | string | time, agent, fixed, expense or manual. |
| description* | string | |
| quantity* | number | |
| unit* | string | |
| unit_price* | integer | |
| amount* | integer | |
| project_id* | string (uuid) | null |
| id* | string (uuid) | |
| number* | string | |
| status* | string | draft, sent, viewed, partially_paid, paid, overdue or void. |
| client_id* | string (uuid) | |
| currency* | string | |
| issue_date* | string (date) | |
| due_date* | string (date) | |
| period_start* | string (date) | null | |
| period_end* | string (date) | null | |
| subtotal* | integer | |
| discount_amount* | integer | |
| tax_amount* | integer | |
| total* | integer | |
| amount_paid* | integer | |
| balance_due* | integer | |
| sent_at* | string (date-time) | null | |
| paid_at* | string (date-time) | null | |
| voided_at* | string (date-time) | null | |
| created_at* | string (date-time) | |
| lines | InvoiceLine[] | Included on single-invoice responses. |
| error* | object |
Prefer to let an AI assistant do it? See the MCP server.