Sign in
Files

View file

Find a single file by ID.

get/v1/Files/{id}

Path parameters

idinteger required

Format - int32. ID of the bill to download.

Query parameters

include_file_imageboolean

Indicates you wish to include the file's binary data in the response.

Response

OK

okboolean
file_idinteger

Primary identifier for this file.

file_imagestring byte

Binary file data represented as a Base64-encoded string. NOTE: By default, this will be blank or null. You must indicate when to include it with an optional parameter when getting a single file.

file_namestring

The name of the file, including extension.

file_type'NOT_SPECIFIED' | 'AGENT_ATTACHMENT' | 'AGENT_BATCH' | 'AGENT_CUSTOMER_SUMMARY' | 'AGENT_RECEIPT' | 'AGENT_REPORT_COMMISSION_SUMMARY' | 'AGENT_STATEMENT' | 'AGENT_STATEMENT_PRINT_SUMMARY' | 'CASH_DRAWER_CLOSING_REPORT' | 'CDR_EXPORT' | 'COLLECTION_EMAIL' | 'COLLECTION_LETTER' | 'TAX_COMPARISON_BATCH' | 'CUSTOM_E911_BATCH' | 'CUSTOMER_ACCOUNT_ATTACHMENT' | 'CUSTOMER_STATEMENT' | 'CUSTOMER_EDI_BILL' | 'CUSTOMER_RECEIPT' | 'DATA_BACKUP' | 'DISCONNECT_NOTICE' | 'DOCUMENT' | 'EXTERNAL_ORDER' | 'FAX' | 'FILE_MANAGER' | 'INVENTORY_ATTACHMENT' | 'LIFELINE_OTHER' | 'LIFELINE_PROOF_DOCUMENTATION' | 'LIFELINE_SELF_CERTIFICATION' | 'LINE_FIELD_UPDATE_TEMPLATE' | 'REQUEST_ATTACHMENT' | 'REQUEST_TEMPLATE' | 'REQUEST_UPDATE_TEMPLATE' | 'SALES_PORTAL_COVER_LETTER' | 'STATEMENT_BATCH' | 'TASK_ATTACHMENT' | 'TICKET_ATTACHMENT' | 'WORKORDER_CONTRACT' | 'CLIENT_IMAGE' | 'REPORT' | 'EMAIL_TEMPLATE_ATTACHMENT' | 'VENDOR_STATEMENT'

Rev.io-specific type description of the file.

descriptionstring

Free-form text description of the file.

created_datestring date-time

Date and time the file was added to Rev.io.

created_byinteger

Foreign identifier indicating which user added the file to Rev.io.

customer_idinteger

Foreign identifier indicating an association with an account.

order_idinteger

Foreign identifier indicating an association with an order.

request_idinteger

Foreign identifier indicating an association with a request.

Changes

No recorded changes to this endpoint across all 1 revision of this API.