reports.today

The shop's today queues in one call: visits today, visits in the next 7 days with nobody assigned, new requests, quotes and change orders waiting on the customer, overdue and draft invoices, done jobs not invoiced, time waiting for approval, approvals waiting on the owner, open tasks due by today and done visits with no quote sent yet. Each list shows the first 25 with the full count.

WhoAgents can call this
RESTGET /v1/reports/today
MCP toolreports_today
Writesno
AreaCosts, expenses and reports

When to use it

The shop's today queues in one call: visits today, visits in the next 7 days with nobody assigned, new requests, quotes and change orders waiting on the customer, overdue and draft invoices, done jobs not invoiced, time waiting for approval, approvals waiting on the owner, open tasks due by today and done visits with no quote sent yet. Each list shows the first 25 with the full count.

What to tell the owner

Tell them what you found in plain words. Don't read back raw fields.

Input

FieldTypeRequired
shop_idstring (uuid)yes
datestringno

Example

GET https://doingwork.work/v1/reports/today?shop_id=00000000-0000-4000-8000-000000000000

Output

FieldTypeAlways there
datestringyes
time_zonestringyes
currencystringyes
visits_todayobjectyes
visits_today.countintegeryes
visits_today.itemsarrayyes
visits_today.items[].visit_idstring (uuid)yes
visits_today.items[].job_idstring (uuid)yes
visits_today.items[].job_summary['string', 'null']yes
visits_today.items[].customer_name['string', 'null']yes
visits_today.items[].title['string', 'null']yes
visits_today.items[].starts_atstring (date-time)yes
visits_today.items[].ends_atstring (date-time)yes
visits_today.items[].statusstringyes
visits_today.items[].assigneesarrayyes
unassigned_visitsobjectyes
unassigned_visits.countintegeryes
unassigned_visits.itemsarrayyes
unassigned_visits.items[].visit_idstring (uuid)yes
unassigned_visits.items[].job_idstring (uuid)yes
unassigned_visits.items[].job_summary['string', 'null']yes
unassigned_visits.items[].customer_name['string', 'null']yes
unassigned_visits.items[].title['string', 'null']yes
unassigned_visits.items[].starts_atstring (date-time)yes
unassigned_visits.items[].ends_atstring (date-time)yes
unassigned_visits.items[].statusstringyes
unassigned_visits.items[].assigneesarrayyes
new_requestsobjectyes
new_requests.countintegeryes
new_requests.itemsarrayyes
new_requests.items[].request_idstring (uuid)yes
new_requests.items[].titlestringyes
new_requests.items[].sourcestringyes
new_requests.items[].customer_id['string', 'null', ' ', '(', 'u', 'u', 'i', 'd', ')']yes
new_requests.items[].created_atstring (date-time)yes
quotes_waitingobjectyes
quotes_waiting.countintegeryes
quotes_waiting.itemsarrayyes
quotes_waiting.items[].quote_idstring (uuid)yes
quotes_waiting.items[].job_idstring (uuid)yes
quotes_waiting.items[].customer_name['string', 'null']yes
quotes_waiting.items[].doc_nointegeryes
quotes_waiting.items[].doc_labelstringyes
quotes_waiting.items[].total_minorintegeryes
quotes_waiting.items[].total_textstringyes
quotes_waiting.items[].sent_atstring (date-time)yes
quotes_waiting.items[].days_waitingintegeryes
change_orders_waitingobjectyes
change_orders_waiting.countintegeryes
change_orders_waiting.itemsarrayyes
change_orders_waiting.items[].change_order_idstring (uuid)yes
change_orders_waiting.items[].job_idstring (uuid)yes
change_orders_waiting.items[].numberintegeryes
change_orders_waiting.items[].total_minorintegeryes
change_orders_waiting.items[].sent_at['string', 'null', ' ', '(', 'd', 'a', 't', 'e', '-', 't', 'i', 'm', 'e', ')']yes
invoices_overdueobjectyes
invoices_overdue.countintegeryes
invoices_overdue.itemsarrayyes
invoices_overdue.items[].invoice_idstring (uuid)yes
invoices_overdue.items[].job_idstring (uuid)yes
invoices_overdue.items[].customer_name['string', 'null']yes
invoices_overdue.items[].doc_nointegeryes
invoices_overdue.items[].doc_labelstringyes
invoices_overdue.items[].owed_minorintegeryes
invoices_overdue.items[].owed_textstringyes
invoices_overdue.items[].due_onstringyes
invoices_overdue.items[].days_overdueintegeryes
draft_invoicesobjectyes
draft_invoices.countintegeryes
draft_invoices.itemsarrayyes
draft_invoices.items[].invoice_idstring (uuid)yes
draft_invoices.items[].job_idstring (uuid)yes
draft_invoices.items[].customer_name['string', 'null']yes
draft_invoices.items[].doc_nointegeryes
draft_invoices.items[].doc_labelstringyes
draft_invoices.items[].total_minorintegeryes
draft_invoices.items[].total_textstringyes
draft_invoices.items[].created_atstring (date-time)yes
jobs_to_invoiceobjectyes
jobs_to_invoice.countintegeryes
jobs_to_invoice.itemsarrayyes
jobs_to_invoice.items[].job_idstring (uuid)yes
jobs_to_invoice.items[].summary['string', 'null']yes
jobs_to_invoice.items[].customer_name['string', 'null']yes
jobs_to_invoice.items[].occurred_atstring (date-time)yes
time_to_approveobjectyes
time_to_approve.entriesintegeryes
time_to_approve.minutesintegeryes
time_to_approve.peopleintegeryes
time_to_approve.oldest_started_at['string', 'null', ' ', '(', 'd', 'a', 't', 'e', '-', 't', 'i', 'm', 'e', ')']yes
approvals_pendingobjectyes
approvals_pending.countintegeryes
approvals_pending.itemsarrayyes
approvals_pending.items[].approval_idstring (uuid)yes
approvals_pending.items[].op_idstringyes
approvals_pending.items[].amount_minor['integer', 'null']yes
approvals_pending.items[].requested_bystring (uuid)yes
approvals_pending.items[].expires_atstring (date-time)yes
open_tasksobjectyes
open_tasks.countintegeryes
open_tasks.itemsarrayyes
open_tasks.items[].task_idstring (uuid)yes
open_tasks.items[].titlestringyes
open_tasks.items[].job_id['string', 'null', ' ', '(', 'u', 'u', 'i', 'd', ')']yes
open_tasks.items[].job_summary['string', 'null']yes
open_tasks.items[].assignee_id['string', 'null', ' ', '(', 'u', 'u', 'i', 'd', ')']yes
open_tasks.items[].due_atstring (date-time)yes
open_tasks.items[].overduebooleanyes
capacityobjectyes
capacity.time_zonestringyes
capacity.hours_sourcestringyes
capacity.visit_minutesintegeryes
capacity.daysarrayyes
capacity.days[].datestringyes
capacity.days[].weekdaystringyes
capacity.days[].open_minutesintegeryes
capacity.days[].booked_minutesintegeryes
capacity.days[].free_minutesintegeryes
capacity.days[].percent_bookedintegeryes
capacity.days[].fitsintegeryes
capacity.days[].workersintegeryes
capacity.next_actionsarrayyes
capacity.next_actions[].saystringyes
capacity.next_actions[].op['string', 'null']yes
capacity.next_actions[].whenstring (one of now, later, check, tell_human)yes
capacity.next_actions[].due_at['string', 'null', ' ', '(', 'd', 'a', 't', 'e', '-', 't', 'i', 'm', 'e', ')']no
capacity.next_actions[].args_hintstringno
quote_queueobjectyes
quote_queue.countintegeryes
quote_queue.itemsarrayyes
quote_queue.items[].visit_idstring (uuid)yes
quote_queue.items[].job_idstring (uuid)yes
quote_queue.items[].job_summary['string', 'null']yes
quote_queue.items[].customer_name['string', 'null']yes
quote_queue.items[].done_atstring (date-time)yes
summarystringyes
displayobjectyes
display.kindstring (one of table, cards, timeline, checklist, map, calendar, chart)yes
display.titlestringyes
display.columnsarrayno
display.columns[].keystringyes
display.columns[].labelstringyes
display.fieldsarrayno
display.fields[].keystringyes
display.fields[].labelstringyes
next_stepsarrayyes
next_steps[].saystringyes
next_steps[].op['string', 'null']yes
next_steps[].whenstring (one of now, later, check, tell_human)yes
next_steps[].due_at['string', 'null', ' ', '(', 'd', 'a', 't', 'e', '-', 't', 'i', 'm', 'e', ')']no
next_steps[].args_hintstringno
{
  "date": "...",
  "time_zone": "...",
  "currency": "...",
  "visits_today": {
    "count": 1,
    "items": [
      {
        "visit_id": "00000000-0000-4000-8000-000000000000",
        "job_id": "00000000-0000-4000-8000-000000000000",
        "job_summary": "...",
        "customer_name": "...",
        "title": "...",
        "starts_at": "...",
        "ends_at": "...",
        "status": "...",
        "assignees": [
          "00000000-0000-4000-8000-000000000000"
        ]
      }
    ]
  },
  "unassigned_visits": {
    "count": 1,
    "items": [
      {
        "visit_id": "00000000-0000-4000-8000-000000000000",
        "job_id": "00000000-0000-4000-8000-000000000000",
        "job_summary": "...",
        "customer_name": "...",
        "title": "...",
        "starts_at": "...",
        "ends_at": "...",
        "status": "...",
        "assignees": [
          "00000000-0000-4000-8000-000000000000"
        ]
      }
    ]
  },
  "new_requests": {
    "count": 1,
    "items": [
      {
        "request_id": "00000000-0000-4000-8000-000000000000",
        "title": "...",
        "source": "...",
        "customer_id": "00000000-0000-4000-8000-000000000000",
        "created_at": "..."
      }
    ]
  },
  "quotes_waiting": {
    "count": 1,
    "items": [
      {
        "quote_id": "00000000-0000-4000-8000-000000000000",
        "job_id": "00000000-0000-4000-8000-000000000000",
        "customer_name": "...",
        "doc_no": 1,
        "doc_label": "...",
        "total_minor": 50000,
        "total_text": "...",
        "sent_at": "...",
        "days_waiting": 1
      }
    ]
  },
  "change_orders_waiting": {
    "count": 1,
    "items": [
      {
        "change_order_id": "00000000-0000-4000-8000-000000000000",
        "job_id": "00000000-0000-4000-8000-000000000000",
        "number": 1,
        "total_minor": 50000,
        "sent_at": "..."
      }
    ]
  },
  "invoices_overdue": {
    "count": 1,
    "items": [
      {
        "invoice_id": "00000000-0000-4000-8000-000000000000",
        "job_id": "00000000-0000-4000-8000-000000000000",
        "customer_name": "...",
        "doc_no": 1,
        "doc_label": "...",
        "owed_minor": 50000,
        "owed_text": "...",
        "due_on": "...",
        "days_overdue": 1
      }
    ]
  },
  "draft_invoices": {
    "count": 1,
    "items": [
      {
        "invoice_id": "00000000-0000-4000-8000-000000000000",
        "job_id": "00000000-0000-4000-8000-000000000000",
        "customer_name": "...",
        "doc_no": 1,
        "doc_label": "...",
        "total_minor": 50000,
        "total_text": "...",
        "created_at": "..."
      }
    ]
  },
  "jobs_to_invoice": {
    "count": 1,
    "items": [
      {
        "job_id": "00000000-0000-4000-8000-000000000000",
        "summary": "...",
        "customer_name": "...",
        "occurred_at": "..."
      }
    ]
  },
  "time_to_approve": {
    "entries": 1,
    "minutes": 1,
    "people": 1,
    "oldest_started_at": "..."
  },
  "approvals_pending": {
    "count": 1,
    "items": [
      {
        "approval_id": "00000000-0000-4000-8000-000000000000",
        "op_id": "00000000-0000-4000-8000-000000000000",
        "amount_minor": "...",
        "requested_by": "00000000-0000-4000-8000-000000000000",
        "expires_at": "..."
      }
    ]
  },
  "open_tasks": {
    "count": 1,
    "items": [
      {
        "task_id": "00000000-0000-4000-8000-000000000000",
        "title": "...",
        "job_id": "00000000-0000-4000-8000-000000000000",
        "job_summary": "...",
        "assignee_id": "00000000-0000-4000-8000-000000000000",
        "due_at": "...",
        "overdue": true
      }
    ]
  },
  "capacity": {
    "time_zone": "...",
    "hours_source": "...",
    "visit_minutes": 1,
    "days": [
      {
        "date": "...",
        "weekday": "...",
        "open_minutes": 1,
        "booked_minutes": 1,
        "free_minutes": 1,
        "percent_booked": 1,
        "fits": 1,
        "workers": 1
      }
    ],
    "next_actions": [
      {
        "say": "...",
        "op": "...",
        "when": "now"
      }
    ]
  },
  "quote_queue": {
    "count": 1,
    "items": [
      {
        "visit_id": "00000000-0000-4000-8000-000000000000",
        "job_id": "00000000-0000-4000-8000-000000000000",
        "job_summary": "...",
        "customer_name": "...",
        "done_at": "..."
      }
    ]
  },
  "summary": "...",
  "display": {
    "kind": "table",
    "title": "..."
  },
  "next_steps": [
    {
      "say": "...",
      "op": "...",
      "when": "now"
    }
  ]
}

Errors

CodeStatusWhat to do
invalid_input, invalid_token, rate_limitedCan happen on any call. See errors.