RErev-io
Files

View file

Changed on

Find a single file by ID.

get/v1/Files/{id}

Request

Path parameters

idinteger required

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' | 'ORDER_ATTACHMENT' | '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.

custom_upload_typestring

Custom upload type description of the file; sets internally only.

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.

task_idinteger

Foreign identifier indicating an association with a task.

ticket_idinteger

Foreign identifier indicating an association with a ticket.

show_in_customer_profileboolean

This field may indicate if this file is visible at three sites:

  1. Billing Application (Customer Profile > Attachments Tab):

    • Only determines visibility of file if using universal visibility controls for attachments and the attachment is from a Task, Ticket, Request, or Order. If not using those controls, all files are shown regardless of value of show_in_customer_profile.

  2. Customer Portal (Downloads Tab):

    • Determines visibility of all files if show_in_customer_portal is also True unless it is a report file, which is visible in the customer portal regardless of the value of show_in_customer_profile

  3. Agent Portal (Attachments Tab):

    • Determines visibility if using universal visibility controls for attachments and show_in_agent_portal is also True.
show_in_customer_portalboolean

Indicates whether the file is visible in the customer portal.

show_in_agent_portalboolean

Indicates whether the file is visible in the agent portal.

Changes

  • f175f5a3b11dRevision changes
    • breaking

      removed the media type application/json for the response with the status

    • breaking

      removed the media type text/html for the response with the status

    • breaking

      removed the media type text/json for the response with the status

    • warning

      added the new ORDER_ATTACHMENT enum value to the response property for the response status (media type: application/json)

    • warning

      added the new ORDER_ATTACHMENT enum value to the response property for the response status (media type: text/json)

    • warning

      added the new ORDER_ATTACHMENT enum value to the response property for the response status (media type: text/html)

    • info

      api operation id GETv1_Files_id-include_file_image-include_file_image removed and replaced with GETv1_Files_id?include_file_image=include_file_image

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: text/json)

    • info

      added the optional property to the response with the status (media type: text/html)

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: text/json)

    • info

      added the optional property to the response with the status (media type: text/html)

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: text/json)

    • info

      added the optional property to the response with the status (media type: text/html)

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: text/json)

    • info

      added the optional property to the response with the status (media type: text/html)

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: text/json)

    • info

      added the optional property to the response with the status (media type: text/html)

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: text/json)

    • info

      added the optional property to the response with the status (media type: text/html)