GET /api/v202105/rate/{rateId}/version/{versionId}/udf/{udfId}/download

Downloads the file attached to a rate version's custom field

DownloadRateCustomFieldFileV202105 Permissions: VendorsAndRatesModule (View)
Use this endpoint to retrieve a file that was previously uploaded to a user-defined field (UDF) on a specific rate version. Returns the file as a binary download with appropriate content type headers.

Request Headers

Header Value Required Description
ECI-ApiKey string Yes Your API key. See Authentication.
Content-Type application/json Yes All requests must specify JSON content type.

Path Parameters

Name Description Type Required
rateId Unique numeric identifier of the parent rate schedule (tariff ID) integer (int32) Required
versionId Unique numeric identifier of the rate version integer (int32) Required
udfId Unique numeric identifier of the user-defined field containing the uploaded file integer (int32) Required

Responses

200 OK The request succeeded and the response body contains the requested data.
404 Not Found The requested resource was not found. Verify the ID or path is correct.