Created by Pavel Kabir, Modified on Fri, 12 Jul at 6:52 PM by Harry Lewis

Applies to:

  • Velixo NX    
  • Sage Intacct   

The SI.GETATTACHMENTSBYID function provides the ability to define a document within Sage Intacct that will (during a PDF Distibution process) be downloaded from Sage Intacct and included in the resulting PDF file attached to the email created by the Distibution.


SI.GETATTACHMENTSBYID (ConnectionName, AttachmentID, LocationID, NameFilter, Caption)


The SI.GETATTACHMENTSBYID function uses the following parameters:






The name of the connection as configured in the Connection Manager

AttachmentIDRequiredThe ID of an attachment, which is a group of one or more files within Sage Intacct 
LocationIDRequired for entity-
private records
The Entity ID of the record corresponding to the attachment.  
NameFilterOptionalA filter specifying the specific name of the file to be downloaded
CaptionOptionalA caption that will be displayed at the top of the attached sheet when it appears in the resulting PDF file.

Valid NameFilter special characters

Wildcard SymbolDescriptionExampleMatchesDoes not match
matches any number of any characters including none

Law, Laws, or Lawyer

GrokLaw, La, or aw


Law, GrokLaw, or Lawyer

La, or aw

matches any single character
Bat, bat, Cat or Catat
matches one character given in the bracket
Bat or Catbat, cat, at, or BCat
matches one character from the (locale-dependent) range given in the bracket
Letter0, Letter1, Letter2 up to Letter9Letter, Letters, or Letter10


Example 1

=SI.GETATTACHMENTSBYID ("Sage","ATT00038","100")


Will prepare the report to download the specified file (identified by the SUPDOC ID "ATT00038") where the record corresponding to the file has Sage Intacct entity ID 100.



Before the Distibution of the report is performed, the function will display the text "Attachment(s) will be processed during report distribution"


After the Distibution process, the function will display that the specified file was processed:

and the specified file(s) will be included in the PDF file attached to the Distributed email.

Example 2 - including a caption



Will prepare the report to download the file with ID #3102.  When the file is included in the resulting PDF file, the caption listed in cell D13 will be included at the top.

 (cell references were used for all of the parameters in this example)


Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article