reports.week

How the shop did in one week (Monday to Sunday in the shop's time zone) against the week before: money collected, refunded, paid outside and invoiced; quotes sent and signed; jobs, visits, customers and requests; time logged and expenses.

WhoAgents can call this
RESTGET /v1/reports/week
MCP toolreports_week
Writesno
AreaCosts, expenses and reports

When to use it

How the shop did in one week (Monday to Sunday in the shop's time zone) against the week before: money collected, refunded, paid outside and invoiced; quotes sent and signed; jobs, visits, customers and requests; time logged and expenses.

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
week_ofstringno

Example

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

Output

FieldTypeAlways there
fromstringyes
tostringyes
time_zonestringyes
currencystringyes
this_weekobjectyes
this_week.collected_minorintegeryes
this_week.refunded_minorintegeryes
this_week.outside_minorintegeryes
this_week.invoiced_minorintegeryes
this_week.invoices_issuedintegeryes
this_week.quotes_sentintegeryes
this_week.quotes_signedintegeryes
this_week.quotes_signed_minorintegeryes
this_week.jobs_createdintegeryes
this_week.jobs_doneintegeryes
this_week.visits_scheduledintegeryes
this_week.visits_doneintegeryes
this_week.new_customersintegeryes
this_week.new_requestsintegeryes
this_week.minutes_loggedintegeryes
this_week.expenses_minorintegeryes
last_weekobjectyes
last_week.collected_minorintegeryes
last_week.refunded_minorintegeryes
last_week.outside_minorintegeryes
last_week.invoiced_minorintegeryes
last_week.invoices_issuedintegeryes
last_week.quotes_sentintegeryes
last_week.quotes_signedintegeryes
last_week.quotes_signed_minorintegeryes
last_week.jobs_createdintegeryes
last_week.jobs_doneintegeryes
last_week.visits_scheduledintegeryes
last_week.visits_doneintegeryes
last_week.new_customersintegeryes
last_week.new_requestsintegeryes
last_week.minutes_loggedintegeryes
last_week.expenses_minorintegeryes
changeobjectyes
change.collected_minorintegeryes
change.refunded_minorintegeryes
change.outside_minorintegeryes
change.invoiced_minorintegeryes
change.invoices_issuedintegeryes
change.quotes_sentintegeryes
change.quotes_signedintegeryes
change.quotes_signed_minorintegeryes
change.jobs_createdintegeryes
change.jobs_doneintegeryes
change.visits_scheduledintegeryes
change.visits_doneintegeryes
change.new_customersintegeryes
change.new_requestsintegeryes
change.minutes_loggedintegeryes
change.expenses_minorintegeryes
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
{
  "from": "...",
  "to": "...",
  "time_zone": "...",
  "currency": "...",
  "this_week": {
    "collected_minor": 50000,
    "refunded_minor": 50000,
    "outside_minor": 50000,
    "invoiced_minor": 50000,
    "invoices_issued": 1,
    "quotes_sent": 1,
    "quotes_signed": 1,
    "quotes_signed_minor": 50000,
    "jobs_created": 1,
    "jobs_done": 1,
    "visits_scheduled": 1,
    "visits_done": 1,
    "new_customers": 1,
    "new_requests": 1,
    "minutes_logged": 1,
    "expenses_minor": 50000
  },
  "last_week": {
    "collected_minor": 50000,
    "refunded_minor": 50000,
    "outside_minor": 50000,
    "invoiced_minor": 50000,
    "invoices_issued": 1,
    "quotes_sent": 1,
    "quotes_signed": 1,
    "quotes_signed_minor": 50000,
    "jobs_created": 1,
    "jobs_done": 1,
    "visits_scheduled": 1,
    "visits_done": 1,
    "new_customers": 1,
    "new_requests": 1,
    "minutes_logged": 1,
    "expenses_minor": 50000
  },
  "change": {
    "collected_minor": 50000,
    "refunded_minor": 50000,
    "outside_minor": 50000,
    "invoiced_minor": 50000,
    "invoices_issued": 1,
    "quotes_sent": 1,
    "quotes_signed": 1,
    "quotes_signed_minor": 50000,
    "jobs_created": 1,
    "jobs_done": 1,
    "visits_scheduled": 1,
    "visits_done": 1,
    "new_customers": 1,
    "new_requests": 1,
    "minutes_logged": 1,
    "expenses_minor": 50000
  },
  "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.