Skip to main content
GET
Get contractor invoice

Authorizations

x-api-key
string
header
required

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

Path Parameters

id
string
required

Response

Success

id
string
required
subjectKind
string
required
subjectId
string
required
subjectLabel
string | null
required
propertyId
string
required
propertyLabel
string | null
required
tenancyId
string | null
required
contractorContactId
string | null
required
contractorName
string | null
required
number
string
required
issuedOn
string
required
dueOn
string | null
required
currency
string
required
netMinor
required
vatMinor
required
grossMinor
required
borneBy
enum<string>
required
Available options:
landlord,
tenant,
agency
documentId
string | null
required
status
enum<string>
required
Available options:
received,
approved,
part_paid,
paid,
disputed,
credited,
void
approvedAt
string | null
required
creditedMinor
required
paidMinor
required
outstandingMinor
required
disputedMinor
required
payableMinor
required
recoveredMinor
required
recoverableMinor
required
disputeReason
string | null
required
disputedAt
string | null
required
voidedAt
string | null
required
voidReason
string | null
required
legacy
boolean
required
legacyStatus
string | null
required
legacySettled
boolean
required
revision
required
createdAt
string
required
lines
object[]
required
payments
object[]
required
creditNotes
object[]
required
recoveries
object[]
required
authorisation
object
required
limitOverride
object | null
required