Skip to main content
POST
Start invoice intake

Authorizations

x-api-key
string
header
required

A workspace API key (Settings → API keys), scoped to <group>:read / <group>:write.

Body

application/json
requestId
string
required
contractorContactId
string
required
description
string
required
number
string · null · null

Response

Success

state
enum<string>
required
Available options:
not_included,
off,
unsupported,
not_requested,
pending,
ready,
unavailable,
no_text
note
string | null
required
id
string | null
required
kind
enum<string>
required
Available options:
contractor-suitability,
inspection-follow-up,
invoice-check,
invoice-intake
subjectKind
string
required
subjectId
string
required
result
object | null
required
reviews
object[]
required
partCount
required
failedParts
required
retrying
boolean
required
canRetry
boolean
required
createdAt
string | null
required
updatedAt
string | null
required