Documents

Upload/create a document

post/companies/{companyId}/documents

Request

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

Request body

entityIdstring uuid

Concrete legal entity selected from the authenticated actor's authorized entity scope. Omit only for restricted, non-financial intake that must be assigned by an administrator.

type'invoice' | 'bill' | 'receipt' | 'contract' | 'statement' required
namestring required
vendorNamestring
customerNamestring
invoiceNumberstring
amountCentsinteger
currencystring

Required with amountCents; accepted case-insensitively, normalized to uppercase, and restricted to registered scale-two ISO 4217 currencies.

categoryGlAccountIdstring uuid
dueDatestring date
fileKeystring

Optional. 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
sizeBytesinteger
fileNamestring
mimeTypestring
transactionIdstring uuid
categorystring
docDatestring date
notesstring
metadataobject

Response

Document created

successboolean required

Changes

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