Supported operations
| Method | Path | Description |
|---|---|---|
| GET | /api/v1/invoices | List all invoices |
| GET | /api/v1/invoices/:id | Get a invoice by ID |
| POST | /api/v1/invoices | Create a new invoice |
| PATCH | /api/v1/invoices/:id | Update a invoice |
| DELETE | /api/v1/invoices/:id | Delete a invoice |
Example request
Replace YOUR_API_KEY with a private key stored in your environment. Replace path parameters with records from your organization.
curl --request GET "/api/v1/invoices" \
--header "Authorization: Bearer YOUR_API_KEY" \
--header "Accept: application/json"Field reference
Required means required by the underlying data model, not necessarily caller-supplied. The server derives protected identity and ownership fields; endpoint validation controls which fields are accepted. Sensitive credential fields are omitted here.
| Field | Type | Model requirement | Description |
|---|---|---|---|
id | string | Optional | Unique identifier (auto-generated) |
bidId | uuid | Required | bid Id Related resource: |
siteId | uuid | Required | site Id Related resource: |
lineItemId | uuid | Optional | line Item Id |
paymentScheduleId | uuid | Optional | payment Schedule Id |
invoiceNumber | string | Optional | invoice Number |
amount | string | Required | amount |
issueDate | string | Required | issue Date |
dueDate | string | Optional | due Date |
paidDate | string | Optional | paid Date |
status | enum | Optional | status Values: |
filePath | string | Optional | file Path |
fileName | string | Optional | file Name |
fileSize | number | Optional | file Size |
fileType | string | Optional | file Type |
notes | string | Optional | notes |
createdAt | datetime | Optional | Creation timestamp (auto) |
updatedAt | datetime | Optional | Last update timestamp (auto) |