v1

latestOpenAPI 3.0.32026-08-0623677345.2 KB

Procurement

Create purchase (draft)

post/purchases/

Headers

x-simple-workspacestring required

Workspace (account) identifier. Required for every request.

x-piriod-test-modeboolean

Whether to operate against test-mode data. Defaults to false.

Request body

idinteger

supplierstring required

Supplier ID.

documentinteger required

Purchase-document type ID.

numberinteger required

datestring date required

due_datestring date nullable

notestring nullable

amountnumber nullable

exemptnumber nullable

taxnumber nullable

tax_percentnumber nullable

subtotalnumber nullable

totalnumber nullable

total_adjustednumber nullable

retentionnumber nullable

discountnumber nullable

discount_scheme'%' | '$' nullable

tax_settingsobject

Country-specific tax-agency configuration.

status'draft' | 'finalized'

biller_statusstring

tax_agencyobject

local_filestring uri nullable

importedboolean

test_modeboolean

metadataobject

createdstring date-time

updatedstring date-time

Response

Purchase created.