Skip to main content
POST
Add 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

Body

application/json
number
string
required
issuedOn
string
required
borneBy
enum<string>
required
Available options:
landlord,
tenant,
agency
dueOn
string | null
lines
object[] | null
netMinor
integer | null
Required range: -9007199254740991 <= x <= 9007199254740991
vatMinor
integer | null
Required range: -9007199254740991 <= x <= 9007199254740991
grossMinor
integer | null
Required range: -9007199254740991 <= x <= 9007199254740991
currency
string | null
contractorContactId
string | null
documentId
string | null
tenancyId
string | null
chargePropertyId
string | null
paidOn
string | null
paidReference
string | null
overAuthorisedReason
string | null
requestId
string | null

Response

Success

id
string
required
reference
string | null
required
propertyId
string | null
required
blockId
string | null
required
unitId
string | null
required
reporterContactId
string | null
required
reporterCorrection
string | null
required
reporterCorrectedAt
string | null
required
category
string
required
faultNodeId
string | null
required
subcategory
string | null
required
specificFault
string | null
required
faultAnswers
object[] | null
required
trade
string | null
required
description
string
required
urgency
string
required
status
string
required
estimate
object | null
required
spendLimit
object | null
required
finalCost
object | null
required
approval
object | null
required
quotes
object[]
required
invoices
object[]
required
offers
object[]
required
quoteRounds
object[]
required
asks
object[]
required
contractorContactId
string | null
required
scheduledFor
string | null
required
reportedVia
string | null
required
intakeHeldAt
string | null
required
reportedAddress
object | null
required
closedReason
enum<string> | null
required
Available options:
completed,
duplicate,
reported_in_error,
not_managed,
cancelled_by_tenant,
tenant_to_resolve,
landlord_to_resolve,
third_party,
no_access,
no_longer_required,
other
closeNote
string | null
required
closedAt
string | null
required
duplicateOf
object | null
required
duplicates
object[]
required
assetId
string | null
required
asset
object | null
required
createdAt
string
required
property
string
required
reporter
string
required
contractor
string | null
required
contractorWarnings
object[] | null
firstRespondedAt
string · null · null
firstAttendedAt
string · null · null
targets
object | null
lastVisit
object · null · null
partsWait
object · null · null