Documents

Update a document

patch/companies/{companyId}/documents/{id}

Request

  • Base URL: https://api.medianfi.com/api/v1
  • URL: https://api.medianfi.com/api/v1/companies/{companyId}/documents/{id}
  • Auth: HTTP bearer

Request body

type'invoice' | 'bill' | 'receipt' | 'contract' | 'statement'
status'needs_review' | 'reviewed' | 'processed' | 'archived'
namestring
vendorNamestring nullable
customerNamestring nullable
invoiceNumberstring nullable
amountCentsinteger nullable
currencystring nullable

Must be supplied atomically with amountCents; non-null values are normalized to uppercase and restricted to registered scale-two ISO 4217 currencies.

categoryGlAccountIdstring nullable
dueDatestring nullable
fileKeystring nullable

null detaches the file. A string must reference an accepted stored file of the same company (a clean file, or the file the upload flow stored for it); any other key, including a quarantine key, is rejected with 422.

fileUrlstring nullable
sizeBytesinteger nullable
fileNamestring nullable
mimeTypestring nullable
transactionIdstring nullable
categorystring nullable
docDatestring nullable
notesstring nullable
metadataobject

Response

Document updated

successboolean required

Changes

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