メインコンテンツまでスキップ

ドキュメントのアップロード (Upload Document)

POST/apiv2/pub/documents/uploaddocuments_write

1 回のリクエストで、新しいドキュメントレコードの作成とファイルのアップロードを行います。ドキュメントは指定したフォルダに配置され、トークンのユーザーが所属するグループに割り当てられます。

リクエスト​

Content-Type: multipart/form-data

フォームフィールド​

フィールド型必須説明
filebinary必須アップロードするファイルです。任意のファイル形式を使用できます。
folder_idinteger必須ドキュメントを配置するフォルダです。ID の確認にはList Foldersを使用してください。
descriptionstring任意ドキュメントのタイトルです。ダウンロード時の既定のファイル名としても使用されます。既定値はアップロードされたファイル名です。最大 400 文字。
doc_typestring任意ドキュメントの種類です（例："Invoice"、"Report"）。既存の種類と一致している必要があります。最大 60 文字。
doc_statusstring任意初期ステータスです（例："Draft"、"Final"）。最大 50 文字。
account_numberstring任意アカウントまたはプロジェクト番号です。最大 255 文字。
reference_numberstring任意参照識別子です — 外部または内部で生成されます。最大 255 文字。
datestring任意ISO 8601 形式のドキュメント日付です（例："2025-01-15"）。アップロード日ではなく、業務上の日付です。
from_entitystring任意送信元組織の名前です。最大 255 文字。
to_entitystring任意受信先組織の名前です。最大 255 文字。
rev_numberstring任意改訂識別子です（例："A"、"01"）。最大 10 文字。
privilegedboolean任意メタデータフラグです。情報提供のみを目的とし、アクセス制御には影響しません。
doc_number_prefixstring任意指定すると、このプレフィックスを使用して連番のドキュメント番号を生成します（例："INV" → "INV-00042"）。

レスポンス​

200 OK
フィールド型説明
doc_idinteger作成されたドキュメントの一意の ID です。以降のすべての呼び出しで使用します。
linked_file_idinteger作成されたファイルレコードの ID です。
image_namestringシステムが生成したストレージ上のファイル名です。
descriptionstring保存されたドキュメントの説明です。
doc_numberstring or null自動生成されたドキュメント番号です（doc_number_prefix を指定した場合）。

エラー​

ステータス理由
400file または folder_id が指定されていません
401トークンが無効または期限切れです
403トークンに documents_write スコープがありません
404フォルダが見つからないか、アクセスできません

cURL​

curl -X POST "https://portal.docwize.com/apiv2/pub/documents/upload" \
     -H "Authorization: Bearer <ACCESS_TOKEN>" \
     -F "file=@invoice.pdf" \
     -F "folder_id=42" \
     -F "description=January Invoice" \
     -F "doc_type=Invoice"
{
  "doc_id": 1542,
  "linked_file_id": 3801,
  "image_name": "1542_a7f2c.pdf",
  "description": "January Invoice",
  "doc_number": "INV-00042"
}
{"detail": "Missing required field: folder_id"}
{"detail": "Invalid or expired token"}