ZoneBilling for NetSuite is an enterprise grade subscription & billing management system built entirely within NetSuite and designed to handle everything from simple to complex billing scenarios. The product is developed and sold on a subscription basis by Zone & Company Software Consulting LLC.
\nFor companies that need to expand access to ZoneBilling beyond the NetSuite user interface (such as a company's proprietary system, website, or third-party application), Zone has developed an API to handle the majority of functions available within the product.
\nAccess to the API is a licensable option in certain editions of the ZoneBilling subscription. Please contact your Zone&Co sales representative for details on access to these features.
\nZone & Company Software Consulting
(800) 760-7401
www.zoneandco.com
NetSuite supports token-based authentication (TBA) a robust, industry standard-based mechanism that increases the overall security of the system. This authentication mechanism enables client applications to use a token to access NetSuite through APIs, eliminating the need for RESTlets to store user credentials. A token is valid for one specific company, user entity, and role only.
\nWhen you use token-based authentication, password rotation policies in the account do not apply to tokens and password management is unnecessary for your RESTlets integrations. Token-based authentication allows integrations to comply with any authentication policy that is deployed in a NetSuite account for UI login, such as SAML Single Sign-on, Inbound Single Sign-on, or Two-Factor Authentication. To enable token-based authentication, see
\nEnabling the Token-based Authentication Feature
\n.
\nThe ZAB API's access to NetSuite is determined by the setup of the role that is configured for the user's access token. This role will need (at a minimum) the following access in order to properly work.
\nSingle-Sign On Only - unchecked
\nWeb Services Only - unchecked
\nPermissions > Lists > Documents & Files - Edit
\nPermissions > Lists > Export Lists - Create
\nPermissions > Lists > Perform Search - Full
\nPermissions > Lists > Persist Search - Create
\nPermissions > Setup > Allow JS / HTML Uploads - Full
\nPermissions > Setup > Log in using Access Tokens - Full
\nPermissions > Setup > SuiteScript - Full
\nPermissions > Setup > SuiteScript Scheduling - Full
\nPermissions > Custom Record > ZAB API Export - Full
\nPermissions > Custom Record > ZAB Automation - Full
\nPermissions > Custom Record > ZAB Process - Full
\nThe above list of permissions is a minimum; additionally, the role will need access to every custom and standard record type that it may be interacting with.
\nThe Zone Advanced Billing Administrator role is often used when configuring an integration to NetSuite with the ZAB API. If its access is too open or restrictive, it can be used as a template that includes the above required permissions, as well as the other common permissions needed to interact with NetSuite's standard records and ZoneBilling's Bundled records.
\nIn order to generate a Consumer Key and Consumer Secret, you can create a new NetSuite Integration record by going to Setup > Integration > Manage Integrations > New within the NetSuite UI. Fill out any mandatory fields, including a unique name. Make sure that Token-based Authentication is checked. Upon save, the Consumer Key and Consumer Secret values will be displayed on the page in the \"Client Credentials\" section of the page. Save these values for your integration, upon exiting the page, you will not be able to access these values again.
\nIn order to generate a Token ID and Token Secret, you can create a new Access Token by going to Setup > Users/Roles > Access Tokens > New within the NetSuite UI. Select the application created above. Select the user that this integration will act on behalf of, and select the user role that the user will be logging in with. A unique Token Name will be generated, but a unique name can be set. Upon save, the Token ID and Token Secret values will be displayed on the page. Save these values for your integration, upon exiting the page, you will not be able to access these values again.
\nWhen calling a RESTlet, follow the OAuth 1.0 specification to generate a token. A description of the OAuth 1.0 protocol and signature validation is available at
\nhttps://tools.ietf.org/html/rfc5849
\n.
\nOAuth 1.0 passes in the following parameters:
\noauth_signature (required) - Credentials to verify the authenticity of the request, generated by calling your application. The Token Secret and Consumer Secret are constructed as a key to sign the request, using a supported signature method (HMAC-SHA256).
\noauth_version (required) - Must be set to “1.0”.
\noauth_nonce (required) - Passes in a unique, random, alphanumeric string. String must be a minimum of 6 characters, and the maximum length is 64 characters. Used to verify that a request has never been made before.
\noauth_signature_method (required) - Must be set to HMAC-SHA256. Declares which signature method is used.
\noauth_consumer_key (required) - Consumer Key (client application ID) generated for the token-based application in NetSuite. The unique value is matched to the token to establish ownership of the token.
\noauth_token (required) - Token ID generated for the token-based application in NetSuite.
\noauth_timestamp (required) - Passes in a positive integer expressed as the number of seconds since January 1, 1970 GMT.
\nrealm (required) - NetSuite Account ID (capitalized)
\nAdditionally, a 'Content-Type' header should be added to your request with the value being application/json.
When calling a RESTlet using OAuth 2.0, follow the OAuth 2.0 specification to generate a token.
A description of the OAuth 2.0 protocol and signature validation is available at
https://datatracker.ietf.org/doc/html/rfc6749
\n.
\nThe \"bearer\" token type defined in
\nhttps://datatracker.ietf.org/doc/html/rfc6750
\nis used by simply including the access token string in the request:
\nGET /resource/1 HTTP/1.1
\nHost: example.com
\nAuthorization: Bearer mF_9.B5f-4.1JqM
\nAdditionally, a 'Content-Type' header should be added to your request with the value being application/json.
The ZAB API endpoint will be specific to the NetSuite account that is being targeted. This URL is dictated by NetSuite and incorporates your NetSuite Account ID, the ZAB API Restlet Script, and the ZAB API Restlet Deployment.
\nTo determine your NetSuite Account ID, in the NetSuite UI, go to Setup > Company > Company Information. Your Account ID will be listed under the 'Account ID' field.
\nBase URL: https://{account_id}.restlets.api.netsuite.com/app/site/hosting/restlet.nl (Where {account_id} is the unique account ID of the target NetSuite environment)
Parameter: script customscriptzab_api_restlet
Parameter: deploy customdeployzab_api_restlet
OAuth 1.0 Example:
\nGET https://tstdrv123456.restlets.api.netsuite.com/app/site/hosting/restlet.nl?script=customscriptzab_api_restlet&deploy=customdeployzab_api_restlet HTTP/1.1\nAuthorization:\n OAuth oauth_signature=\"MgN1gZztYspNQXA576plPD14OWM=\",\n oauth_version=\"1.0\",\n oauth_nonce=\"207310548\",\n oauth_signature_method=\"HMAC-SHA256\",\n oauth_consumer_key=\"fvFwnmvurChjol7SZiF2pQ1oJ/ceRV8vqA/rZtzLEo=\",\n oauth_token=\"00076e1415667a6c555f5d43582134c87d6367ab456fd2\",\n oauth_timestamp=\"1418647040\",\n realm=\"TSTDRV123456\" \nHTTP/1.1 200 OK\nDate: Mon, 15 Dec 2018 12:37:42 GMT\nContent-Type: application/json\n\nOAuth 2.0 Example:
\nGET https://tstdrv123456.restlets.api.netsuite.com/app/site/hosting/restlet.nl?script=customscriptzab_api_restlet&deploy=customdeployzab_api_restlet HTTP/1.1\nAuthorization:\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer eyJraWQiOiablasldkhwNzIwNDcuMjAyMS0wNy0wM18xMC0zOS0wNiIsInR5cCI6IkpXVCIsImFsZyI6IlJTMjU2In0....\nHTTP/1.1 200 OK\nDate: Mon, 13 Dec 2021 12:37:42 GMT\nContent-Type: application/json\n\nThe actual response depends on the request method used. For a GET request, the response contains an entity corresponding to the requested resource. For a POST request the response contains an entity describing or containing the result of the action.
\nRESTlets support the following HTTP success code:
\nRESTlets support the following HTTP error codes:
\n302 Moved Temporarily: The request was sent to a different data center than the data center in which your company’s account resides. When you receive a 302 response, you must recalculate the signature on the request to the correct data center, because the signature is also computed from URL.
\n400 BAD_REQUEST: The RESTlet request failed with a user error.
\n401 UNAUTHORIZED: There is not a valid NetSuite login session for the RESTlet calls.
\n403 FORBIDDEN: RESTlet request sent to invalid domain, meaning a domain other than https://rest.netsuite.com.
\n404 NOT_FOUND: A RESTlet script is not defined in the RESTlet request.
\n405 METHOD_NOT_ALLOWED: The RESTlet request method is not valid.
\n415 UNSUPPORTED_MEDIA_TYPE: An unsupported content type was specified. (Only JSON and text are allowed.)
\n500 INTERNAL_SERVER_ERROR (unexpected errors): Occurs for non-user errors that cannot be recovered by resubmitting the same request. If this type of error occurs, contact Zone Customer Support to file a case.
\n503 SERVICE_UNAVAILABLE: The NetSuite database is offline or a database connection is not available.
\nCreate a new Contact record.
\n","auth":{"type":"oauth1","oauth1":{"basicConfig":[{"key":"consumerKey","value":""},{"key":"consumerSecret","value":""},{"key":"token","value":""},{"key":"tokenSecret","value":""}],"advancedConfig":[{"key":"signatureMethod","value":"Update an existing Contact record
\n","auth":{"type":"oauth1","oauth1":{"basicConfig":[{"key":"consumerKey","value":""},{"key":"consumerSecret","value":""},{"key":"token","value":""},{"key":"tokenSecret","value":""}],"advancedConfig":[{"key":"signatureMethod","value":"Create a new Count Data record
\n","auth":{"type":"oauth1","oauth1":{"basicConfig":[{"key":"consumerKey","value":""},{"key":"consumerSecret","value":""},{"key":"token","value":""},{"key":"tokenSecret","value":""}],"advancedConfig":[{"key":"signatureMethod","value":"Update an existing Count Data record
\n","auth":{"type":"oauth1","oauth1":{"basicConfig":[{"key":"consumerKey","value":""},{"key":"consumerSecret","value":""},{"key":"token","value":""},{"key":"tokenSecret","value":""}],"advancedConfig":[{"key":"signatureMethod","value":"Create a new Customer record
\n","auth":{"type":"oauth1","oauth1":{"basicConfig":[{"key":"consumerKey","value":""},{"key":"consumerSecret","value":""},{"key":"token","value":""},{"key":"tokenSecret","value":""}],"advancedConfig":[{"key":"signatureMethod","value":"Update an existing Customer record
\n","auth":{"type":"oauth1","oauth1":{"basicConfig":[{"key":"consumerKey","value":""},{"key":"consumerSecret","value":""},{"key":"token","value":""},{"key":"tokenSecret","value":""}],"advancedConfig":[{"key":"signatureMethod","value":"Create a new Master Contract record
\n","auth":{"type":"oauth1","oauth1":{"basicConfig":[{"key":"consumerKey","value":""},{"key":"consumerSecret","value":""},{"key":"token","value":""},{"key":"tokenSecret","value":""}],"advancedConfig":[{"key":"signatureMethod","value":"Update an existing Master Contract record
\n","auth":{"type":"oauth1","oauth1":{"basicConfig":[{"key":"consumerKey","value":""},{"key":"consumerSecret","value":""},{"key":"token","value":""},{"key":"tokenSecret","value":""}],"advancedConfig":[{"key":"signatureMethod","value":"Create a new Subscription record
\n","auth":{"type":"oauth1","oauth1":{"basicConfig":[{"key":"consumerKey","value":""},{"key":"consumerSecret","value":""},{"key":"token","value":""},{"key":"tokenSecret","value":""}],"advancedConfig":[{"key":"signatureMethod","value":"Update an existing Subscription record
\n","auth":{"type":"oauth1","oauth1":{"basicConfig":[{"key":"consumerKey","value":""},{"key":"consumerSecret","value":""},{"key":"token","value":""},{"key":"tokenSecret","value":""}],"advancedConfig":[{"key":"signatureMethod","value":"Create a new Subscription Item record
\nProvide the field values for the new Subscription as a JSON object.
\nResponse Code: 200 OK
Response Code: 200 OK
Create a new Subscription Item record
\nProvide the field values for the new Subscription as a JSON object.
\nResponse Code: 200 OK
Response Code: 200 OK
Create a new Usage Data record
\n","auth":{"type":"oauth1","oauth1":{"basicConfig":[{"key":"consumerKey","value":""},{"key":"consumerSecret","value":""},{"key":"token","value":""},{"key":"tokenSecret","value":""}],"advancedConfig":[{"key":"signatureMethod","value":"Update an existing Usage Data record
\n","auth":{"type":"oauth1","oauth1":{"basicConfig":[{"key":"consumerKey","value":""},{"key":"consumerSecret","value":""},{"key":"token","value":""},{"key":"tokenSecret","value":""}],"advancedConfig":[{"key":"signatureMethod","value":"Create a new Billing Profile record.
\n","auth":{"type":"oauth1","oauth1":{"basicConfig":[{"key":"consumerKey","value":""},{"key":"consumerSecret","value":""},{"key":"token","value":""},{"key":"tokenSecret","value":""}],"advancedConfig":[{"key":"signatureMethod","value":"Update an existing Billing Profile record.
\n","auth":{"type":"oauth1","oauth1":{"basicConfig":[{"key":"consumerKey","value":""},{"key":"consumerSecret","value":""},{"key":"token","value":""},{"key":"tokenSecret","value":""}],"advancedConfig":[{"key":"signatureMethod","value":"Update an existing Sales Order record.
\nProvide the field values to modify on the Sales Order as a JSON object.
\nSimply exclude fields that you do not wish to modify.
\nTo empty a field, provide an empty string or a value of null.
\nResponse Code: 200 OK
Response Code: 200 OK
When posting to the ZAB API, a JSON with the following properties must be provided:
\nWhen posting to the ZAB API, the following optional property may be added:\noptions | {Object} | No dependencies
Indicating the operation which you want to use will determine how you are going to leverage the API. There are a total of five operations in which you can submit to the ZAB API:
Based on these operations, this will impact the required parameters within the record property.
create - This will allow you to create new records in NetSuiteupdate - This will let you modify existing records in NetSuitetransform - This operations allows you to leverage NetSuite’s transformation capabilities from one record type to anotherupsert - If you would like to create and update records of the same record type, select this valueremoveLines - If you want to just remove sublist lines from a record, select thisFor the recordType property, you must indicate the NetSuite internal id of the record type you are looking to execute on. For example, for ZAB Subscriptions, you would want to indicate custrecordzab_subscription. The ZAP API also allows you to execute on any other record type available within NetSuite, including standard record types like Sales Orders (salesorder) and Customers (customer), as well as any other custom records within your NetSuite Instance (eg. custrecord_custom_record_name).
\n\nNote: Standard and Custom Fields that are required on records will continue to be required within the API, so it is best to be aware of these required fields to reduce the chance of error.
\n
The record property, is where all information is held to indicate what fields and values to be set on a record.
There are two ways to structure this property, one for standard field executions, and another for more complex executions on a record.
\n\n\nNote: If updating/upserting a record, you must include
\ninternalidproperty and a value. Unless you are using the external ID functionality (see below).
Advanced with Sublist\nThe second option is to provide a JSON object with three properties: body, sublists, removeLines. This allows for us to modify fields on the record, as well as sublists tied to the record.
body property should be the same formation as the standard record property, a JSON object with key/value pairs.sublists property will be JSON object with the keys being the sublist id for that record, and the values being an array of JSON objects that include the information to set on these sublist lines. These JSON objects must include an id value, and subsequently the field values to be set on this sublist.removeLines property allows you to indicate sublist lines that you want to remove from the record you are interacting with. Similar to the Sublist property, this is a JSON object with the keys being the sublist id for that record, and the values being an array of JSON objects that must include an id value to indicate the line.
\n\nNote: In order to interact with a custom sublist, the record type for that sublist must have the “Allow Child Record Editing” checkbox marked true in the record type preferences.
\n
\n\nNote: Custom Sublists IDs start with the “recmach” prefix, appended with the id of the record itself.
\n
\n\nNote: Sublists that have subrecords (eg. the Customer Address Sublist), can be interacted with by providing a JSON with field Ids and fields value pairs as the value for the sublist field value.
\n
The options property is where field options may be defined.
Two key value pairs make up the options property:
\nResponse Code: 200 OK
Response Code: 200 OK
When there are multiple records to be posted to NetSuite, the ZAB API supports bulk batch processing to submit an array of records. To indicate to the API that this is a batch process, a records property is added to the request body, rather than a record property.
This records property is an array of JSON objects configured the same as they would be individually in the record property via a standard ZAB API POST request.
There is no limit on the size of your records array; however, due to a NetSuite file size limitation, requests that are greater than 6MB will be evenly split into chained processes, maintaining the order of the submitted array.
The request response will remain the response with one reference_id property. This value can be used to determine other chained process statuses by using it as a filter in the ZAB API Export for ZAB Processes. See the GET > Bulk API & Process Response for further information.
See the below examples of Bulk API Requests, but like the Standard API Request, any accessible record type within NetSuite can be accessed via the ZAB Bulk API.
\nResponse Code: 200 OK
Response Code: 200 OK
Update an existing Usage Data record
\n","auth":{"type":"oauth1","oauth1":{"basicConfig":[{"key":"consumerKey","value":""},{"key":"consumerSecret","value":""},{"key":"token","value":""},{"key":"tokenSecret","value":""}],"advancedConfig":[{"key":"signatureMethod","value":"Create a new Customer record
\n","auth":{"type":"oauth1","oauth1":{"basicConfig":[{"key":"consumerKey","value":""},{"key":"consumerSecret","value":""},{"key":"token","value":""},{"key":"tokenSecret","value":""}],"advancedConfig":[{"key":"signatureMethod","value":"Upsert an existing Count Data record
\n","auth":{"type":"oauth1","oauth1":{"basicConfig":[{"key":"consumerKey","value":""},{"key":"consumerSecret","value":""},{"key":"token","value":""},{"key":"tokenSecret","value":""}],"advancedConfig":[{"key":"signatureMethod","value":"If you have an external system that you use to identify records/information, you can set those unique IDs within NetSuite records’ fields to accurately reference and update them later.
\nWe can use the ZAB Standard externalid field, or any other custom field to find and execute on a record. The ZAB API first looks at a request body for an internalid property to determine the record it needs to execute on, and if none is found, then it looks for an external key.
External ID\nYou can provide the externalid in the request record property if you are using the standard externalid field to reference your external ID, which will find the record that matches that value and execute on it.
Example Request Body
\n{\n \"operation\" : \"update\",\n \"recordType\" : \"custrecordzab_subscription\",\n \"record\" : {\n \"externalid\" : \"uniqueKey123456789\",\n \"name\" : \"New Subscription Name\"\n }\n}\nCustom External Reference\nIf you want to leverage a different field (either standard or custom) to identify your record, you can add an optional property to your request body: externalKey. This property is a string of the field ID on the record type you are executing on that stores the unique key you are looking to reference.
You must then include the unique value for your field in the body of your record property. The key property should be the field id, and the value should be the unique value.
Example Request Body\n ```
\n{\n \"operation\" : \"upsert\",\n \"recordType\" : \"customrecordzab_usage_data\",\n \"externalKey\" : \"custrecord_external_id_field\",\n \"record\" :\n {\n \"custrecord_external_id_field\" : \"uniqueKey123456789\",\n \"custrecordzab_ud_subscription\": 11,\n \"custrecordzab_ud_date\": \"20190710T1600+00\",\n \"custrecordzab_ud_quantity\": 450,\n \"custrecordzab_ud_usage_detail\": \"Test Volume Usage\"\n }\n}\n ```
\nSublist External Key\nIf you want to reference update a specific sublist line based on a certain field value, you can do so by add an optional sublistExternalKeys property to your request. The key will be the sublist ID, and the value being the sublist field Id that you want to reference. This will select the sublist line based off of that sublist field Id, and any other properties in that sublist object will be updated on that line.
Example Request Body
\n{\n \"operation\": \"update\",\n \"recordType\": \"customer\",\n \"sublistExternalKeys\": {\n \"addressbook\" : \"label\"\n },\n \"record\": {\n \"body\" : {\n \"internalid\" : \"4353\"\n },\n \"sublists\" : {\n \"addressbook\" : [\n {\n \"label\" : \"Headquarters\",\n \"addressbookaddress\" : {\n \"state\" : \"MA\"\n }\n }\n ]\n }\n }\n}\nResponse Code: 200 OK
Response Code: 200 OK
Create a new Subscription record with an external ID
\n","auth":{"type":"oauth1","oauth1":{"basicConfig":[{"key":"consumerKey","value":""},{"key":"consumerSecret","value":""},{"key":"token","value":""},{"key":"tokenSecret","value":""}],"advancedConfig":[{"key":"signatureMethod","value":"If you want to reference a select field based off of a unique value on that selected object, you can do so by adding an optional externalReferences property to your request.
This property is an array of JSONs indicating which field in your record or records property provides the value that should be referenced on a target record type and field. You can include multiple references if you join to multiple different target fields.
fieldId, indicates the field in your record(s) property that contains that reference valuerelatedRecordType, indicates the target record type data table within NetSuiterelatedFieldId, indicates the target field on the target record type data tableResponse Code: 200 OK
Response Code: 200 OK
Sublist records within NetSuite are records that have a child relationship to the target record we are interacting with, their parent. When interacting with these records, you can perform the same operation and identifier logic available for parent record, by including additional properties in your request body: sublistExternalKeys and sublistOperation.
By default, when interacting with sublists, a \"create\" operation logic is applied to always create new sublist records; however, this value can be overwritten by adding an additional property to your request: sublistOperation.
This property is a string of either \"create\", \"upsert\", or \"update\" to indicate how we should be interacting with the sublist of the record.
\nBy default, when upserting/updating to a record sublist, the following sublist record properties are used to identify, match, and then select a specific line:
\nSince sublists are an array of multiple related records, an identifier is needed to determine/select a specific record when updating/upserting. When one of the standard identifiers cannot be provided, a unique external identifier may be used by adding an additional property to your request: sublistExternalKeys.
This property is a JSON with the key being the sublist id, and the value being the field id that you want to use as your match value. That field's value in your request's sublist array will be used to select the matching sublist line.
\nResponse Code: 200 OK
Response Code: 200 OK
ZAB Plans and ZAB Plan Item records allow you to preconfigure default values when creating a ZAB Subscription (from a ZAB Plan) or a ZAB Subscription Item (from a ZAB Plan Item).
\nFor example, your company may have a standard product offering that gets structured as 1 Subscription with 4 Subscription Items. Using ZAB Plans and ZAB Plan Items, you can configure the default values for the ZAB Subscription (on the ZAB Plan record) and configure the default values for each ZAB Subscription Item (on child ZAB Plan Item records).
\nYou can set an entire ZAB Subscription to source from a ZAB Plan by setting the \"Current Plan\" field on the ZAB Subscription via the UI or the ZAB API, which will automatically create all child ZAB Subscription Item records as defaulted from the corresponding ZAB Plan Item records related to the ZAB Plan.
\nYou can also attach ZAB Plan Items to an existing Subscription with the ZAB API when creating, updating, or upserting to a ZAB Subscription:
\nUsing the \"Advanced\" record property structure as outlined above in the POST > Request directory, you can add an optional property to the record property called: planItems.
The planItems property should be formatted as an array of JSONs containing plan item information structured as follows:
\n\nNote: One of the identifiers:
\nplanId,planItemId, oritemIdmust be provided
\n\nNote: End Date of the ZAB Subscription Items are sourced from the parent ZAB Subscription
\n
Optionally, a subscriptionItemOverrides property can be added to your JSON that indicates the field overrides you may want to set on the newly created ZAB Subscription Items. Since your source requesting system is not going to necessarily know the unique identifiers for each new ZAB Subscription Item, we can identify it from the source ZAB Plan Item. We identify these ZAB Plan Items by configuring a unique attribute on the ZAB Plan Item called an API Group.
An API Group, is a custom value configured in your NetSuite account to attribute structure to your Plan Items associated to ZAB Plans or NetSuite Items.
\nFor example, your company may have a multiple product offerings that all get sold in a similar multi-item structure. One item is the sale of a \"license\", another item is the sale of \"services\", another represents the sale of \"content\", and a last item indicates \"support\" obligations. When configuring the offering as a ZAB Plan, the child ZAB Plan Items can each be configured to reference the corresponding types: license, services, content, and support by setting the API Group on the ZAB Plan Item record.
\nWhen interfacing with the ZAB API, these API Groups can be used to identify the ZAB Plan Item and corresponding ZAB Subscription Item being created. The subscriptionItemOverrides property will be an Object with the properties being the API Group name. The value being an Object containing the overrides represented as key/value pairs where the key is the ZAB Subscription Item Field, and the value is the override value.
This example shows updating a ZAB Subscription to include a new ZAB Plan: 1, with Subscription Item Field Overrides as indicated by their corresponding API Group. Additionally, another ZAB Plan Item is being added with a defined \"As Of Date\" indicating the start date of the Plan, so it will not inherit the start date of the parent ZAB Subscription\n { \"operation\" : \"update\", \"recordType\" : \"custrecordzab_subscription\", \"record\" : { \"body\" : { \"internalid\" : \"123456\" }, \"planItems\" : [ { \"planId\" : \"1\" \"subscriptionItemOverrides\" :{ \"license\" : { \"custrecordzab_si_item_description\" : \"License Key: ABC123\" }, \"services\" : { \"custrecordzab_si_item_description\" : \"Service Consultant: Jane Doe\" }, \"content\" : { \"custrecordzab_si_item_description\" : \"Localization: North America\" }, \"support\" : { \"custrecordzab_si_item_description\" : \"Dedicated Support Line: +1 (303) 987-1234\" } } }, { \"planItemId\" : \"12\", \"asOfDate\" : \"1/1/2020\" } ] } }
Response Code: 200 OK
Response Code: 200 OK
Configured ZAB Automation records can be triggered via the ZAB API, by providing an automations property, with the value being an array of automation IDs . This is useful if an external system wants to kick off an internal ZAB Process, such as Execute Rating or Create Transactions.
If one ID is provided, then only that singular automation will execute. If there are multiple ZAB Automation IDs provided, then they will be chained together and will execute in the order in which they were indicated in the array.
\nIf this property is provided alongside a regular request (eg. create a new record), then the regular request will execute then then automations will be generated and kicked off.
\nIf this property is provided with a Bulk API request (which itself is a ZAP Process execution), then the automations will be created and will be triggered to be executed in appropriate order on completion of the Bulk API request.
\nIn the POST response, a reference_id property will be provided. This reference_id is the first process that will execute in a process chain.
reference_id will be the id of the first process in for the indicated automationreference_id will be the id of the first process in the chain of automations' processes to executereference_id will be the id of the Bulk API Process, with subsequent chained automations' processes to be triggered after the completion of the Bulk API Request.The reference_id can be used to determine the results of the process using the corresponding GET Batch API request. The reference_id can also be used to determine other chained process statuses by using it as a filter in the ZAB API Export for ZAB Processes. See the GET > Bulk API & Process Response for further information.
Response Code: 200 OK
Response Code: 200 OK
You can use the ZAB API to send a File to a field on a record or to a file sublist in NetSuite.
\nFiles can be sent by providing the object properties and specifying a destination NetSuite File Cabinet folder. If a File is sent with the same name as an existing File, the existing File will get overwritten. Each File has a size limit of 10 MB.
\nCreated Files and information about those Files can be returned by using the existing Custom Results functionality with a configured ZAB API Export.
\nThe File properties should be formatted as an array of JSONs containing information structured as follows:
\nResponse Code: 200 OK
Response Code: 200 OK
If you want to return specific record field results, you can provide an export_id property. This export_id is a configured ZAB record that indicates a search that you can customize the record fields you want to export.
For more information on ZAB API Exports, please see the GET section of the ZAB API Documentation
\nResponse Code: 200 OK
Response Code: 200 OK
Create a new Sales Order record for a specific Customer record.
\n","auth":{"type":"oauth1","oauth1":{"basicConfig":[{"key":"consumerKey","value":""},{"key":"consumerSecret","value":""},{"key":"token","value":""},{"key":"tokenSecret","value":""}],"advancedConfig":[{"key":"signatureMethod","value":"If you want to manipulate the records in NetSuite by transforming them from one to another (eg. from a Sales Order into an Invoice), you can do so by including two more properties in your request: transformFromType and transformFromId.
transformFromType indicates the source record type/table that we are creating the new record from.
transformFromId indicates the source record from the record type indicated above
recordType indicates the record type that you are trying to transform into within NetSuite.
Example Request Body
\n{\n \"operation\" : \"transform\"\n \"transformFromType\" : \"estimate\",\n \"transformFromId\" : \"123456\",\n \"recordType\" : \"salesorder\"\n}\nOptionally, you can set field values (including default values) in the newly transformed record by including a record property. This property is a JSON object with field/value pairs.
*Example Request Body* \n\n{\n\"operation\" : \"transform\"\n\"tranformFromType\" : \"customer\",\n\"transformFromId\" : \"123456\",\n\"defaultValues\": {\n \"customform\": \"68\"\n},\n\"recordType\" : \"salesorder\"\n\"record\": {\n \"body\": {\n \"memo\": \"ZAB API Purchase Order #1234567 \"\n },\n \"sublists\": {\n \"item\": [\n {\n \"item\": 387,\n \"quantity\": 1,\n \"rate\": 122\n }\n ]\n }\n}\nResponse Code: 200 OK
Response Code: 200 OK
The ZAB API enables the developer to display additional debug information in the ZAB API Restlet deployment logs while the script deployment is in audit mode.
\nTo enable debug logging, provide an additional parameter in the body of an insert or update operation: debug: true
\n","_postman_id":"143f6ddd-5019-4278-aef6-e79fb2ad2815","auth":{"type":"oauth1","oauth1":{"basicConfig":[{"key":"consumerKey","value":""},{"key":"consumerSecret","value":""},{"key":"token","value":""},{"key":"tokenSecret","value":""}],"advancedConfig":[{"key":"signatureMethod","value":"Additional properties can be added to your request JSON to further interact with the ZAB API and NetSuite. The following properties are optional:
\n","event":[{"listen":"prerequest","script":{"id":"08eb9c58-bd9d-455f-b390-87912b5e22fe","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"99789c23-3cff-48cd-91aa-9f63d4195ad3","type":"text/javascript","exec":[""]}}],"_postman_id":"5b9348de-b1bc-424c-be3a-69aa4584e694","auth":{"type":"oauth1","oauth1":{"basicConfig":[{"key":"consumerKey","value":""},{"key":"consumerSecret","value":""},{"key":"token","value":""},{"key":"tokenSecret","value":""}],"advancedConfig":[{"key":"signatureMethod","value":"The ZAB API can be leveraged to POST records to NetSuite. These records can be created either individually, or in bulk via the batch capabilities of the API.
Note: OAuth 1.0 Is used in this Postman Collection. To use OAuth 2.0, configure an OAuth 2.0 token and select OAuth 2.0 as the Authorization Type with 'Bearer' as the Header Prefix.
\n","event":[{"listen":"prerequest","script":{"id":"2a52f386-0546-46c1-801a-032679645196","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"8e960d21-9eae-4889-ad1b-d2440ec86742","type":"text/javascript","exec":[""]}}],"_postman_id":"80904526-2029-4d58-b90e-9f965c375fcd","auth":{"type":"oauth1","oauth1":{"basicConfig":[{"key":"consumerKey","value":""},{"key":"consumerSecret","value":""},{"key":"token","value":""},{"key":"tokenSecret","value":""}],"advancedConfig":[{"key":"signatureMethod","value":"This request filters the results in the NetSuite search linked to the indicated export_id where the internalid is 1.
Retrieve NetSuite Account data
\n","auth":{"type":"oauth1","oauth1":{"basicConfig":[{"key":"consumerKey","value":""},{"key":"consumerSecret","value":""},{"key":"token","value":""},{"key":"tokenSecret","value":""}],"advancedConfig":[{"key":"signatureMethod","value":"This request returns all results in the NetSuite search linked to the indicated export_id.
\n\n","auth":{"type":"oauth1","oauth1":{"basicConfig":[{"key":"consumerKey","value":""},{"key":"consumerSecret","value":""},{"key":"token","value":""},{"key":"tokenSecret","value":""}],"advancedConfig":[{"key":"signatureMethod","value":"Note: This specific request requires NetSuite's Multibook functionality to be enabled.
\n
This request returns all results in the NetSuite search linked to the indicated export_id.
\n\n","auth":{"type":"oauth1","oauth1":{"basicConfig":[{"key":"consumerKey","value":""},{"key":"consumerSecret","value":""},{"key":"token","value":""},{"key":"tokenSecret","value":""}],"advancedConfig":[{"key":"signatureMethod","value":"Note: This specific request requires that the integration has access to manage accounting periods.
\n
This request returns all results in the NetSuite search linked to the indicated export_id.
This request filters the results in the NetSuite search linked to the indicated export_id where the internalid is 1.
This request returns all results in the NetSuite search linked to the indicated export_id.
This request returns all results in the NetSuite search linked to the indicated export_id.
This request filters the results in the NetSuite search linked to the indicated export_id where the custrecordzab_c_subscription is 5.
This request filters the results in the NetSuite search linked to the indicated export_id where the custrecordzab_c_customer is 959.
This request returns all results in the NetSuite search linked to the indicated export_id.
This request returns all results in the NetSuite search linked to the indicated export_id.
This request returns all results in the NetSuite search linked to the indicated export_id.
Since the parameter: return_all was set as true, the results property will return the full array of results rather than the just the first 1000 of the paginated results.
This request filters the results in the NetSuite search linked to the indicated export_id where the internalid is 421.
This request returns all results in the NetSuite search linked to the indicated export_id.
This request returns all results in the NetSuite search linked to the indicated export_id.
This request returns all results in the NetSuite search linked to the indicated export_id.
This request filters the results in the NetSuite search linked to the indicated export_id where the internalid is 1.
This request returns all results in the NetSuite search linked to the indicated export_id.
This request filters the results in the NetSuite search linked to the indicated export_id where the internalid is 321.
Retrieve all Customer record data
\n","auth":{"type":"oauth1","oauth1":{"basicConfig":[{"key":"consumerKey","value":""},{"key":"consumerSecret","value":""},{"key":"token","value":""},{"key":"tokenSecret","value":""}],"advancedConfig":[{"key":"signatureMethod","value":"This request returns all results in the NetSuite search linked to the indicated export_id.
\n\n","auth":{"type":"oauth1","oauth1":{"basicConfig":[{"key":"consumerKey","value":""},{"key":"consumerSecret","value":""},{"key":"token","value":""},{"key":"tokenSecret","value":""}],"advancedConfig":[{"key":"signatureMethod","value":"Note: This requires that the Custom Segment feature is enabled in the account
\n
This request filters the results in the NetSuite search linked to the indicated export_id where the name is Administration.
This request returns all results in the NetSuite search linked to the indicated export_id.
This request returns all results in the NetSuite search linked to the indicated export_id.
These records are shipped standard with ZAB and indicate the intervals which custom records, subscriptions, and other processes understand terms/time.
\n","auth":{"type":"oauth1","oauth1":{"basicConfig":[{"key":"consumerKey","value":""},{"key":"consumerSecret","value":""},{"key":"token","value":""},{"key":"tokenSecret","value":""}],"advancedConfig":[{"key":"signatureMethod","value":"This request filters the results in the NetSuite search linked to the indicated export_id where the itemid contains SAAS License.
This request returns all results in the NetSuite search linked to the indicated export_id.
This request filters the results in the NetSuite search linked to the indicated export_id where the name is New York.
This request returns all results in the NetSuite search linked to the indicated export_id.
This request filters the results in the NetSuite search linked to the indicated export_id where the Customer's Name (custrecordzab_mc_bill_to_entity.entityid) is Army Wing Enterprise.
This request returns all results in the NetSuite search linked to the indicated export_id.
This request returns all results in the NetSuite search linked to the indicated export_id.
This request filters the results in the NetSuite search linked to the indicated export_id where the name contains Advanced.
This request returns all results in the NetSuite search linked to the indicated export_id.
This request returns all results in the NetSuite search linked to the indicated export_id.
This request returns all results in the NetSuite search linked to the indicated export_id.
This request returns all results in the NetSuite search linked to the indicated export_id.
These records indicate how values custom fields on specific ZAB Plan Items get applied to ZAB Subscription Item records when the parent ZAB Plan is applied to a ZAB Subscription.
\n","auth":{"type":"oauth1","oauth1":{"basicConfig":[{"key":"consumerKey","value":""},{"key":"consumerSecret","value":""},{"key":"token","value":""},{"key":"tokenSecret","value":""}],"advancedConfig":[{"key":"signatureMethod","value":"This request returns all results in the NetSuite search linked to the indicated export_id.
This request returns all results in the NetSuite search linked to the indicated export_id.
This request returns all results in the NetSuite search linked to the indicated export_id.
This request filters the results in the NetSuite search linked to the indicated export_id where the custrecordzab_pricing_tier_price_book is Emails (Marginal Pricing) and custrecordzab_pricing_tier_currency is 3.
This request returns all results in the NetSuite search linked to the indicated export_id.
This request returns all results in the NetSuite search linked to the indicated export_id.
This request filters the results in the NetSuite search linked to the indicated export_id where the name contains COUNT.
This request filters the results in the NetSuite search linked to the indicated export_id where the internalid is 1.
This request returns all results in the NetSuite search linked to the indicated export_id.
This request filters the results in the NetSuite search linked to the indicated export_id where the internalid is 1.
This request returns all results in the NetSuite search linked to the indicated export_id.
This request filters the results in the NetSuite search linked to the indicated export_id where the custrecordzab_rn_customer is 959.
This request returns all results in the NetSuite search linked to the indicated export_id.
This request filters the results in the NetSuite search linked to the indicated export_id where the custrecordzab_ri_renewal is 1.
This request returns all results in the NetSuite search linked to the indicated export_id.
This request filters the results in the NetSuite search linked to the indicated export_id where the custrecordzab_re_customer is 959.
This request returns all results in the NetSuite search linked to the indicated export_id.
This request filters the results in the NetSuite search linked to the indicated export_id where the custrecordzab_rei_renewal_estimate is 1.
This request returns all results in the NetSuite search linked to the indicated export_id.
This request returns all results in the NetSuite search linked to the indicated export_id.
\n\n","auth":{"type":"oauth1","oauth1":{"basicConfig":[{"key":"consumerKey","value":""},{"key":"consumerSecret","value":""},{"key":"token","value":""},{"key":"tokenSecret","value":""}],"advancedConfig":[{"key":"signatureMethod","value":"Note: The Advanced Revenue Module Feature must be enabled in your NetSuite environment for this export to work.
\n
This request returns all results in the NetSuite search linked to the indicated export_id.
\n\n","auth":{"type":"oauth1","oauth1":{"basicConfig":[{"key":"consumerKey","value":""},{"key":"consumerSecret","value":""},{"key":"token","value":""},{"key":"tokenSecret","value":""}],"advancedConfig":[{"key":"signatureMethod","value":"Note: The Advanced Revenue Module Feature must be enabled in your NetSuite environment for this export to work.
\n
This request returns all results in the NetSuite search linked to the indicated export_id.
This request returns all results in the NetSuite search linked to the indicated export_id.
This request returns all results in the NetSuite search linked to the indicated export_id.
This request returns all results in the NetSuite search linked to the indicated export_id.
This request filters the results in the NetSuite search linked to the indicated export_id where the internalid is 6282.
This request filters the results in the NetSuite search linked to the indicated export_id where the trandate is before 1/1/2019.
This request returns all results in the NetSuite search linked to the indicated export_id.
This request returns all results in the NetSuite search linked to the indicated export_id.
This request filters the results in the NetSuite search linked to the indicated export_id where the internalid is 11.
This request filters the results in the NetSuite search linked to the indicated export_id where the custrecordzab_s_customer is 959.
This request filters the results in the NetSuite search linked to the indicated export_id where the custrecordzab_s_customer.entityid is Zone Gym.
This request returns all results in the NetSuite search linked to the indicated export_id.
Retrieve data from a specific Subscription Item record
\n","auth":{"type":"oauth1","oauth1":{"basicConfig":[{"key":"consumerKey","value":""},{"key":"consumerSecret","value":""},{"key":"token","value":""},{"key":"tokenSecret","value":""}],"advancedConfig":[{"key":"signatureMethod","value":"This request filters the results in the NetSuite search linked to the indicated export_id where the custrecordzab_si_customer is 72.
This request filters the results in the NetSuite search linked to the indicated export_id where the custrecordzab_si_subscription is 11.