Uploading binary files from NetSuite to external systems is a common requirement for businesses that need to share invoices, PDFs, images, or other non-text files with third-party applications. SuiteScript 2.0 provides a robust and flexible framework to handle these uploads efficiently. Using SuiteScript, files stored in the NetSuite File Cabinet can be extracted and sent to external APIs with proper authentication and content-type headers.
This approach allows organizations to automate integrations, reduce manual work, and ensure that sensitive or critical data flows securely to external systems.
Step-by-Step Guide to Upload Binary Type Files
Follow the steps below to upload the binary type files from NetSuite to external systems using SuiteScript 2.0:
Step 1: Load the Binary File from the File Cabinet
Use the N/file module to retrieve files stored in NetSuite. For binary files, .getContents() retrieves the file content suitable for uploading.
var fileObj = file.load({ id: fileId });
var fileContent = fileObj.getContents(); // binary data
Key Points:
- Ensure the correct internal ID of the file is used.
- Works for PDFs, images, and other binary formats.
Step 2: Prepare the HTTPS Request
External systems usually require a POST request with the file content in the request body and a matching Content-Type. Use the N/https module to send the file.
var response = https.post({
url: ‘https://external.api/upload’,
headers: {
‘Content-Type’: ‘application/binary’,
‘Authorization’: ‘Bearer YOUR_API_TOKEN’,
‘Accept’: ‘application/json’
},
body: fileContent
});
Notes:
- For APIs requiring multipart form-data, manually construct boundaries and file parts.
- Authentication must match the external system’s requirements.
Step 3: Handle API Responses
After sending the file, handle success or error responses to ensure reliable integration.
log.debug(‘Upload Response Code’, response.code);
log.debug(‘Response Body’, response.body);
- Check status codes (200–299 for success).
- Log or parse the response body to confirm the file upload or retrieve file URLs.
Step 4: Optional Enhancements
- Scheduled Scripts: Automate bulk uploads instead of real-time RESTlet calls.
- Base64 Handling: Convert content to/from Base64 if required by the external API.
- Error Logging: Capture exceptions for retries or alerts.
Sample RESTlet Implementation
/**
* @NApiVersion 2.x
* @NScriptType Restlet
*/
define([‘N/file’, ‘N/https’, ‘N/log’], function(file, https, log) {
function post(requestBody) {
try {
var fileObj = file.load({ id: requestBody.fileId });
var fileContent = fileObj.getContents();
var response = https.post({
url: ‘https://external.api/upload’,
headers: {
‘Content-Type’: ‘application/binary’,
‘Authorization’: ‘Bearer YOUR_API_TOKEN’,
‘Accept’: ‘application/json’
},
body: fileContent
});
log.debug(‘Upload Response Code’, response.code);
log.debug(‘Upload Response Body’, response.body);
return { success: true, statusCode: response.code, responseBody: response.body };
} catch (e) {
log.error(‘Upload Failed’, e.message);
return { success: false, error: e.message };
}
}
return { post: post };
});
Best Practices
- Correct Field Types: Ensure you are uploading actual binary content, not text files.
- Authentication: Never hardcode credentials; use secure storage or environment variables.
- Error Handling: Use try/catch and log all errors for easier debugging.
- RESTlet vs Scheduled Script: RESTlets allow on-demand uploads, while scheduled scripts are better for batch processing.
- Testing: Validate uploads in a sandbox environment before production deployment.
Conclusion
Uploading application/binary type files from NetSuite to external systems via SuiteScript 2.0 is a powerful way to automate file transfers and integrate with third-party platforms. Using the N/file and N/https modules, businesses can securely transfer files, maintain accurate data, and streamline workflows. Implementing RESTlets or scheduled scripts ensures scalability, error handling, and secure authentication while supporting both single and bulk file uploads.
NetSuite Implementation made easier
Need help automating your NetSuite file uploads? Our experts can design, implement, and optimize SuiteScript 2.0 integrations to securely move your files to external systems. From RESTlet setups to scheduled scripts and complex API handling, we ensure your NetSuite instance works efficiently and accurately.
Contact us today to streamline your NetSuite integrations and file management.
FAQs
1. Can SuiteScript 2.0 handle large binary files?
Yes, but NetSuite imposes governance limits. Large files may require splitting or chunking. Scheduled scripts are preferred for bulk uploads to avoid hitting governance limits.
2. How do I send multipart/form-data requests?
- SuiteScript doesn’t natively support multipart/form-data.
- Manually construct the request with boundaries, file headers, and encoded content.
- Ensure the external API can parse the multipart format correctly.
3. Can I automate uploads for multiple files at once?
Yes, use a Scheduled Script to loop through files in a folder.
- Load each file, prepare the request, and send it sequentially with logging.
4. How do I handle base64 encoding?
Some APIs require Base64; convert using encode.convert({ string: fileContent, inputEncoding: encode.Encoding.UTF_8, outputEncoding: encode.Encoding.BASE_64 }).
- Decode on the receiving system before storage or processing.
5. What if the API fails or times out?
You can take the following steps:
- Implement retries with exponential backoff.
- Log failures and optionally alert administrators for manual intervention
