Sign in
payments

Submit Purchase Order

Submit a Purchase Order for an approved project.

The quote must be approved and human-reviewed before a PO can be submitted.

If tax_calculation_id is provided (from a prior calculate-tax call), the tax amounts are stored on the Payment record and will be used when the admin marks the PO as received to create a Stripe Tax Transaction.

post/api/v1/payments/purchase-order

Request body

project_idstring uuid required
po_numberstring required
po_document_r2_keystring nullable
shipping_addressstring nullable
shipping_address_idstring uuid nullable
tax_calculation_idstring nullable
tax_amountinteger nullable

Response

Successful Response

idstring uuid required
project_idstring uuid required
quote_idstring uuid required
methodstring required
statusstring required
amountstring required
deposit_amountstring nullable
currencystring required
po_numberstring nullable
shipping_addressstring nullable
tax_amountinteger nullable
total_with_taxstring nullable
notesstring nullable
paid_atstring date-time nullable
created_atstring date-time required
updated_atstring date-time required
submitted_by_admin_idstring uuid nullable
submitted_by_labelstring nullable

Changes

No recorded changes to this endpoint across all 1 revision of this API.