Skip to content

File ​

Upload files (base64) and attach/detach them to records

INFO

Har bir javob umumiy konvertda qaytadi — code, message, messages, status_code, time — foydali yuk esa data ichida. Quyidagi jadvallar faqat data ichini tavsiflaydi.

POST /file/upload ​

Upload a file as base64. Stores it in object storage and returns the storage key (a string in data). Use that key as the file field (e.g. path, image) when creating/updating a record, or pass it to /file/attach. base64-only — no remote URL fetching (no SSRF).

So‘rov tanasi

MaydonTurMajburiyTavsif
filenamestringHaOriginal file name including extension. The extension is used to derive the storage key and (if mimetype is omitted) the content type.
content_base64stringHaFile bytes encoded as base64 (no data: URI prefix). Max ~20MB after decoding. base64-only by design — the API never fetches a remote URL, so there is no SSRF surface.
mimetypestringYo‘qOptional MIME type. If omitted it is inferred from the filename extension, falling back to application/octet-stream.
json
{
  "filename": "receipt.pdf",
  "content_base64": "JVBERi0xLjQKJeLjz9MK...",
  "mimetype": "application/pdf"
}

Javob

json
{
  "code": 0,
  "message": "Success",
  "status_code": 200,
  "data": "/uploads/665f.../integration/file-abc123.pdf",
  "time": "2025-05-01T12:00:00Z"
}

POST /file/attach ​

Attach an already-uploaded file (its storage key) to an existing record. Body: path (the key) plus exactly one entity FK id (e.g. transaction_id, invoice_id). The referenced record must exist and the file must already be uploaded.

So‘rov tanasi

MaydonTurMajburiyTavsif
pathstringHaStorage key returned by /file/upload.
typestringYo‘qOptional. Inferred from the file extension when omitted.. Mumkin qiymatlar: image, video, audio, file
namestringYo‘qOptional display name.
notestringYo‘qOptional note.
transaction_idstringYo‘qAttach to a finance transaction.
invoice_idstringYo‘qAttach to an invoice.
category_idstringYo‘qAttach to a product category.
task_idstringYo‘qAttach to a task.
purchase_idstringYo‘qAttach to a purchase.
supplier_idstringYo‘qAttach to a supplier.
json
{
  "path": "/uploads/665f.../integration/file-abc123.pdf",
  "type": "image",
  "name": "string",
  "note": "string",
  "transaction_id": "string",
  "invoice_id": "string",
  "category_id": "string",
  "task_id": "string",
  "purchase_id": "string",
  "supplier_id": "string"
}

Javob

MaydonTurTavsif
_idstring
pathstring
typestring
sizenumber
json
{
  "code": 0,
  "message": "Success",
  "status_code": 200,
  "data": {
    "_id": "string",
    "path": "string",
    "type": "string",
    "size": 0
  },
  "time": "2025-05-01T12:00:00Z"
}

DELETE /file/attach/{id} ​

Soft-delete an attachment by its ObjectId (detach a file from a record). Returns the deleted attachment id.

Yo‘l parametrlari

ParametrTurMajburiyTavsif
idstringHaAttachment ObjectId to detach

So‘rov tanasi

So‘rov tanasi talab qilinmaydi.

Javob

json
{
  "code": 0,
  "message": "Success",
  "status_code": 200,
  "data": "string",
  "time": "2025-05-01T12:00:00Z"
}

Bu sahifa OpenAPI spetsifikatsiyasidan yaratilgan.

Bito 2.0 Integration API