Site visits

Base URL: $BUSINESS_API

The object

idstring · required
tenant_idstring · required
request_idstring · required
statusstring · required

one of scheduled, completed, cancelled

visit_datestring (date) · required
booked_bystring · required

one of consumer, staff

notesstring · optional
outcomestring · optional
quote_idstring · optional
completed_atstring (date-time) · optional
cancelled_atstring (date-time) · optional
created_atstring (date-time) · required
updated_atstring (date-time) · required
The object
{
  "id": "sit_2ljUKXviQDVcG3dOWH1ysvVGYfL",
  "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
  "request_id": "req_2JrY4JziCp1C0bFCSLb4M37qGNH",
  "status": "scheduled",
  "visit_date": "2026-11-19",
  "booked_by": "consumer",
  "notes": "Leitura confirmada no local.",
  "outcome": "outcome",
  "quote_id": "quo_26mh1wUlhIGz1c4BTWQl9M2dDyI",
  "completed_at": "2026-11-19T09:30:00Z",
  "cancelled_at": "2026-11-19T09:30:00Z",
  "created_at": "2026-11-19T09:30:00Z",
  "updated_at": "2026-11-19T09:30:00Z"
}

Record what a site visit found

Logs

POST /site-visits/{id}/complete

With quote lines, the revised quote is issued from the outcome at once; otherwise the request awaits a quote.

Parameters

idstring · path · required

ID of the scheduled site visit in the caller's tenant to record as completed.

Body application/json

outcomestring · required
quoteobject · optional
Show child attributes
linesarray of object · required
Show child attributes
charge_codestring · optional

A price key from quote-prices; omit for a free line

descriptionstring · optional
quantitynumber · optional

Defaults to 1

unit_price_centsinteger (int64) · optional

Overrides the tariff price (with a reason) or prices a free line

taxableboolean · optional

Free lines only; defaults to true

adjustment_reasonstring · optional
valid_untilstring (date) · optional

Defaults to 30 days from today

notesstring · optional
site_visit_idstring · optional

The visit this quote follows

Returns

200 Completed visit, with quote_id when a quote was issued

Show attributes
idstring · required
tenant_idstring · required
request_idstring · required
statusstring · required

one of scheduled, completed, cancelled

visit_datestring (date) · required
booked_bystring · required

one of consumer, staff

notesstring · optional
outcomestring · optional
quote_idstring · optional
completed_atstring (date-time) · optional
cancelled_atstring (date-time) · optional
created_atstring (date-time) · required
updated_atstring (date-time) · required

Errors 400 · 403 · 404

Permissions connections:write · Roles: admin, operations, owner

curl -X POST "$BUSINESS_API/site-visits/{id}/complete" \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{
  "outcome": "outcome",
  "quote": {
    "lines": [
      {
        "charge_code": "CHA-2026-000142",
        "description": "Leitura confirmada no local.",
        "quantity": 1,
        "unit_price_cents": 125000,
        "taxable": true,
        "adjustment_reason": "adjustment reason"
      }
    ],
    "valid_until": "2026-11-19",
    "notes": "Leitura confirmada no local.",
    "site_visit_id": "sit_2ljUKXviQDVcG3dOWH1ysvVGYfL"
  }
}'
Response 200
{
  "id": "sit_2ljUKXviQDVcG3dOWH1ysvVGYfL",
  "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
  "request_id": "req_2JrY4JziCp1C0bFCSLb4M37qGNH",
  "status": "scheduled",
  "visit_date": "2026-11-19",
  "booked_by": "consumer",
  "notes": "Leitura confirmada no local.",
  "outcome": "outcome",
  "quote_id": "quo_26mh1wUlhIGz1c4BTWQl9M2dDyI",
  "completed_at": "2026-11-19T09:30:00Z",
  "cancelled_at": "2026-11-19T09:30:00Z",
  "created_at": "2026-11-19T09:30:00Z",
  "updated_at": "2026-11-19T09:30:00Z"
}

Cancel a site visit still to happen

Logs

POST /site-visits/{id}/cancel

Marks a scheduled site visit as cancelled and records when. If the request was waiting on this visit (status visit_scheduled), it returns to accepted when a connection already exists, or to submitted otherwise. A visit that is already completed or cancelled is rejected with 400, and a concurrent change to the visit returns 409; requires connections:write.

Parameters

idstring · path · required

ID of the scheduled site visit in the caller's tenant.

Returns

200 Cancelled visit

Show attributes
idstring · required
tenant_idstring · required
request_idstring · required
statusstring · required

one of scheduled, completed, cancelled

visit_datestring (date) · required
booked_bystring · required

one of consumer, staff

notesstring · optional
outcomestring · optional
quote_idstring · optional
completed_atstring (date-time) · optional
cancelled_atstring (date-time) · optional
created_atstring (date-time) · required
updated_atstring (date-time) · required

Errors 400 · 403 · 404

Permissions connections:write · Roles: admin, operations, owner

curl -X POST "$BUSINESS_API/site-visits/{id}/cancel" \
  -H "Authorization: Bearer sk_test_..."
Response 200
{
  "id": "sit_2ljUKXviQDVcG3dOWH1ysvVGYfL",
  "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
  "request_id": "req_2JrY4JziCp1C0bFCSLb4M37qGNH",
  "status": "scheduled",
  "visit_date": "2026-11-19",
  "booked_by": "consumer",
  "notes": "Leitura confirmada no local.",
  "outcome": "outcome",
  "quote_id": "quo_26mh1wUlhIGz1c4BTWQl9M2dDyI",
  "completed_at": "2026-11-19T09:30:00Z",
  "cancelled_at": "2026-11-19T09:30:00Z",
  "created_at": "2026-11-19T09:30:00Z",
  "updated_at": "2026-11-19T09:30:00Z"
}