API Reference

Adds a quote and records the agent's instruction of it in one call

post
https://api.loop.software/v2/lettings/maintenance-jobs//instruct

Scope: write:maintenance

The usual case for a partner: the agent has agreed a contractor's quote, and it's recorded
with the instruction. Takes the quote's fields (as POST …/{id}/quotes) and the
instruction's (dateScheduled, paymentSource), and does what instructing does.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required

Maintenance job id

Body Params

The quote and the instruction

Add a quote and instruct it in one call: the quote's fields and the instruction's.

int64
required

The contractor: an address book entry of the job's agency.

double
required
≥ 0.01

The contractor's price, net of VAT.

string
enum
Allowed:
string | null

Free text. There are no line items: the breakdown goes on the quote document.

date-time | null
string
enum
Allowed:
double | null
0 to 100

For a percentage fee: 10 is 10%.

double | null
≥ 0

For a fixed fee, in pounds, net of VAT.

string
enum
Allowed:
uuid | null

Recorded as the agent who added it. Default the team's first agent.

date-time
required
string
enum
required
Allowed:
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

403

The API key doesn't have the scope this endpoint needs.

Updated 16 days ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json
*/*

Updated 16 days ago

Did this page help you?