Skip to main content
GET
Get a project prepayment
A prepayment invoiced up front to offset future fees on a project. All prepayments of a given type on a project bill against the same invoice item.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

The project prepayment uuid

Response

200

id
string

The unique identifier for the object.

type
enum<string>

The category of fees this prepayment is applied against.

Available options:
services,
expenses,
products,
other_items
date
string<date>

The date of the prepayment. Will be in the form YYYY-MM-DD.

details
string

A description of the prepayment.

quantity
number | null

The quantity used to calculate the fee. null when the fee was entered directly.

rate
number | null

The rate used to calculate the fee. null when the fee was entered directly.

fee
number

The total prepaid amount available to offset future fees.

createdAt
string<date-time>

The timestamp when the object was created.

project
object

The project this prepayment belongs to.

invoiceItem
object

The invoice item the prepayment is billed and offset against.

amountUsed
number

The portion of the fee already consumed to offset fees on issued invoices. This is a calculated value.

invoiced
boolean

Whether the prepayment has been added to an invoice.

locked
boolean

Whether the prepayment can no longer be modified because it is on an invoice or has been used to offset fees.