Domain Model
Purchase Order
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 |
| vendorId | unknown | No | — | ID of the associated vendor |
| customerId | unknown | No | — | ID of the associated customer |
| poNumber | string | Yes | — | Po number |
| projectId | string | No | — | ID of the associated project |
| workOrderId | string | No | — | ID of the associated work order |
| status | enum(draft, pending_approval, submitted, payment_due, paid, acknowledged, partially_received, received, canceled, in_fulfillment, invoiced, closed) | Yes | — | Status |
| orderDate | string.date-time | No | — | Order date |
| expectedDeliveryDate | string.date-time | No | — | Expected delivery date |
| subtotal | unknown | No | — | Subtotal |
| taxAmount | unknown | No | — | Tax amount |
| totalAmount | unknown | No | — | Total amount |
| shippingAddress | string | No | — | Shipping address |
| notes | string | No | — | Notes |
| poType | enum(standard, blanket, drop_ship, stock, subcontract) | Yes | "standard" | Po type |
| submittedByUserId | unknown | No | — | ID of the associated submitted by user |
| approvedByUserId | unknown | No | — | ID of the associated approved by user |
| approvedAt | unknown | No | — | Approved at |
| rejectedReason | unknown | No | — | Rejected reason |
| actualDeliveryDate | unknown | No | — | Actual delivery date |
| trackingNumber | unknown | No | — | Tracking number |
| shippingMethod | unknown | No | — | Shipping method |
| shippingCost | unknown | No | — | Shipping cost |
| internalNotes | string,null | No | — | Internal notes |
| vendorAckAt | unknown | No | — | Vendor ack at |
| warehouseId | unknown | No | — | ID of the associated warehouse |
| packingSlipS3Key | unknown | No | — | Packing slip s3key |
| relatedQuoteS3Key | unknown | No | — | Related quote s3key |
| relatedQuoteFileName | unknown | No | — | Related quote file name |
| relatedQuoteNumber | unknown | No | — | Related quote number |
| sourceQuoteId | unknown | Yes | — | ID of the associated source quote |
| direction | enum(outbound, inbound) | Yes | — | Direction |
| sourceVendorQuoteId | unknown | Yes | — | ID of the associated source vendor quote |
| workspaceId | string | Yes | — | ID of the associated workspace |
| visibilityMode | unknown | Yes | — | Visibility mode |
Create Schema
Fields accepted when creating a new record:
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| vendorId | unknown | No | — | ID of the associated vendor |
| poNumber | string | Yes | — | Po number |
| projectId | unknown | No | — | ID of the associated project |
| customerId | unknown | No | — | ID of the associated customer |
| workOrderId | unknown | No | — | ID of the associated work order |
| status | enum(draft, pending_approval, submitted, payment_due, paid, acknowledged, partially_received, received, canceled, in_fulfillment, invoiced, closed) | Yes | "draft" | Status |
| orderDate | unknown | No | — | Order date |
| expectedDeliveryDate | unknown | No | — | Expected delivery date |
| subtotal | unknown | No | — | Subtotal |
| taxAmount | unknown | No | — | Tax amount |
| totalAmount | unknown | No | — | Total amount |
| shippingAddress | unknown | No | — | Shipping address |
| notes | unknown | No | — | Notes |
| poType | enum(standard, blanket, drop_ship, stock, subcontract) | Yes | "standard" | Po type |
| submittedByUserId | unknown | No | — | ID of the associated submitted by user |
| approvedByUserId | unknown | No | — | ID of the associated approved by user |
| approvedAt | unknown | No | — | Approved at |
| rejectedReason | unknown | No | — | Rejected reason |
| actualDeliveryDate | unknown | No | — | Actual delivery date |
| trackingNumber | unknown | No | — | Tracking number |
| shippingMethod | unknown | No | — | Shipping method |
| shippingCost | unknown | No | — | Shipping cost |
| internalNotes | string,null | No | — | Internal notes |
| vendorAckAt | unknown | No | — | Vendor ack at |
| warehouseId | unknown | No | — | ID of the associated warehouse |
| packingSlipS3Key | unknown | No | — | Packing slip s3key |
| relatedQuoteS3Key | unknown | No | — | Related quote s3key |
| relatedQuoteFileName | unknown | No | — | Related quote file name |
| relatedQuoteNumber | unknown | No | — | Related quote number |
| sourceQuoteId | unknown | No | — | ID of the associated source quote |
| direction | enum(outbound, inbound) | Yes | "outbound" | Direction |
| sourceVendorQuoteId | unknown | No | — | ID of the associated source vendor quote |
| workspaceId | string | No | — | ID of the associated workspace |
| visibilityMode | unknown | No | — | Visibility mode |
Update Schema
All fields are optional when updating:
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| vendorId | unknown | No | — | ID of the associated vendor |
| projectId | unknown | No | — | ID of the associated project |
| customerId | unknown | No | — | ID of the associated customer |
| workOrderId | unknown | No | — | ID of the associated work order |
| orderDate | unknown | No | — | Order date |
| expectedDeliveryDate | unknown | No | — | Expected delivery date |
| subtotal | unknown | No | — | Subtotal |
| taxAmount | unknown | No | — | Tax amount |
| totalAmount | unknown | No | — | Total amount |
| shippingAddress | unknown | No | — | Shipping address |
| notes | unknown | No | — | Notes |
| poType | enum(standard, blanket, drop_ship, stock, subcontract) | No | — | Po type |
| trackingNumber | unknown | No | — | Tracking number |
| shippingMethod | unknown | No | — | Shipping method |
| shippingCost | unknown | No | — | Shipping cost |
| internalNotes | string,null | No | — | Internal notes |
| warehouseId | unknown | No | — | ID of the associated warehouse |
| relatedQuoteNumber | unknown | No | — | Related quote number |
| sourceQuoteId | unknown | No | — | ID of the associated source quote |
| sourceVendorQuoteId | unknown | No | — | ID of the associated source vendor quote |