Edit

Share via

Get attachments

  • Article

Retrieve the properties and relationships of an attachments object for Business Central. An attachment in the Business Central API is defined as an Incoming Document (table 130).

HTTP request

Replace the URL prefix for Business Central depending on environment following the guideline.

GET businesscentralPrefix/companies({id})/attachments?$filter=parentId eq {journalLineId} and parentType eq ‘Journal’

Note

Please note the $filter applied to attachment API. The filter is applied to get attachments for a specific entity.

Request headers

Header Value
Authorization Bearer {token}. Required.

Request body

Do not supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and an attachments object in the response body.

Example

Request

Here is an example of the request.

GET https://{businesscentralPrefix}/api/v1.0/companies({id})/attachments?$filter=parentId eq {journalLineId}

Response

Here is an example of the response.

Note

The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

{   
    "id": "b282a6f1-bfe3-ea11-aa60-000d3ad7cacb",
    "parentId": "0a077d18-45e3-ea11-bb43-000d3a2feca1",
    "fileName": "myPDF.pdf",
    "byteSize": 0,
    "lastModifiedDateTime": "2020-08-21T15:06:53Z",
    "parentType": "Journal"   
}

Tips for working with the APIs
attachment
Delete attachment
Create attachment
Update attachment