Sign in

v1

latestOpenAPI 3.0.12026-07-24310590875.6 KB
documents

Upload bill document

Upload a document for an existing bill. The file size limit is 6 MB. When you upload a bill document, the uploaded document is available on the bill details page in the BILL web app.

In the response, the name, createdTime, and downloadLink is available when the upload is complete.

When you upload a document, it takes a few minutes for BILL to complete the upload process.

  • Upload in-progress: A temporary BILL-generated ID is available for the document when the upload is in progress. The value begins with 0du. You can get the document upload status with GET /v3/documents/upload-status.
  • Upload complete: A BILL-generated ID is available for the document when the upload is complete. The value begins with 00h. You can get details about the uploaded document with GET /v3/documents/bills/{billId}.

See Documents and attachments in the Guides section for more information, sample requests, and responses.

post/v3/documents/bills/{billId}

Path parameters

billIdstring required

BILL-generated ID of the bill. The value begins with 00n.

Example:{{bill_id}}

Query parameters

namestring required

File name with extension. For example, to upload a PDF document titled business_details, set name as business_details.pdf.

Example:business_details.pdf

Headers

sessionIdstring nullable

API session ID generated with /v3/login

Example:{{session_id}}
devKeystring nullable

Developer key generated with your BILL developer account

Example:{{developer_key}}

Response

Upload bill document response

uploadIdstring

BILL-generated ID of the upload. This is a temporary BILL-generated ID for the document when the upload is in progress. The value begins with 0du.

When the upload is complete, a new BILL-generated ID is available for the document. The value begins with 00h. You can get the document upload status with GET /v3/documents/upload-status.