POST renderAndUploadDocument

POST renderAndUploadDocument

Method Description

This function allows you render a transaction PDF in NetSuite and upload it to SharePoint

ReturnsDirectory Item

Limitations

Record type must be a transaction record

Usage

For notes on how to authenticate see NetSuite documentation.
General usage notes see: File Sync REST API

Since

FileSync 0.6.0

Request Parameters

ParameterTypeRequiredDescriptionSince
options.script
stringrequiredStatic value that has to equal customscript_b4cd_fileapi_rl0.6.0
options.deploy

string

required

Static value that has to equal customdeploy_b4cd_fileapi_rl

0.6.0

Request Body

Note: The options parameter is a JavaScript object.

ParameterTypeRequiredDescriptionSince
options.action
stringrequired 

Value must equal "renderAndUploadDocument"
This value represents the method that is called.

0.6.0
options.recordId
integerrequiredThe internal ID of the record in NetSuite which we are associating the  new file to. 0.6.0
options.formId
integeroptionalThe internal ID of the form, or custom form, for the transaction.0.6.0
options.recordTypeConfigId

integer

required

Internal ID of the FileSync Record Type Configuration record (customrecord_b4cd_record_type_config).

0.6.0

Returns Directory Item

PropertyTypeDescriptionSince
DirectoryItem.name

string

The file or folder name

0.6.0

DirectoryItem.uniqueId
stringThe unique ID of the file or folder as assigned by the file hosting service. 0.6.0
DirectoryItem.type
stringPossible Values: "file", "folder"0.6.0
DirectoryItem.fileSize
integerFile size in bytes.0.6.0
DirectoryItem.apiUri
stringThe URI used to access the file or folder via the API. 0.6.0
DirectoryItem.filePath
stringThe relative file or folder path on the file hosting service starting from the base directory. 0.6.0
DirectoryItem.uri
stringThe user-navigable URI for the folder or file on the file hosting platform. This can be used to construct hyperlinks for users to reach the file or folder externally. 0.6.0

Errors

Error CodeDetails
SSS_MISSING_REQD_ARGUMENT

A required argument is missing or undefined.

Example Request Body

{
    "recordId":"20703",
    "recordTypeConfigId":"3",
    "action":"renderAndUploadTransaction"
}

Was this article helpful?