Skip to content

What an incomplete work report needs to finish it

GET
/asset-exceptions/work-reports/{id}
curl --request GET \
--url https://example.com/asset-exceptions/work-reports/019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f \
--cookie __Host-bottle.session_token=<__Host-bottle.session_token>

The rows with their job type and answers, the business’s job types and checks, the purchase order number and which signatures the business requires that the report has not got. A report missing a required signature can only be closed without sending.

id
required

UUID v7

string format: uuid

Example

019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f

UUID v7

The report to finish

Media typeapplication/json
object
id
required

UUID v7

string format: uuid
customerName
required
string | null
driverName
required
string | null
recordedAt
required
string format: date-time
missing
required
Array<object>
object
code
required
string
Allowed values: notRecorded cylinder jobType checkUnknown check problemNote image customerSignature customerName driverSignature purchaseOrder contact cylinderDetails
cylinder
string | null
check
string | null
image
string | null
Allowed values: customerSignature driverSignature photo
rows
required
Array<object>
object
row
required
integer
side
required
string
Allowed values: delivered collected
productName
required
string
serial
required
string | null
quantity
required
integer
> 0
jobType
required
object
id
required

UUID v7

string format: uuid
name
required
string
takesChecks
required
boolean
answers
required
Array<object>
object
checkId
required

UUID v7

string format: uuid
answer
required
string
Allowed values: ok problem
note
required
string | null
jobTypes
required
Array<object>
object
id
required

UUID v7

string format: uuid
name
required
string
rule
required
string
checks
required
Array<object>
object
id
required

UUID v7

string format: uuid
name
required
string
required
required
boolean
allChecksRequired
required
boolean
purchaseOrder
required
string | null
purchaseOrderRequired
required
boolean
signaturesNeeded
required
Array<string>
Allowed values: customer driver
sendsWithoutSignature
required
boolean

Example

{
"id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
"missing": [
{
"code": "notRecorded",
"image": "customerSignature"
}
],
"rows": [
{
"side": "delivered",
"jobType": {
"id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
},
"answers": [
{
"checkId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
"answer": "ok"
}
]
}
],
"jobTypes": [
{
"id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
}
],
"checks": [
{
"id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
}
],
"signaturesNeeded": [
"customer"
]
}

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string

Example

{
"error": "not_found",
"message": "Customer not found"
}

Not an owner or admin, missing scope, or the plan does not open Assets

Media typeapplication/json
object
error
required
string
message
required
string

Example

{
"error": "not_found",
"message": "Customer not found"
}

Not found, already dealt with, or another business’s

Media typeapplication/json
object
error
required
string
message
required
string

Example

{
"error": "not_found",
"message": "Customer not found"
}

Assets is switched off, the item changed meanwhile, or a work report needs a signature the office cannot add

Media typeapplication/json
object
error
required
string
message
required
string

Example

{
"error": "not_found",
"message": "Customer not found"
}

Validation failed

Media typeapplication/json
object
error
required
string
Allowed values: validation
message
required
string
issues
required
Array<object>
object
path
required
string
message
required
string

Example

{
"error": "validation",
"issues": [
{
"path": "email",
"message": "Invalid email"
}
]
}