AJAX SDK for JavaScript

• Overview
• API_Session
  • Parameters
• ip_create
  • Parameters
• ip_createXML
  • Parameters
• ip_delete
  • Parameters
• ip_inspect
  • Parameters
• ip_getLastRequest
• ip_read
  • Parameters
• ip_readByName
  • Parameters
• ip_readByQuery
  • Parameters
• ip_readMore
  • Parameters
• ip_readRelated
  • Parameters
• ip_readView
  • Parameters
• ip_update
  • Parameters
• ip_updateXML
  • Parameters

Overview

Sage Intacct provides an SDK for AJAX via a single JavaScript class in a single file.

This file is included in Platform Services pages to facilitate calling functions. Simply call the API_Session constructor to instantiate the class, then call functions in an on-page script (via Edit this page in the Sage Intacct UI). The SDK provides wrappers for the generic functions (3.0 versions).

API_Session

You must initiate an AJAX call with this constructor, which establishes an API session using the credentials of the current user.

var s = new API_Session();

Parameters

ip_create

Generates a create call. This function has no return value, but the provided example shows how to use a callback to print the response for console logging.

Creates a new item. Only the required fields are included in the array, but you can add more fields as needed.

<script>
function createBeforeSubmit(){
    console.log("In createBeforeSubmit function");
    var fieldsArray = {
        'ITEMID': jq('#MY_ITEMID').val(),
        'STATUS': 'active',
        'NAME': jq('#MY_NAME').val(),
        'ITEMTYPE': 'Non-Inventory'
    };
    var api = new API_Session();
    var callback = function(responseText){
        console.log(responseText)
    }
    api.ip_create('ITEM', fieldsArray, callback);
}
</script>

<style>
#myNewItem{
width:75%;
padding:20px;
margin:20px;
background: #CCCCCC;
}
</style>

<div id="myNewItem">
  <p><label for="MY_ITEMID">Item ID<label> <input type="text" name="MY_ITEMID" id="MY_ITEMID" value="" size="15"/></p>
  <p><label for="MY_NAME">Item Name<label> <input type="text" name="MY_NAME" id="MY_NAME" value="" size="30"/></p>
  <p><button type="button" onclick="createBeforeSubmit()">Create Item</button></p>
</div>

Parameters

ip_createXML

Generates a create API call using XML content that you provide.

Parameters

ip_delete

Generates a delete API call.

Parameters

ip_inspect

Generates an inspect API on the named object.

Parameters

ip_getLastRequest

Returns the last XML request sent to the server. This function can be used for debugging.

ip_read

Generates a read API call.

Parameters

ip_readByName

Generates a readByName API call.

Parameters

ip_readByQuery

Generates a readByQuery API call using XML content that you provide.

Parameters

ip_readMore

Generates a readMore API call.

Parameters

ip_readRelated

Generates a readRelated API call.

Parameters

ip_readView

Generates a readView API call. This call typically relies on filters set in the view through the Sage Intacct UI, but you can set additional filters to incorporate dynamic information generated by your script.

Uses a filter:

<script>
var api = new API_Session();
var invoiceRecNo = "{!ARINVOICE.RECORDNO#text!}";
var arr = {"filterExpression" : {"field":"RARINVOICE", "operator":'is one of', "value":invoiceRecNo}};

api.ip_readView('collection_activity#147115@10570', arr, 100, 'json', function(data) {
    alert(api.ip_getLastRequest());
    displaySearchResults(data);
});
</script>

Parameters

ip_update

Generates an update API call.

Shows an update operation:

<script>
var id = '{!object.id!}';  // Id of the current record of the object to update
var fmv = '{!object.test_field!}';
var s = new API_Session();

var arr = {"id":id, "test_field":fmv};
s.ip_update('object', arr);
</script>

Parameters

ip_updateXML

Generates an update API call using XML content that you provide.

Parameters

Provide feedback