ZRM Docs
Domain Model

Purchase Order

Fields

FieldTypeRequiredDefaultDescription
idstring.uuidYesId
createdAtstring.date-timeYesCreated at
updatedAtstring.date-timeYesUpdated at
vendorIdstringYesID of the associated vendor
poNumberstringYesPo number
projectIdstringNoID of the associated project
workOrderIdstringNoID of the associated work order
statusenum(draft, pending_approval, submitted, acknowledged, partially_received, received, canceled)YesStatus
orderDatestring.date-timeNoOrder date
expectedDeliveryDatestring.date-timeNoExpected delivery date
subtotalunknownNoSubtotal
taxAmountunknownNoTax amount
totalAmountunknownNoTotal amount
shippingAddressstringNoShipping address
notesstringNoNotes
poTypeenum(standard, blanket, drop_ship, stock)Yes"standard"Po type
submittedByUserIdunknownNoID of the associated submitted by user
approvedByUserIdunknownNoID of the associated approved by user
approvedAtunknownNoApproved at
rejectedReasonunknownNoRejected reason
actualDeliveryDateunknownNoActual delivery date
trackingNumberunknownNoTracking number
shippingMethodunknownNoShipping method
shippingCostunknownNoShipping cost
internalNotesunknownNoInternal notes
vendorAckAtunknownNoVendor ack at
warehouseIdunknownNoID of the associated warehouse
packingSlipS3KeyunknownNoPacking slip s3key
sourceQuoteIdunknownYesID of the associated source quote
workspaceIdstringYesID of the associated workspace
visibilityModeenum(global, workspace_local, shared)YesVisibility mode

Create Schema

Fields accepted when creating a new record:

FieldTypeRequiredDefaultDescription
vendorIdstringYesID of the associated vendor
poNumberstringYesPo number
projectIdstringNoID of the associated project
workOrderIdstringNoID of the associated work order
statusenum(draft, pending_approval, submitted, acknowledged, partially_received, received, canceled)Yes"draft"Status
orderDatestring.date-timeNoOrder date
expectedDeliveryDatestring.date-timeNoExpected delivery date
subtotalunknownNoSubtotal
taxAmountunknownNoTax amount
totalAmountunknownNoTotal amount
shippingAddressstringNoShipping address
notesstringNoNotes
poTypeenum(standard, blanket, drop_ship, stock)Yes"standard"Po type
submittedByUserIdunknownNoID of the associated submitted by user
approvedByUserIdunknownNoID of the associated approved by user
approvedAtunknownNoApproved at
rejectedReasonunknownNoRejected reason
actualDeliveryDateunknownNoActual delivery date
trackingNumberunknownNoTracking number
shippingMethodunknownNoShipping method
shippingCostunknownNoShipping cost
internalNotesunknownNoInternal notes
vendorAckAtunknownNoVendor ack at
warehouseIdunknownNoID of the associated warehouse
packingSlipS3KeyunknownNoPacking slip s3key
sourceQuoteIdunknownNoID of the associated source quote
workspaceIdstringNoID of the associated workspace
visibilityModeenum(global, workspace_local, shared)Yes"workspace_local"Visibility mode

Update Schema

All fields are optional when updating:

FieldTypeRequiredDefaultDescription
vendorIdstringNoID of the associated vendor
projectIdstringNoID of the associated project
workOrderIdstringNoID of the associated work order
orderDatestring.date-timeNoOrder date
expectedDeliveryDatestring.date-timeNoExpected delivery date
subtotalunknownNoSubtotal
taxAmountunknownNoTax amount
totalAmountunknownNoTotal amount
shippingAddressstringNoShipping address
notesstringNoNotes
poTypeenum(standard, blanket, drop_ship, stock)No"standard"Po type
trackingNumberunknownNoTracking number
shippingMethodunknownNoShipping method
shippingCostunknownNoShipping cost
internalNotesunknownNoInternal notes
warehouseIdunknownNoID of the associated warehouse
sourceQuoteIdunknownNoID of the associated source quote

On this page