Skip to content

API reference · Schema

V1ImportsFormatProposeRequest

V1ImportsFormatProposeRequestcontract v1.imports.format.propose.request

document_idUuid7required
kindenum (9)required
payout_statementbank_statementpos_exporttally_exportmarket_signalpos_billswaste_logshift_logstock_count
namestringrequired
min length 1max length 100
mappingarray of objectrequired
min items 1max items 100
- sourcestringrequired
  min length 1max length 100
- targetstringrequired
  pattern ^[a-z][a-z0-9_]*$
- unitstringoptional
  pattern ^[a-z][a-z0-9_]{0,15}$

Used by

post/v1/imports/formats:proposePropose a column mapping (renames + units only) for a document's layout, as a draft to approve