FileAttachments

Get the list of files by entity ID

Path

GET /odata/FileAttachments({entityId})

Description

Returns a list of files for the specified entity ID within the logged-in organization. The list will also include linked files for POs, Receipts, Matched Invoices, OCRs, and Received Invoices.

Supported entityIds

The following entityId types are supported, depending on the module:

Module	entityId
Adjustments	adjustmentId
Inventory	inventoryId (for files, not for images)
Contracts	contractId
Purchasing	purchaseOrderId
Receiving	purchaseOrderId
Accounts Payable/Received Invoice	receivedInvoiceId
Accounts Payable/Matched Invoices	purchaseOrderId
Accounts Payable/OCR Invoices	ocrInvoiceId
Requisitioning	requisitionId
Fill Requisitions	requisitionId
Proof of Delivery	fillRequisitionId

If you specify purchaseOrderId, receivedInvoiceId, and ocrInvoiceId, the response will include files directly associated with these IDs, along with additional files linked by PO # and Release # from POs, Received Invoices, Matched Invoices, Receipts, and OCR Invoices.

graph RL
A([OCR Invoice]) <--> B([Received Invoice])
B <--> C([Matched Invoice])
C <--> E([Receipt])
E <--> A
B <--> D([Purchase Order])
B <--> E
D <--> E
D <--> C
A <--> D
A <--> C

Note

Search is not performed by matchedInvoiceId, receiptId, or Transef In adjustmentId.

Note

You can filter the results as follows:

For an exact match, use: $filter parameter–entity eq ‘string’
For a partial match, use: $filter=contains parameter–contains(entity, ‘string’)

Request parameters

Parameter	Explanation
api-version: string in query	The requested API version.
entityTypePK: string in query	Filters the results based on the entity type identifier. Note: Refer to the table below for supported `entityTypePK` values.
$search: string in query	Picks the value in all possible fields.
$filter: string in query	Filters the results based on a Boolean condition.
$orderby: string in query	Sorts the results.
$top: string in query	Returns only the first n results.
$skip: string in query	Skips the first n results.
Authorization: string default: Bearer access_token in header	Specify the type of the token (bearer) and then insert the `access_token`, which was obtained during authentication.

Supported entityTypePKs

The following entityTypePKvalues are supported:

Entity	entityTypePK
Purchase Order	1
Received Invoice	4
Contacts	6
Requisition	7
Adjustments	8
Proof of Delivery	9
OCR Invoice	10
Inventory	11

Responses

Response	Explanation
200 OK	OK
400 Bad Request	Incorrect input data or organization ID does not match with the organization ID user is logged in.
400 Bad Request	The limit for the `$top` query has been exceeded. The value from the incoming request is 'N' (N is your value from the request). You can find the data on the current limit here.
401 Unauthorized	Incorrect specified `access_token` or `access_token` got expired.
403 Forbidden	User doesn’t have appropriate privileges.
500 Internal Server Error	Server encountered an unexpected condition that prevented it from fulfilling the request.

Properties

Property	Explanation
fileId: string (uuid)	Unique Identifier of the file
entityId: string (uuid)	Unique Identifier of the entity
entityNo: string	Identification Number of the entity
entityTypeValue: string	Type of the entity
fileName: string	Name of the file
fileStatus: string	Status of the file
fileSize: integer (int64)	Size of the file
fileType: string	Type of the file
dateCreated: string (date-time)	Date when the file was created
createdBy: string (uuid)	Unique Identifier of the user who created the file
createdByName: string	First and Last Name of the user who created the file
lastUpdated: string (date-time)	Last Date when the file was updated
lastUpdatedBy: string (uuid)	Unique Identifier of the last user who updated the file
lastUpdatedByName: string	First and Last Name of the last user who updated the file

Response Content-types: APPLICATION/JSON, APPLICATION/XML
Response Example (200 OK)

{
    "@odata.context": "link",
    "@odata.count": "number",
    "value": [
        {
            "fileId": "00000000-0000-0000-0000-000000000000",
            "entityId": "00000000-0000-0000-0000-000000000000",
            "entityNo": "string",
            "entityTypeValue": "string",
            "fileName": "string",
            "fileStatus": "string",
            "fileSize": "integer (int64)",
            "fileType": "string",
            "dateCreated": "string (date-time)",
            "createdBy": "00000000-0000-0000-0000-000000000000",
            "createdByName": "string",
            "lastUpdated": "string (date-time)",
            "lastUpdatedBy": "00000000-0000-0000-0000-000000000000",
            "lastUpdatedByName": "string"
        }
    ],
    "@odata.nextLink": "link"
}

Get the specified file metadata

Path

GET /odata/FileAttachments/{fileId}/metadata

Description

Returns the details of the file specified by ID within the logged-in organization.

Request parameters

Parameter	Explanation
fileId: string (uuid) required in path	Enter the ID of the file here.
api-version: string default: 1.0 in header	The requested API version.
Authorization: string default: Bearer access_token in header	Specify the type of the token (bearer) and then insert the `access_token`, which was obtained during authentication.

Responses

Response	Explanation
200 OK	OK
400 Bad Request	Incorrect input data or organization ID does not match with the organization ID user is logged in.
401 Unauthorized	Incorrect specified `access_token` or `access_token` got expired.
403 Forbidden	User doesn’t have appropriate privileges.
404 Not Found	Specified ID is absent in the system.
500 Internal Server Error	Server encountered an unexpected condition that prevented it from fulfilling the request.

Properties

Property	Explanation
fileId: string (uuid)	Unique Identifier of the file
entityId: string (uuid)	Unique Identifier of the entity
entityNo: string	Identification Number of the entity
entityTypeValue: string	Type of the entity
fileName: string	Name of the file
fileStatus: string	Status of the file
fileSize: integer (int64)	Size of the file
fileType: string	Type of the file
dateCreated: string (date-time)	Date when the file was created
createdBy: string (uuid)	Unique Identifier of the user who created the file
createdByName: string	First and Last Name of the user who created the file
lastUpdated: string (date-time)	Last Date when the file was updated
lastUpdatedBy: string (uuid)	Unique Identifier of the last user who updated the file
lastUpdatedByName: string	First and Last Name of the last user who updated the file

Response Content-types: APPLICATION/JSON, APPLICATION/XML
Response Example (200 OK)

{
    "@odata.context": "link",
    "fileId": "00000000-0000-0000-0000-000000000000",
    "entityId": "00000000-0000-0000-0000-000000000000",
    "entityNo": "string",
    "entityTypeValue": "string",
    "fileName": "string",
    "fileStatus": "string",
    "fileSize": "integer (int64)",
    "fileType": "string",
    "dateCreated": "string (date-time)",
    "createdBy": "00000000-0000-0000-0000-000000000000",
    "createdByName": "string",
    "lastUpdated": "string (date-time)",
    "lastUpdatedBy": "00000000-0000-0000-0000-000000000000",
    "lastUpdatedByName": "string"
}

Get the specified file content

Path

GET /odata/FileAttachments/{fileId}/content

Description

Returns the file content (in raw bytes) for the file specified by ID within the logged-in organization.

Note

Depending on the API tool you use, a file preview may be available, and the file may load automatically or require manual loading.

Warning

If the file status is Deleted, Uploading, Failed, or Corrupted, no content is returned.

Request parameters

Parameter	Explanation
fileId: string (uuid) required in path	Enter the ID of the file here.
api-version: string default: 1.0 in header	The requested API version.
Authorization: string default: Bearer access_token in header	Specify the type of the token (bearer) and then insert the `access_token`, which was obtained during authentication.

Responses

Response	Explanation
200 OK	OK
400 Bad Request	Incorrect input data or organization ID does not match with the organization ID user is logged in.
401 Unauthorized	Incorrect specified `access_token` or `access_token` got expired.
403 Forbidden	User doesn’t have appropriate privileges.
404 Not Found	Specified ID is absent in the system.
500 Internal Server Error	Server encountered an unexpected condition that prevented it from fulfilling the request.

The response body includes the raw bytes of the file attachment.