vendor-document-upload

Non-Negotiables

• Never attach a document to a vendor_uuid unless the user has confirmed the vendor and document category.
• If the vendor identity is uncertain, omit --vendor_uuid and let Ramp's matching/triage flow handle it.
• Always run -n/--dry_run before uploading when using a known vendor_uuid.
• Vendor document file contents must be base64-encoded.
• CLI request flags use snake_case, for example --document_category and --file_content_base64.
• Prefer --agent when checking bulk status so counts and per-document fields are easy to parse reliably.

Workflow

Mode 1: Attach one document to a known vendor

Use this when the user gives both a file path and the target vendor UUID.

# Base64 encode the file
base64 -i /path/to/acme-w9.pdf | tr -d '\n'

# Dry run first
ramp vendors attach-document \
  --vendor_uuid "vnd_123" \
  --filename "acme-w9.pdf" \
  --content_type "application/pdf" \
  --file_content_base64 "{base64_string}" \
  --document_category W9 \
  --dry_run

# If the request body is correct, upload for real
ramp vendors attach-document \
  --vendor_uuid "vnd_123" \
  --filename "acme-w9.pdf" \
  --content_type "application/pdf" \
  --file_content_base64 "{base64_string}" \
  --document_category W9

The upload response includes:

• document_uuid
• vendor_uuid
• document_category
• original_filename
• document_url (temporary download URL, when available)

Mode 2: Upload one document into vendor matching/triage

Use this when the user has a file but not a trustworthy vendor UUID yet.

ramp vendors attach-document \
  --filename "acme-contract.pdf" \
  --content_type "application/pdf" \
  --file_content_base64 "{base64_string}" \
  --document_category VENDOR_CONTRACT

If vendor_uuid is omitted in the response, tell the user the document was uploaded into the matching flow and may need review in Ramp.

Mode 3: Bulk upload many vendor documents

documents is a complex array, so use --json for the request body.