GET InvoiceAttachment/id

Returns the attachment with the given attachment Id.

Request Information

URI Parameters

Name Description Type Additional information
WsAccessKey The Web Service access key for this user and file which allows access to the API for the associated file (found in File - Settings). Using OAuth authentication mechanism is the preferred method to allow API access. string

Optional. Legacy authentication method and only required if not using OAuth. OAuth is preferred.

FileId Specifies the file id of the file to perform the operation upon. integer


id Attachment Id integer


Body Parameters


Response Information

Resource Description

Name Description Type Additional information
AttachmentData This is an array of bytes and represents the data of the attachment (ie. the attachment itself). You must convert the file you want to attach into a byte array. This is usually done programmatically which our client code does for you. This process is called serialisation and more information on this can be found here - Collection of byte


AllowExistingAttachmentToBeOverwritten A flag that indicates if an attachment of the same name already exists, whether it can be overwritten or not when storing. boolean


Name Name of the attachment. string


Description Description of the attachment. string


ItemIdAttachedTo The Id of the item/entity that this attachment is associated with or attached to. integer


_links Hypermedia links. Contains contextual links to possible next actions related to this resource. Only present in responses. This data is not to be sent to the server. Collection of Link


Response Formats

application/json, text/json

  "AttachmentData": null,
  "AllowExistingAttachmentToBeOverwritten": false,
  "Name": "Toy sale.doc",
  "Description": "Toy sale invoice",
  "ItemIdAttachedTo": 18616,
  "_links": []

application/xml, text/xml

<FileAttachment xmlns:xsd="" xmlns:xsi="">
  <_links />
  <Name>Toy sale.doc</Name>
  <Description>Toy sale invoice</Description>