ZRM Docs
Domain Model

Quote Payment

Fields

FieldTypeRequiredDefaultDescription
idstring.uuidYesId
createdAtstring.date-timeYesCreated at
updatedAtstring.date-timeYesUpdated at
quoteIdstringYesID of the associated quote
milestoneIdunknownYesID of the associated milestone
amountnumberYesAmount
surchargeAmountnumberYesSurcharge amount
totalAmountnumberYesTotal amount
paymentMethodenum(credit_card, ach, wire, check)YesPayment method
statusenum(pending, processing, succeeded, failed, refunded)YesStatus
stripePaymentIntentIdunknownYesID of the associated stripe payment intent
stripePaymentMethodTypeunknownYesStripe payment method type
paidAtunknownYesPaid at
failedAtunknownYesFailed at
failureReasonunknownYesFailure reason
notesunknownYesNotes
recordedByUserIdunknownYesID of the associated recorded by user
workspaceIdstringYesID of the associated workspace

Create Schema

Fields accepted when creating a new record:

FieldTypeRequiredDefaultDescription
quoteIdstringYesID of the associated quote
milestoneIdstring.uuidNoID of the associated milestone
amountnumberYesAmount
surchargeAmountnumberYes0Surcharge amount
totalAmountnumberYesTotal amount
paymentMethodenum(credit_card, ach, wire, check)YesPayment method
stripePaymentIntentIdstringNoID of the associated stripe payment intent
stripePaymentMethodTypestringNoStripe payment method type
workspaceIdstringYesID of the associated workspace

On this page