Domain Model
Vendor Bill
Fields
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| id | string.uuid | Yes | — | Id |
| createdAt | string.date-time | Yes | — | Created at |
| updatedAt | string.date-time | Yes | — | Updated at |
| purchaseOrderId | string | Yes | — | ID of the associated purchase order |
| billNumber | string,null | Yes | — | Bill number |
| billType | enum(standard, progress, final, retainage_release) | Yes | — | Bill type |
| status | enum(received, paid, void) | Yes | — | Status |
| amount | number | Yes | — | Amount |
| retainageWithheldAmount | number,null | Yes | — | Retainage withheld amount |
| s3Key | string,null | Yes | — | S3key |
| fileName | string,null | Yes | — | File name |
| receivedAt | string.date-time | Yes | — | Received at |
| dueDate | unknown | Yes | — | Due date |
| paidAt | unknown | Yes | — | Paid at |
| paymentAmount | number,null | Yes | — | Payment amount |
| paymentMethod | unknown | Yes | — | Payment method |
| paymentAccountName | string,null | Yes | — | Payment account name |
| paymentReference | string,null | Yes | — | Payment reference |
| paymentNotes | string,null | Yes | — | Payment notes |
| createdByUserId | unknown | Yes | — | ID of the associated created by user |
| workspaceId | string | Yes | — | ID of the associated workspace |
Create Schema
Fields accepted when creating a new record:
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| purchaseOrderId | string | Yes | — | ID of the associated purchase order |
| billNumber | unknown | No | — | Bill number |
| billType | enum(standard, progress, final, retainage_release) | Yes | "standard" | Bill type |
| amount | number | Yes | — | Amount |
| retainageWithheldAmount | unknown | No | — | Retainage withheld amount |
| s3Key | unknown | No | — | S3key |
| fileName | unknown | No | — | File name |
| receivedAt | string.date-time | No | — | Received at |
| dueDate | unknown | No | — | Due date |
Update Schema
All fields are optional when updating:
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| billNumber | unknown | No | — | Bill number |
| billType | enum(standard, progress, final, retainage_release) | No | — | Bill type |
| amount | number | No | — | Amount |
| retainageWithheldAmount | unknown | No | — | Retainage withheld amount |
| dueDate | unknown | No | — | Due date |