BIbill
documents

Get document details

Changed on

Get details about a document associated with a bill.

From the response, use downloadLink in a GET request to download the document.

curl '{downloadLink}' --header 'sessionId: {session_id}' --output {document_name}
get/v3/documents/{documentId}

Request

  • Base URL
    https://gateway.stage.bill.com/connect
  • URL
    https://gateway.stage.bill.com/connect/v3/documents/{documentId}
  • Auth
    none declared

Path parameters

documentIdstring required

BILL-generated ID of the document. The value begins with 0du or 00h.

Example:{{document_id}}

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

Get document details response

idstring

BILL-generated ID of the document.

  • A temporary BILL-generated ID is available for the document when the upload is in progress. The value begins with 0du.
  • A BILL-generated ID is available for the document when the upload is complete. The value begins with 00h.
namestring

Document name

createdTimestring date-time

Created date and time

downloadLinkstring

URL for downloading the document. Use the URL in a GET request to download the document.

numOfPagesinteger

Number of pages in the document

scanStatus'NOT_SCANNED' | 'CLEAN' | 'INFECTED' | 'IN_QUEUE' | 'REJECTED' | 'UNDEFINED'

Document scan status

Changes