Introduction

The Nue API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Applications can perform HTTP operations (GET, PUT, POST, PATCH, DELETE) against the REST resources available at Nue. Nue offers a dual-platform mode. If there is a Salesforce connection via Salesforce OAuth2.0 configured in your Nue tenant, some API calls will route the request to Salesforce to read and write data directly in Salesforce.

Nue also supplies a series of composite APIs to ease the process for creating complex objects (e.g. bundle products) with ease.

Authentication

Nue provides API Key authentication as a primary method to secure access to its API endpoints. API Keys are unique identifiers that allow clients to authenticate themselves when making requests to the Nue API. For detailed information about Nue API Keys, please refer to this article.

Please be aware of the following best practices of using API Key to authenticate your APIs:

Keep API Key Secure: Treat your API Key like a password and keep it secure.
- Do not expose it directly in the front-end application code.
- Avoid hardcoding API Keys directly into your application code.
- Consider using environment variables or secure storage mechanisms to manage API Keys.
Rotate API Keys Regularly:
- Rotate your API Keys periodically to mitigate the risk of unauthorized access. Generate new API Keys and update them in your applications and systems.
Use HTTPS:
- Always use HTTPS when communicating with the Nue API to encrypt the transmission of sensitive information, including API Keys.

Nue also authenticates your API requests using your tenant's API Access Key along with an authentication token. If you don’t include your API Access Key (apiAccessKey) in the request header when making an API request, or use an incorrect one, Nue returns a 401 - Unauthorized HTTP response code.

Nue supports the following 2 primary means for API authentication:

JWT

The client can use JWT token to access Nue APIs. This is the recommended way to authenticate into Nue API. The JWT token will be expired in 1 hour.

Code sample for getting access token

# You can also use wget
curl -X POST https://api.nue.io/auth/token \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

POST https://api.nue.io/auth/token HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: application/json

const inputBody = '{
  "userName": "string",
  "password": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.nue.io/auth/token',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'https://api.nue.io/auth/token',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.nue.io/auth/token', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/auth/token', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/auth/token");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/auth/token", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /auth/token

Body parameter

{
  "userName": "string",
  "password": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Succeed to get the access token for authentication.	AuthenticationResult
401	Unauthorized	Unauthorized	None

After getting the access token, the client can access Nue's API with header like

Authorization: Bearer {token}
apiAccessKey: {apiAccessKey}

You must replace access_token and apiAccessKey with the real value.

Basic

You can also use Basic Authentication along with the API Access Key to authenticate into Nue API. For example, to get tenant details, use the following API:

curl -X GET https://api.nue.io/tenant \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'Authorization: Basic {basic_token} \ -H 'apiAccessKey: {apiAccessKey}'

Errors

Nue uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a charge failed, etc.). Codes in the 5xx range indicate an error with Nue's servers (these are rare).

Some 4xx errors that could be handled programmatically (e.g., a card is declined) include an error code that briefly explains the error reported.

Status Code	Summary
200	OK -- Everything worked as expected.
400	Bad Request -- The request was unacceptable, often due to missing a required parameter, or a request body that cannot be processed according to the content type.
401	Unauthorized -- No valid API key, auto tokens or user credentials are provided.
403	Forbidden -- The authenticated user doesn't have permissions to perform the request.
404	Not Found -- The requested resource doesn't exist.
500	Internal Server Error -- We had a problem with our server. Try again later.
503	Service Unavailable -- We're temporarily offline for maintenance. Please try again later.

title: Tenants and Users v1.0 language_tabs: - shell: Shell - http: HTTP - javascript: JavaScript - ruby: Ruby - python: Python - php: PHP - java: Java - go: Go toc_footers: [] includes: [] search: false highlight_theme: darkula headingLevel: 2

Tenants and Users v1.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Base URLs:

https://api.nue.io

Authentication

HTTP Authentication, scheme: bearer
HTTP Authentication, scheme: basic

Retrieve the login history sorted by the login time in a descendant order.

Code samples

# You can also use wget
curl -X GET https://api.nue.io/loginHistory \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.nue.io/loginHistory HTTP/1.1
Host: api.nue.io
Accept: application/json


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/loginHistory',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/loginHistory',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/loginHistory', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/loginHistory', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/loginHistory");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/loginHistory", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /loginHistory

Retrieve the login history of the current organization.

Name	In	Type	Required	Description
startTime	query	string	false	The start time of the login history. Should provide as a string that represent a valid date-time, which will be parsed using the DateTimeFormatter.ISO_OFFSET_DATE_TIME format follows the pattern:yyyy-MM-dd'T'HH:mm:ss.SSSXXX. e.g."2023-10-31T12:37:32.000%2B01:00","2023-10-31T12:37:32.000-01:00","2023-10-31T12:37:32.000Z"in URL.
endTime	query	string	false	The end time of the login history. Should provide as a string that represent a valid date-time, which will be parsed using the DateTimeFormatter.ISO_OFFSET_DATE_TIME format follows the pattern:yyyy-MM-dd'T'HH:mm:ss.SSSXXX. e.g."2023-10-31T12:37:32.000%2B01:00","2023-10-31T12:37:32.000-01:00","2023-10-31T12:37:32.000Z"in URL.
limit	query	integer(int32)	false	The limit of the number of records queried.

Example responses

200 Response

null

Status	Meaning	Description	Schema
200	OK	OK	Inline

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[LoginHistoryVO]	false	none	none
» userId	string	false	none	The user ID
» tenantId	string	false	none	The tenant ID
» browser	string	false	none	The browser or access point the user used to login with
» loginTime	string(date-time)	false	none	The login time
» status	string	false	none	The login status, Success or Error.
» username	string	false	none	User Name
» loginUrl	string	false	none	none
» role	string	false	none	The user role.
» errorMessage	string	false	none	The error message

Enumerated Values

Property	Value
status	Success
status	Error

Code samples

# You can also use wget
curl -X GET https://api.nue.io/loginHistory/user/{userId} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.nue.io/loginHistory/user/{userId} HTTP/1.1
Host: api.nue.io
Accept: application/json


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/loginHistory/user/{userId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/loginHistory/user/{userId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/loginHistory/user/{userId}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/loginHistory/user/{userId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/loginHistory/user/{userId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/loginHistory/user/{userId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /loginHistory/user/{userId}

Retrieve the login history of the current user.

Name	In	Type	Required	Description
userId	path	string	true	User ID
startTime	query	string	false	The start time of the login history. Should provide as a string that represent a valid date-time, which will be parsed using the DateTimeFormatter.ISO_OFFSET_DATE_TIME format follows the pattern:yyyy-MM-dd'T'HH:mm:ss.SSSXXX. e.g."2023-10-31T12:37:32.000%2B01:00","2023-10-31T12:37:32.000-01:00","2023-10-31T12:37:32.000Z"in URL.
endTime	query	string	false	The end time of the login history. Should provide as a string that represent a valid date-time, which will be parsed using the DateTimeFormatter.ISO_OFFSET_DATE_TIME format follows the pattern:yyyy-MM-dd'T'HH:mm:ss.SSSXXX. e.g."2023-10-31T12:37:32.000%2B01:00","2023-10-31T12:37:32.000-01:00","2023-10-31T12:37:32.000Z"in URL.
limit	query	integer(int32)	false	The limit of the number of records queried.

Example responses

200 Response

null

Status	Meaning	Description	Schema
200	OK	OK	Inline

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[LoginHistoryVO]	false	none	none
» userId	string	false	none	The user ID
» tenantId	string	false	none	The tenant ID
» browser	string	false	none	The browser or access point the user used to login with
» loginTime	string(date-time)	false	none	The login time
» status	string	false	none	The login status, Success or Error.
» username	string	false	none	User Name
» loginUrl	string	false	none	none
» role	string	false	none	The user role.
» errorMessage	string	false	none	The error message

Enumerated Values

Property	Value
status	Success
status	Error

Users and Roles

Get User Roles

Code samples

# You can also use wget
curl -X GET https://api.nue.io/users/{userId}/roles \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.nue.io/users/{userId}/roles HTTP/1.1
Host: api.nue.io
Accept: application/json


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/users/{userId}/roles',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/users/{userId}/roles',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/users/{userId}/roles', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/users/{userId}/roles', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/users/{userId}/roles");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/users/{userId}/roles", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /users/{userId}/roles

Retrieve all roles associated with the user.

Parameters

Name	In	Type	Required	Description
userId	path	string	true	The user ID

Example responses

200 Response

null

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[UserRole]	false	none	none
» id	string	false	none	none
» name	string	false	none	none
» effective	boolean	false	none	none
» functions	[Function]	false	none	none
»» id	string	false	none	none
»» name	string	false	none	none
»» label	string	false	none	none
»» policy	FunctionPolicy	false	none	none
»»» actions	[string]	false	none	none
»» featureId	string	false	none	none
»» featureName	string	false	none	none

Get Connected Salesforce User

Code samples

# You can also use wget
curl -X GET https://api.nue.io/users/salesforce \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.nue.io/users/salesforce HTTP/1.1
Host: api.nue.io
Accept: application/json


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/users/salesforce',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/users/salesforce',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/users/salesforce', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/users/salesforce', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/users/salesforce");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/users/salesforce", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /users/salesforce

Retrieve the connected Salesforce user name of the current user.

Example responses

200 Response

null

Responses

Status	Meaning	Description	Schema
200	OK	OK	SalesforceUserIntegration

Get User Profile

Code samples

# You can also use wget
curl -X GET https://api.nue.io/users/profile \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.nue.io/users/profile HTTP/1.1
Host: api.nue.io
Accept: application/json


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/users/profile',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/users/profile',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/users/profile', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/users/profile', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/users/profile");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/users/profile", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /users/profile

Retrieve the user profile information and the user's roles using the API Access Key and Access Token.

Parameters

Name	In	Type	Required	Description
with-detail	query	boolean	false	none

Example responses

200 Response

null

Responses

Status	Meaning	Description	Schema
200	OK	OK	GetUserResult

Get Function Policies

Code samples

# You can also use wget
curl -X GET https://api.nue.io/users/functions \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.nue.io/users/functions HTTP/1.1
Host: api.nue.io
Accept: application/json


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/users/functions',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/users/functions',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/users/functions', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/users/functions', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/users/functions");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/users/functions", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /users/functions

Retrieve the functions the current user has access to.

Example responses

200 Response

null

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[Function]	false	none	none
» id	string	false	none	none
» name	string	false	none	none
» label	string	false	none	none
» policy	FunctionPolicy	false	none	none
»» actions	[string]	false	none	none
» featureId	string	false	none	none
» featureName	string	false	none	none

Get Roles

Code samples

# You can also use wget
curl -X GET https://api.nue.io/roles \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.nue.io/roles HTTP/1.1
Host: api.nue.io
Accept: application/json


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/roles',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/roles',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/roles', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/roles', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/roles");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/roles", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /roles

Retrieve a list of all user roles

Example responses

200 Response

null

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[RoleVO]	false	none	none
» id	string	false	none	The user role ID
» name	string	false	none	The user role name
» functions	[FunctionVO]	false	none	A list of functions this user role has access to.
»» id	string	false	none	Function name
»» functionPolicy	FunctionPolicy	false	none	none
»»» actions	[string]	false	none	none
»» featureName	string	false	none	Feature Name

Get Role

Code samples

# You can also use wget
curl -X GET https://api.nue.io/roles/{id} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.nue.io/roles/{id} HTTP/1.1
Host: api.nue.io
Accept: application/json


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/roles/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/roles/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/roles/{id}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/roles/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/roles/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/roles/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /roles/{id}

Retrieve detailed information of a user role, including the functions the role has access to.

Parameters

Name	In	Type	Required	Description
id	path	string	true	The user role ID

Example responses

200 Response

null

Responses

Status	Meaning	Description	Schema
200	OK	OK	Role

Access Tokens

Acquire, refresh and verify API access tokens.

Verify Token

Code samples

# You can also use wget
curl -X POST https://api.nue.io/auth/verify \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

POST https://api.nue.io/auth/verify HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: application/json

const inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.nue.io/auth/verify',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'https://api.nue.io/auth/verify',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.nue.io/auth/verify', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/auth/verify', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/auth/verify");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/auth/verify", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /auth/verify

Verify the access token.

Body parameter

null

Parameters

Name	In	Type	Required	Description
body	body	TokenVerificationRequest	true	The token verification request.

Example responses

200 Response

null

Responses

Status	Meaning	Description	Schema
200	OK	Verified the access tokens successfully.	AuthenticationResult
401	Unauthorized	Unauthorized	None

Response Schema

Get Access Token

Code samples

# You can also use wget
curl -X POST https://api.nue.io/auth/token \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

POST https://api.nue.io/auth/token HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: application/json

const inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.nue.io/auth/token',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'https://api.nue.io/auth/token',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.nue.io/auth/token', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/auth/token', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/auth/token");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/auth/token", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /auth/token

Acquire the access token, refresh token and API access key for a user.

In Nue, a user may have access to more than one tenants in an organization. Use showTenants parameter to show all the tenants the user has access to in the organization.

Body parameter

null

Parameters

Name	In	Type	Required	Description
body	body	AuthenticationRequest	true	The authentication request.

Example responses

200 Response

null

Responses

Status	Meaning	Description	Schema
200	OK	Received the access tokens successfully.	AuthenticationResult
401	Unauthorized	Unauthorized	None

Response Schema

Revoke refresh token

Code samples

# You can also use wget
curl -X POST https://api.nue.io/auth/revokeToken \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*'

POST https://api.nue.io/auth/revokeToken HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*'
};

fetch('https://api.nue.io/auth/revokeToken',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*'
}

result = RestClient.post 'https://api.nue.io/auth/revokeToken',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*'
}

r = requests.post('https://api.nue.io/auth/revokeToken', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/auth/revokeToken', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/auth/revokeToken");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/auth/revokeToken", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /auth/revokeToken

Revoke the refresh token

Body parameter

null

Parameters

Name	In	Type	Required	Description
body	body	RevokeTokenRequest	true	none

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	string

Refresh Token

Code samples

# You can also use wget
curl -X POST https://api.nue.io/auth/refreshToken \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'apiAccessKey: null'

POST https://api.nue.io/auth/refreshToken HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: application/json
apiAccessKey: null

const inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'apiAccessKey':null
};

fetch('https://api.nue.io/auth/refreshToken',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'apiAccessKey' => null
}

result = RestClient.post 'https://api.nue.io/auth/refreshToken',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'apiAccessKey': null
}

r = requests.post('https://api.nue.io/auth/refreshToken', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'apiAccessKey' => 'null',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/auth/refreshToken', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/auth/refreshToken");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "apiAccessKey": []string{"null"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/auth/refreshToken", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /auth/refreshToken

Refresh the access token.

Body parameter

null

Parameters

Name	In	Type	Required	Description
apiAccessKey	header	string	true	API Access Key
body	body	TokenRefreshRequest	true	The authentication request

Example responses

200 Response

null

Responses

Status	Meaning	Description	Schema
200	OK	Received the access tokens successfully	AuthenticationResult
401	Unauthorized	Unauthorized	None

Response Schema

Schemas

TokenVerificationRequest

null

Properties

Name	Type	Required	Restrictions	Description
apiAccessKey	string	true	none	none
token	string	true	none	none

AuthenticationResult

null

Properties

Name	Type	Required	Restrictions	Description
token	string	false	none	none
refreshToken	string	false	none	none
expiresIn	integer(int32)	false	none	none
challenge	Challenge	false	none	none
tenants	[UserMappedTenantResponse]	false	none	none

Challenge

null

Properties

Name	Type	Required	Restrictions	Description
session	string	false	none	none
name	string	false	none	none

UserMappedTenantResponse

null

Properties

Name	Type	Required	Restrictions	Description
apiAccessKey	string	false	none	none
tenantNumber	integer(int32)	false	none	none
tenantName	string	false	none	none
tenantId	string	false	none	none
orgId	string	false	none	none
orgName	string	false	none	none

AuthenticationRequest

null

Properties

Name	Type	Required	Restrictions	Description
userName	string	true	none	none
password	string	true	none	none
showTenants	boolean	false	none	none

RevokeTokenRequest

null

Properties

Name	Type	Required	Restrictions	Description
token	string	true	none	none
userName	string	true	none	none

TokenRefreshRequest

null

Properties

Name	Type	Required	Restrictions	Description
refreshToken	string	true	none	none
userName	string	true	none	none

Function

null

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
name	string	false	none	none
label	string	false	none	none
policy	FunctionPolicy	false	none	none
featureId	string	false	none	none
featureName	string	false	none	none

FunctionPolicy

null

Properties

Name	Type	Required	Restrictions	Description
actions	[string]	false	none	none

UserRole

null

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
name	string	false	none	none
effective	boolean	false	none	none
functions	[Function]	false	none	none

SalesforceUserIntegration

null

Properties

Name	Type	Required	Restrictions	Description
userName	string	false	none	none

Address

null

Properties

Name	Type	Required	Restrictions	Description
street	string	false	none	none
state	string	false	none	none
city	string	false	none	none
zipCode	string	false	none	none
country	string	false	none	none

GetUserResult

null

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
status	string	false	none	none
email	string	false	none	none
phoneNumber	string	false	none	none
firstName	string	false	none	none
lastName	string	false	none	none
timeZone	string	false	none	none
locale	string	false	none	none
currency	string	false	none	none
effectiveRoleId	string	false	none	none
userName	string	false	none	none
salesforceUserName	string	false	none	none
name	string	false	none	none
roles	[Role]	false	none	none
userDetail	UserDetail	false	none	none
tenantId	string	false	none	none
lastLoginTime	string(date-time)	false	none	none
createdDate	string(date-time)	false	none	none
imageSignedUrl	string	false	none	none
mfaEnabled	boolean	false	none	none

Role

null

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
name	string	false	none	none
effective	boolean	false	none	none
functions	[string]	false	none	none
features	[string]	false	none	none

UserDetail

null

Properties

Name	Type	Required	Restrictions	Description
title	string	false	none	none
department	string	false	none	none
division	string	false	none	none
address	Address	false	none	none

FunctionVO

null

A list of functions this user role has access to.

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	Function name
functionPolicy	FunctionPolicy	false	none	none
featureName	string	false	none	Feature Name

RoleVO

null

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	The user role ID
name	string	false	none	The user role name
functions	[FunctionVO]	false	none	A list of functions this user role has access to.

LoginHistoryVO

null

Properties

Name	Type	Required	Restrictions	Description
userId	string	false	none	The user ID
tenantId	string	false	none	The tenant ID
browser	string	false	none	The browser or access point the user used to login with
loginTime	string(date-time)	false	none	The login time
status	string	false	none	The login status, Success or Error.
username	string	false	none	User Name
loginUrl	string	false	none	none
role	string	false	none	The user role.
errorMessage	string	false	none	The error message

Enumerated Values

Property	Value
status	Success
status	Error

title: Metadata v1.0 language_tabs: - shell: Shell - http: HTTP - javascript: JavaScript - ruby: Ruby - python: Python - php: PHP - java: Java - go: Go toc_footers: [] includes: [] search: false highlight_theme: darkula headingLevel: 2

Metadata v1.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Base URLs:

https://api.nue.io/v1

Authentication

HTTP Authentication, scheme: bearer
HTTP Authentication, scheme: basic

Layouts

A Layout represents page layouts or views of an object. Nue supports the following types of layouts:

List View: Represents the layout of a list of records;
Form View: Represents the form layout to create or update a record;
Search View: Represents the layout to search a record.

Create a Layout

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/metadata/layouts \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json;charset=UTF-8' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/metadata/layouts HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: application/json;charset=UTF-8

const inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json;charset=UTF-8',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/metadata/layouts',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json;charset=UTF-8',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/metadata/layouts',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json;charset=UTF-8',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/metadata/layouts', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json;charset=UTF-8',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/metadata/layouts', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/metadata/layouts");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json;charset=UTF-8"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/metadata/layouts", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /metadata/layouts

Create the metadata of a layout.

Body parameter

null

Parameters

Name	In	Type	Required	Description
body	body	CreateLayoutRequest	true	The request to create a layout.

Example responses

200 Response

null

Responses

Status	Meaning	Description	Schema
200	OK	OK	LayoutChecksumResponse

Delete Layouts

Code samples

# You can also use wget
curl -X DELETE https://api.nue.io/v1/metadata/layouts \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json;charset=UTF-8' \
  -H 'Authorization: Bearer {access-token}'

DELETE https://api.nue.io/v1/metadata/layouts HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: application/json;charset=UTF-8

const inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json;charset=UTF-8',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/metadata/layouts',
{
  method: 'DELETE',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json;charset=UTF-8',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete 'https://api.nue.io/v1/metadata/layouts',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json;charset=UTF-8',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('https://api.nue.io/v1/metadata/layouts', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json;charset=UTF-8',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.nue.io/v1/metadata/layouts', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/metadata/layouts");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json;charset=UTF-8"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.nue.io/v1/metadata/layouts", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /metadata/layouts

Delete a list of layouts.

Body parameter

null

Parameters

Name	In	Type	Required	Description
body	body	BatchLayoutsApiNameRequest	true	The request to delete layouts

Example responses

200 Response

null

Responses

Status	Meaning	Description	Schema
200	OK	OK	LayoutResponse

Get a Layout

Code samples

# You can also use wget
curl -X GET https://api.nue.io/v1/metadata/layouts/{layoutApiName} \
  -H 'Accept: application/json;charset=UTF-8' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.nue.io/v1/metadata/layouts/{layoutApiName} HTTP/1.1
Host: api.nue.io
Accept: application/json;charset=UTF-8


const headers = {
  'Accept':'application/json;charset=UTF-8',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/metadata/layouts/{layoutApiName}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json;charset=UTF-8',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/v1/metadata/layouts/{layoutApiName}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json;charset=UTF-8',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/v1/metadata/layouts/{layoutApiName}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json;charset=UTF-8',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/v1/metadata/layouts/{layoutApiName}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/metadata/layouts/{layoutApiName}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json;charset=UTF-8"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/v1/metadata/layouts/{layoutApiName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /metadata/layouts/{layoutApiName}

Retrieve the layout configuration of a given layout.

Parameters

Name	In	Type	Required	Description
layoutApiName	path	string	true	none

Example responses

200 Response

null

Responses

Status	Meaning	Description	Schema
200	OK	OK	GetLayoutDetailResponse

Update a Layout

Code samples

# You can also use wget
curl -X PATCH https://api.nue.io/v1/metadata/layouts/{layoutApiName} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json;charset=UTF-8' \
  -H 'Authorization: Bearer {access-token}'

PATCH https://api.nue.io/v1/metadata/layouts/{layoutApiName} HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: application/json;charset=UTF-8

const inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json;charset=UTF-8',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/metadata/layouts/{layoutApiName}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json;charset=UTF-8',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch 'https://api.nue.io/v1/metadata/layouts/{layoutApiName}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json;charset=UTF-8',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('https://api.nue.io/v1/metadata/layouts/{layoutApiName}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json;charset=UTF-8',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','https://api.nue.io/v1/metadata/layouts/{layoutApiName}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/metadata/layouts/{layoutApiName}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json;charset=UTF-8"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "https://api.nue.io/v1/metadata/layouts/{layoutApiName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PATCH /metadata/layouts/{layoutApiName}

Update the metadata of a layout.

Body parameter

null

Parameters

Name	In	Type	Required	Description
layoutApiName	path	string	true	The layout name.
body	body	UpdateLayoutRequest	true	The request to update a layout.

Example responses

200 Response

null

Responses

Status	Meaning	Description	Schema
200	OK	OK	LayoutChecksumResponse

Deactivate Layouts

Code samples

# You can also use wget
curl -X PATCH https://api.nue.io/v1/metadata/layouts/deactivate \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json;charset=UTF-8' \
  -H 'Authorization: Bearer {access-token}'

PATCH https://api.nue.io/v1/metadata/layouts/deactivate HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: application/json;charset=UTF-8

const inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json;charset=UTF-8',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/metadata/layouts/deactivate',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json;charset=UTF-8',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch 'https://api.nue.io/v1/metadata/layouts/deactivate',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json;charset=UTF-8',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('https://api.nue.io/v1/metadata/layouts/deactivate', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json;charset=UTF-8',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','https://api.nue.io/v1/metadata/layouts/deactivate', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/metadata/layouts/deactivate");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json;charset=UTF-8"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "https://api.nue.io/v1/metadata/layouts/deactivate", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PATCH /metadata/layouts/deactivate

Deactivate the list of layouts.

Body parameter

null

Parameters

Name	In	Type	Required	Description
body	body	BatchLayoutsApiNameRequest	true	The request to deactivate layouts

Example responses

200 Response

null

Responses

Status	Meaning	Description	Schema
200	OK	OK	LayoutResponse

Activate Layouts

Code samples

# You can also use wget
curl -X PATCH https://api.nue.io/v1/metadata/layouts/activate \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json;charset=UTF-8' \
  -H 'Authorization: Bearer {access-token}'

PATCH https://api.nue.io/v1/metadata/layouts/activate HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: application/json;charset=UTF-8

const inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json;charset=UTF-8',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/metadata/layouts/activate',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json;charset=UTF-8',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch 'https://api.nue.io/v1/metadata/layouts/activate',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json;charset=UTF-8',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('https://api.nue.io/v1/metadata/layouts/activate', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json;charset=UTF-8',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','https://api.nue.io/v1/metadata/layouts/activate', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/metadata/layouts/activate");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json;charset=UTF-8"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "https://api.nue.io/v1/metadata/layouts/activate", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PATCH /metadata/layouts/activate

Activate a list of layouts.

Body parameter

null

Parameters

Name	In	Type	Required	Description
body	body	BatchLayoutsApiNameRequest	true	The request to activate layouts

Example responses

200 Response

null

Responses

Status	Meaning	Description	Schema
200	OK	OK	LayoutResponse

Objects

An object field represents a certain attribute of a business object. Nue supports various types of standard and custom fields.

Sync Custom Fields

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/metadata/orders:sync-all \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/metadata/orders:sync-all HTTP/1.1
Host: api.nue.io


const headers = {
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/metadata/orders:sync-all',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/metadata/orders:sync-all',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/metadata/orders:sync-all', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/metadata/orders:sync-all', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/metadata/orders:sync-all");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/metadata/orders:sync-all", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /metadata/orders:sync-all

Synchronize custom fields of all objects in Revenue Manager, including Order, Invoice, etc.

Responses

Status	Meaning	Description	Schema
200	OK	OK	None

Delete Custom Field

Code samples

# You can also use wget
curl -X DELETE https://api.nue.io/v1/metadata/objects/{objectApiName}/fields/{fieldApiName} \
  -H 'Accept: application/json;charset=UTF-8' \
  -H 'Authorization: Bearer {access-token}'

DELETE https://api.nue.io/v1/metadata/objects/{objectApiName}/fields/{fieldApiName} HTTP/1.1
Host: api.nue.io
Accept: application/json;charset=UTF-8


const headers = {
  'Accept':'application/json;charset=UTF-8',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/metadata/objects/{objectApiName}/fields/{fieldApiName}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json;charset=UTF-8',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete 'https://api.nue.io/v1/metadata/objects/{objectApiName}/fields/{fieldApiName}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json;charset=UTF-8',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('https://api.nue.io/v1/metadata/objects/{objectApiName}/fields/{fieldApiName}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json;charset=UTF-8',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.nue.io/v1/metadata/objects/{objectApiName}/fields/{fieldApiName}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/metadata/objects/{objectApiName}/fields/{fieldApiName}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json;charset=UTF-8"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.nue.io/v1/metadata/objects/{objectApiName}/fields/{fieldApiName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /metadata/objects/{objectApiName}/fields/{fieldApiName}

Delete a custom field.

Parameters

Name	In	Type	Required	Description
objectApiName	path	string	true	The object name.
fieldApiName	path	string	true	The field name.

Example responses

200 Response

null

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Update Field Metadata

Code samples

# You can also use wget
curl -X PATCH https://api.nue.io/v1/metadata/objects/{objectApiName}/fields/{fieldApiName} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

PATCH https://api.nue.io/v1/metadata/objects/{objectApiName}/fields/{fieldApiName} HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: application/json

const inputBody = '{
  "autoNumberSetting": {
    "displayFormat": "CUSTOM-INV-{00000000}",
    "startValue": 1
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/metadata/objects/{objectApiName}/fields/{fieldApiName}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch 'https://api.nue.io/v1/metadata/objects/{objectApiName}/fields/{fieldApiName}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('https://api.nue.io/v1/metadata/objects/{objectApiName}/fields/{fieldApiName}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','https://api.nue.io/v1/metadata/objects/{objectApiName}/fields/{fieldApiName}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/metadata/objects/{objectApiName}/fields/{fieldApiName}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "https://api.nue.io/v1/metadata/objects/{objectApiName}/fields/{fieldApiName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PATCH /metadata/objects/{objectApiName}/fields/{fieldApiName}

Update the field metadata and currently only supports updating the format and starting value of an auto number field

Body parameter

Update Auto Number Metadata Request Example

{
  "autoNumberSetting": {
    "displayFormat": "CUSTOM-INV-{00000000}",
    "startValue": 1
  }
}

Parameters

Name	In	Type	Required	Description
objectApiName	path	string	true	The object name
fieldApiName	path	string	true	The field name
body	body	UpdateFieldRequest	true	The request to update a field's metadata.

Example responses

Update Field Metadata Response

{
  "name": "name"
}

Responses

Status	Meaning	Description	Schema
default	Default	default response	CreateFieldResponse

Describe all objects

Code samples

# You can also use wget
curl -X GET https://api.nue.io/v1/metadata/objects \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.nue.io/v1/metadata/objects HTTP/1.1
Host: api.nue.io
Accept: */*


const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/metadata/objects',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/v1/metadata/objects',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/v1/metadata/objects', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/v1/metadata/objects', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/metadata/objects");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/v1/metadata/objects", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /metadata/objects

Retrieve definition of all objects, including object properties, standard fields and custom fields.

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[DescribeRubyObjectResponse]	false	none	none
» apiName	string	false	none	none
» name	string	false	none	none
» description	string	false	none	none
» salesforceApiName	string	false	none	none
» endpoint	string	false	none	none
» customizable	boolean	false	none	none
» feature	string	false	none	none
» objectType	string	false	none	none
» pluralName	string	false	none	none
» nameField	string	false	none	none
» fields	[FieldMetadata]	false	none	none
»» apiName	string	false	none	none
»» name	string	false	none	none
»» type	string	false	none	none
»» description	string	false	none	none
»» creatable	boolean	false	none	none
»» updatable	boolean	false	none	none
»» filterable	boolean	false	none	none
»» sortable	boolean	false	none	none
»» customField	boolean	false	none	none
»» encrypted	boolean	false	none	none
»» defaultValue	string	false	none	none
»» inlineHelpText	string	false	none	none
»» required	boolean	false	none	none
»» unique	boolean	false	none	none
»» exportId	boolean	false	none	none
»» minLength	integer(int32)	false	none	none
»» maxLength	integer(int32)	false	none	none
»» valueSet	ValueSet	false	none	none
»»» apiName	string	false	none	none
»»» name	string	false	none	none
»»» defaultValue	string	false	none	none
»»» alphabeticallyOrdered	boolean	false	none	none
»»» valuePairs	[ValuePair]	false	none	none
»»»» apiName	string	false	none	none
»»»» name	string	false	none	none
»»»» orderNumber	integer(int32)	false	none	none
»»»» active	boolean	false	none	none
»» precision	integer(int32)	false	none	none
»» scale	integer(int32)	false	none	none
»» salesforceApiName	string	false	none	none
»» lookupRelation	LookupRelation	false	none	none
»»» referenceTo	string	false	none	none
»»» referenceField	string	false	none	none
»»» relationName	string	false	none	none
»»» relationLabel	string	false	none	none
»» masterDetailRelation	MasterDetailRelation	false	none	none
»»» referenceTo	string	false	none	none
»»» referenceField	string	false	none	none
»»» relationName	string	false	none	none
»»» relationLabel	string	false	none	none
»»» detailRelationName	string	false	none	none
»»» detailRelationLabel	string	false	none	none
»» autoNumberSetting	AutoNumberSetting	false	none	auto number customization settings including displayFormat and startValue
»»» displayFormat	string	false	none	Auto number display format
»»» startValue	integer(int64)	false	none	Starting number of the auto number field
» relations	[RelationMetadata]	false	none	none
»» referenceObjectName	string	false	none	none
»» referenceFieldName	string	false	none	none
»» relationFieldName	string	false	none	none
»» relationName	string	false	none	none
»» relationLabel	string	false	none	none
»» relationType	string	false	none	none
»» detailAccessPolicy	DetailAccessPolicy	false	none	none
»»» viewable	boolean	false	none	none
»»» creatable	boolean	false	none	none
»»» updatable	boolean	false	none	none

Get Object Definition

Code samples

# You can also use wget
curl -X GET https://api.nue.io/v1/metadata/objects/{objectName} \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.nue.io/v1/metadata/objects/{objectName} HTTP/1.1
Host: api.nue.io
Accept: */*


const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/metadata/objects/{objectName}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/v1/metadata/objects/{objectName}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/v1/metadata/objects/{objectName}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/v1/metadata/objects/{objectName}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/metadata/objects/{objectName}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/v1/metadata/objects/{objectName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /metadata/objects/{objectName}

Retrieve the object definition, including object properties, standard fields and custom fields.

Parameters

Name	In	Type	Required	Description
objectName	path	string	true	The object name, for example, `Customer`
withIntegrationMapping	query	boolean	false	Whether to include integration mapping

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	DescribeRubyObjectResponse

Get Custom Fields of Object

Code samples

# You can also use wget
curl -X GET https://api.nue.io/v1/metadata/objects/{objectApiName}/fields \
  -H 'Accept: application/json;charset=UTF-8' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.nue.io/v1/metadata/objects/{objectApiName}/fields HTTP/1.1
Host: api.nue.io
Accept: application/json;charset=UTF-8


const headers = {
  'Accept':'application/json;charset=UTF-8',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/metadata/objects/{objectApiName}/fields',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json;charset=UTF-8',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/v1/metadata/objects/{objectApiName}/fields',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json;charset=UTF-8',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/v1/metadata/objects/{objectApiName}/fields', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json;charset=UTF-8',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/v1/metadata/objects/{objectApiName}/fields', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/metadata/objects/{objectApiName}/fields");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json;charset=UTF-8"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/v1/metadata/objects/{objectApiName}/fields", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /metadata/objects/{objectApiName}/fields

Retrieve all custom fields of a given object identified by objectApiName

Parameters

Name	In	Type	Required	Description
objectApiName	path	string	true	The object name.

Example responses

200 Response

null

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[FieldMetadata]	false	none	none
» apiName	string	false	none	none
» name	string	false	none	none
» type	string	false	none	none
» description	string	false	none	none
» creatable	boolean	false	none	none
» updatable	boolean	false	none	none
» filterable	boolean	false	none	none
» sortable	boolean	false	none	none
» customField	boolean	false	none	none
» encrypted	boolean	false	none	none
» defaultValue	string	false	none	none
» inlineHelpText	string	false	none	none
» required	boolean	false	none	none
» unique	boolean	false	none	none
» exportId	boolean	false	none	none
» minLength	integer(int32)	false	none	none
» maxLength	integer(int32)	false	none	none
» valueSet	ValueSet	false	none	none
»» apiName	string	false	none	none
»» name	string	false	none	none
»» defaultValue	string	false	none	none
»» alphabeticallyOrdered	boolean	false	none	none
»» valuePairs	[ValuePair]	false	none	none
»»» apiName	string	false	none	none
»»» name	string	false	none	none
»»» orderNumber	integer(int32)	false	none	none
»»» active	boolean	false	none	none
» precision	integer(int32)	false	none	none
» scale	integer(int32)	false	none	none
» salesforceApiName	string	false	none	none
» lookupRelation	LookupRelation	false	none	none
»» referenceTo	string	false	none	none
»» referenceField	string	false	none	none
»» relationName	string	false	none	none
»» relationLabel	string	false	none	none
» masterDetailRelation	MasterDetailRelation	false	none	none
»» referenceTo	string	false	none	none
»» referenceField	string	false	none	none
»» relationName	string	false	none	none
»» relationLabel	string	false	none	none
»» detailRelationName	string	false	none	none
»» detailRelationLabel	string	false	none	none
» autoNumberSetting	AutoNumberSetting	false	none	auto number customization settings including displayFormat and startValue
»» displayFormat	string	false	none	Auto number display format
»» startValue	integer(int64)	false	none	Starting number of the auto number field

Filters

A Filter can be persisted for every Nue object based on the object attributes and shared to all Nue users.

Get Filter

Code samples

# You can also use wget
curl -X GET https://api.nue.io/v1/metadata/filters/{objectApiName} \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.nue.io/v1/metadata/filters/{objectApiName} HTTP/1.1
Host: api.nue.io
Accept: */*


const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/metadata/filters/{objectApiName}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/v1/metadata/filters/{objectApiName}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/v1/metadata/filters/{objectApiName}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/v1/metadata/filters/{objectApiName}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/metadata/filters/{objectApiName}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/v1/metadata/filters/{objectApiName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /metadata/filters/{objectApiName}

Retrieve the filter definition, given the object name and the filter ID.

Parameters

Name	In	Type	Required	Description
objectApiName	path	string	true	The object name.
id	path	string	true	The filter ID.

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	FilterMetadataVO

Create Filter

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/metadata/filters/{objectApiName} \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/metadata/filters/{objectApiName} HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/metadata/filters/{objectApiName}',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/metadata/filters/{objectApiName}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/metadata/filters/{objectApiName}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/metadata/filters/{objectApiName}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/metadata/filters/{objectApiName}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/metadata/filters/{objectApiName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /metadata/filters/{objectApiName}

Create a saved filter that is accessible by all Nue users.

Body parameter

null

Parameters

Name	In	Type	Required	Description
objectApiName	path	string	true	The object name.
body	body	ConfigureFilterRequest	true	The request to save a new filter

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	FilterMetadataVO

Delete Filter

Code samples

# You can also use wget
curl -X DELETE https://api.nue.io/v1/metadata/filters/{objectApiName}/{id} \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

DELETE https://api.nue.io/v1/metadata/filters/{objectApiName}/{id} HTTP/1.1
Host: api.nue.io
Accept: */*


const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/metadata/filters/{objectApiName}/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete 'https://api.nue.io/v1/metadata/filters/{objectApiName}/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('https://api.nue.io/v1/metadata/filters/{objectApiName}/{id}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.nue.io/v1/metadata/filters/{objectApiName}/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/metadata/filters/{objectApiName}/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.nue.io/v1/metadata/filters/{objectApiName}/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /metadata/filters/{objectApiName}/{id}

Delete a saved filter by ID.

Parameters

Name	In	Type	Required	Description
objectApiName	path	string	true	The object name.
id	path	string	true	The filter ID.

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	string

Update Filter

Code samples

# You can also use wget
curl -X PATCH https://api.nue.io/v1/metadata/filters/{objectApiName}/{id} \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

PATCH https://api.nue.io/v1/metadata/filters/{objectApiName}/{id} HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/metadata/filters/{objectApiName}/{id}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch 'https://api.nue.io/v1/metadata/filters/{objectApiName}/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('https://api.nue.io/v1/metadata/filters/{objectApiName}/{id}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','https://api.nue.io/v1/metadata/filters/{objectApiName}/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/metadata/filters/{objectApiName}/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "https://api.nue.io/v1/metadata/filters/{objectApiName}/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PATCH /metadata/filters/{objectApiName}/{id}

Update a saved filter.

Body parameter

null

Parameters

Name	In	Type	Required	Description
objectApiName	path	string	true	The object name.
id	path	string	true	The filter ID.
body	body	ConfigureFilterRequest	true	The request to update a filter

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	FilterMetadataVO

Get Filters

Code samples

# You can also use wget
curl -X GET https://api.nue.io/v1/metadata/filters/{objectApiName}/list \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.nue.io/v1/metadata/filters/{objectApiName}/list HTTP/1.1
Host: api.nue.io
Accept: */*


const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/metadata/filters/{objectApiName}/list',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/v1/metadata/filters/{objectApiName}/list',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/v1/metadata/filters/{objectApiName}/list', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/v1/metadata/filters/{objectApiName}/list', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/metadata/filters/{objectApiName}/list");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/v1/metadata/filters/{objectApiName}/list", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /metadata/filters/{objectApiName}/list

Retrieve a list of filter accessible by the current user.

Parameters

Name	In	Type	Required	Description
objectApiName	path	string	true	The object name.

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[FilterMetadataVO]	false	none	none
» conditions	[object]	false	none	none
»» additionalProperties	object	false	none	none
» name	string	false	none	none
» id	string	false	none	none

Value Sets

A value set is a set of picklist values that can be used for single-select and multi-select picklist fields.

Get Value Sets

Code samples

# You can also use wget
curl -X GET https://api.nue.io/v1/metadata/valueSets \
  -H 'Accept: application/json;charset=UTF-8' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.nue.io/v1/metadata/valueSets HTTP/1.1
Host: api.nue.io
Accept: application/json;charset=UTF-8


const headers = {
  'Accept':'application/json;charset=UTF-8',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/metadata/valueSets',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json;charset=UTF-8',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/v1/metadata/valueSets',
  params: {
  'names' => 'string'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json;charset=UTF-8',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/v1/metadata/valueSets', params={
  'names': null
}, headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json;charset=UTF-8',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/v1/metadata/valueSets', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/metadata/valueSets");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json;charset=UTF-8"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/v1/metadata/valueSets", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /metadata/valueSets

Retrieve values of value sets , given the value set names.

Parameters

Name	In	Type	Required	Description
names	query	string	true	The value set names. Eg: Name1,Name2

Example responses

200 Response

null

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[ValueSetResponse]	false	none	none
» apiName	string	false	none	none
» name	string	false	none	none
» values	[ValuePair]	false	none	none
»» apiName	string	false	none	none
»» name	string	false	none	none
»» orderNumber	integer(int32)	false	none	none
»» active	boolean	false	none	none
» defaultValue	string	false	none	none
» alphabeticallyOrdered	boolean	false	none	none

Create Value Set

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/metadata/valueSets \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/metadata/valueSets HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/metadata/valueSets',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/metadata/valueSets',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/metadata/valueSets', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/metadata/valueSets', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/metadata/valueSets");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/metadata/valueSets", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /metadata/valueSets

Create a value set

Body parameter

null

Parameters

Name	In	Type	Required	Description
body	body	CreateValueSetRequest	true	The request to create a value set.

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	CreateValueSetResponse

Sync Custom Fields

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/metadata/valueSets:sync-all

POST https://api.nue.io/v1/metadata/valueSets:sync-all HTTP/1.1
Host: api.nue.io


fetch('https://api.nue.io/v1/metadata/valueSets:sync-all',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.post 'https://api.nue.io/v1/metadata/valueSets:sync-all',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.post('https://api.nue.io/v1/metadata/valueSets:sync-all')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/metadata/valueSets:sync-all', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/metadata/valueSets:sync-all");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/metadata/valueSets:sync-all", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /metadata/valueSets:sync-all

Synchronize all custom fields from Salesforce. Please make sure the custom fields have been added into Field Set "Fields Expose to Nue" on Salesforce side.

Responses

Status	Meaning	Description	Schema
200	OK	OK	None

Sync Picklist Values

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/metadata/valueSets/{objectName}/{fieldName}:sync

POST https://api.nue.io/v1/metadata/valueSets/{objectName}/{fieldName}:sync HTTP/1.1
Host: api.nue.io


fetch('https://api.nue.io/v1/metadata/valueSets/{objectName}/{fieldName}:sync',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.post 'https://api.nue.io/v1/metadata/valueSets/{objectName}/{fieldName}:sync',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.post('https://api.nue.io/v1/metadata/valueSets/{objectName}/{fieldName}:sync')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/metadata/valueSets/{objectName}/{fieldName}:sync', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/metadata/valueSets/{objectName}/{fieldName}:sync");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/metadata/valueSets/{objectName}/{fieldName}:sync", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /metadata/valueSets/{objectName}/{fieldName}:sync

Synchronize a field-level value set by its object and field names.

Parameters

Name	In	Type	Required	Description
objectName	path	string	true	none
fieldName	path	string	true	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	None

Sync Global Value Sets

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/metadata/valueSets/{nueApiName}:sync

POST https://api.nue.io/v1/metadata/valueSets/{nueApiName}:sync HTTP/1.1
Host: api.nue.io


fetch('https://api.nue.io/v1/metadata/valueSets/{nueApiName}:sync',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.post 'https://api.nue.io/v1/metadata/valueSets/{nueApiName}:sync',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.post('https://api.nue.io/v1/metadata/valueSets/{nueApiName}:sync')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/metadata/valueSets/{nueApiName}:sync', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/metadata/valueSets/{nueApiName}:sync");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/metadata/valueSets/{nueApiName}:sync", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /metadata/valueSets/{nueApiName}:sync

Synchronize global value sets by their API names.

Parameters

Name	In	Type	Required	Description
nueApiName	path	string	true	none
crm-api-name	query	string	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	None

Get Value Set

Code samples

# You can also use wget
curl -X GET https://api.nue.io/v1/metadata/valueSets/{valueSetName} \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.nue.io/v1/metadata/valueSets/{valueSetName} HTTP/1.1
Host: api.nue.io
Accept: */*


const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/metadata/valueSets/{valueSetName}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/v1/metadata/valueSets/{valueSetName}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/v1/metadata/valueSets/{valueSetName}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/v1/metadata/valueSets/{valueSetName}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/metadata/valueSets/{valueSetName}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/v1/metadata/valueSets/{valueSetName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /metadata/valueSets/{valueSetName}

Retrieve values of a value set, given the value set name.

Parameters

Name	In	Type	Required	Description
valueSetName	path	string	true	The value set name.

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	CreateValueSetResponse

Delete Value Set

Code samples

# You can also use wget
curl -X DELETE https://api.nue.io/v1/metadata/valueSets/{valueSetName} \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

DELETE https://api.nue.io/v1/metadata/valueSets/{valueSetName} HTTP/1.1
Host: api.nue.io
Accept: */*


const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/metadata/valueSets/{valueSetName}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete 'https://api.nue.io/v1/metadata/valueSets/{valueSetName}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('https://api.nue.io/v1/metadata/valueSets/{valueSetName}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.nue.io/v1/metadata/valueSets/{valueSetName}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/metadata/valueSets/{valueSetName}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.nue.io/v1/metadata/valueSets/{valueSetName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /metadata/valueSets/{valueSetName}

Delete a value set, given the value set name.

Parameters

Name	In	Type	Required	Description
valueSetName	path	string	true	The value set name.

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Update Value Set

Code samples

# You can also use wget
curl -X PATCH https://api.nue.io/v1/metadata/valueSets/{valueSetName} \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

PATCH https://api.nue.io/v1/metadata/valueSets/{valueSetName} HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/metadata/valueSets/{valueSetName}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch 'https://api.nue.io/v1/metadata/valueSets/{valueSetName}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('https://api.nue.io/v1/metadata/valueSets/{valueSetName}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','https://api.nue.io/v1/metadata/valueSets/{valueSetName}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/metadata/valueSets/{valueSetName}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "https://api.nue.io/v1/metadata/valueSets/{valueSetName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PATCH /metadata/valueSets/{valueSetName}

Update a value set, given the value set name.

Body parameter

null

Parameters

Name	In	Type	Required	Description
valueSetName	path	string	true	The value set name.
body	body	CreateValueSetRequest	true	The request to update a value set.

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	CreateValueSetResponse

Update Value Set Values

Code samples

# You can also use wget
curl -X PATCH https://api.nue.io/v1/metadata/valueSets/{valueSetName}/values \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

PATCH https://api.nue.io/v1/metadata/valueSets/{valueSetName}/values HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/metadata/valueSets/{valueSetName}/values',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch 'https://api.nue.io/v1/metadata/valueSets/{valueSetName}/values',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('https://api.nue.io/v1/metadata/valueSets/{valueSetName}/values', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','https://api.nue.io/v1/metadata/valueSets/{valueSetName}/values', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/metadata/valueSets/{valueSetName}/values");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "https://api.nue.io/v1/metadata/valueSets/{valueSetName}/values", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PATCH /metadata/valueSets/{valueSetName}/values

Update a list of values in the value set.

Body parameter

null

Parameters

Name	In	Type	Required	Description
valueSetName	path	string	true	The value set name.
body	body	PatchValueSetValuesRequest	true	The request to update values in a value set.

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	CreateValueSetResponse

Schemas

CreateValueSetRequest

null

Properties

Name	Type	Required	Restrictions	Description
apiName	string	true	none	none
name	string	true	none	none
values	[ValuePair]	false	none	none
defaultValue	string	false	none	none
alphabeticallyOrdered	boolean	false	none	none

ValuePair

null

Properties

Name	Type	Required	Restrictions	Description
apiName	string	false	none	none
name	string	false	none	none
orderNumber	integer(int32)	false	none	none
active	boolean	false	none	none

CreateValueSetResponse

null

Properties

Name	Type	Required	Restrictions	Description
apiName	string	false	none	none
name	string	false	none	none
values	[ValuePair]	false	none	none
defaultValue	string	false	none	none
alphabeticallyOrdered	boolean	false	none	none

CreateLayoutRequest

null

Properties

Name	Type	Required	Restrictions	Description
type	string	true	none	none
apiName	string	true	none	none
name	string	true	none	none
objectApiName	string	false	none	none
content	string	false	none	none
tags	[string]	false	none	none

Enumerated Values

Property	Value
type	FormView
type	ListView
type	SearchView

LayoutChecksumResponse

null

Properties

Name	Type	Required	Restrictions	Description
status	string	false	none	none
message	string	false	none	none
apiName	string	false	none	none
contentChecksum	string	false	none	none

Enumerated Values

Property	Value
status	Succeeded
status	Failed

ConfigureFilterRequest

null

Properties

Name	Type	Required	Restrictions	Description
name	string	false	none	none
conditions	[object]	false	none	none
» additionalProperties	object	false	none	none

FilterMetadataVO

null

Properties

Name	Type	Required	Restrictions	Description
conditions	[object]	false	none	none
» additionalProperties	object	false	none	none
name	string	false	none	none
id	string	false	none	none

PatchValueSetValuesRequest

null

Properties

Name	Type	Required	Restrictions	Description
values	[ValuePair]	true	none	none

AutoNumberSetting

{
  "displayFormat": "CUSTOM-INV-{00000000}",
  "startValue": 1
}

auto number customization settings including displayFormat and startValue

Properties

Name	Type	Required	Restrictions	Description
displayFormat	string	false	none	Auto number display format
startValue	integer(int64)	false	none	Starting number of the auto number field

UpdateFieldRequest

null

Properties

Name	Type	Required	Restrictions	Description
name	string	false	none	none
description	string	false	none	none
creatable	boolean	false	none	none
updatable	boolean	false	none	none
filterable	boolean	false	none	none
sortable	boolean	false	none	none
encrypted	boolean	false	none	none
inlineHelpText	string	false	none	none
required	boolean	false	none	none
unique	boolean	false	none	none
length	integer(int32)	false	none	none
valueSet	string	false	none	none
precision	integer(int32)	false	none	none
scale	integer(int32)	false	none	none
autoNumberSetting	AutoNumberSetting	false	none	auto number customization settings including displayFormat and startValue

CreateFieldResponse

null

Properties

Name	Type	Required	Restrictions	Description
name	string	false	none	none

UpdateLayoutRequest

null

Properties

Name	Type	Required	Restrictions	Description
name	string	false	none	none
content	string	false	none	none
tags	[string]	false	none	none

BatchLayoutsApiNameRequest

null

Properties

Name	Type	Required	Restrictions	Description
layoutsApiName	[string]	true	none	none

LayoutResponse

null

Properties

Name	Type	Required	Restrictions	Description
status	string	false	none	none
message	string	false	none	none

Enumerated Values

Property	Value
status	Succeeded
status	Failed

ValueSetResponse

null

Properties

Name	Type	Required	Restrictions	Description
apiName	string	false	none	none
name	string	false	none	none
values	[ValuePair]	false	none	none
defaultValue	string	false	none	none
alphabeticallyOrdered	boolean	false	none	none

DescribeRubyObjectResponse

null

Properties

Name	Type	Required	Restrictions	Description
apiName	string	false	none	none
name	string	false	none	none
description	string	false	none	none
salesforceApiName	string	false	none	none
endpoint	string	false	none	none
customizable	boolean	false	none	none
feature	string	false	none	none
objectType	string	false	none	none
pluralName	string	false	none	none
nameField	string	false	none	none
fields	[FieldMetadata]	false	none	none
relations	[RelationMetadata]	false	none	none

DetailAccessPolicy

null

Properties

Name	Type	Required	Restrictions	Description
viewable	boolean	false	none	none
creatable	boolean	false	none	none
updatable	boolean	false	none	none

FieldMetadata

null

Properties

Name	Type	Required	Restrictions	Description
apiName	string	false	none	none
name	string	false	none	none
type	string	false	none	none
description	string	false	none	none
creatable	boolean	false	none	none
updatable	boolean	false	none	none
filterable	boolean	false	none	none
sortable	boolean	false	none	none
customField	boolean	false	none	none
encrypted	boolean	false	none	none
defaultValue	string	false	none	none
inlineHelpText	string	false	none	none
required	boolean	false	none	none
unique	boolean	false	none	none
exportId	boolean	false	none	none
minLength	integer(int32)	false	none	none
maxLength	integer(int32)	false	none	none
valueSet	ValueSet	false	none	none
precision	integer(int32)	false	none	none
scale	integer(int32)	false	none	none
salesforceApiName	string	false	none	none
lookupRelation	LookupRelation	false	none	none
masterDetailRelation	MasterDetailRelation	false	none	none
autoNumberSetting	AutoNumberSetting	false	none	auto number customization settings including displayFormat and startValue

LookupRelation

null

Properties

Name	Type	Required	Restrictions	Description
referenceTo	string	false	none	none
referenceField	string	false	none	none
relationName	string	false	none	none
relationLabel	string	false	none	none

MasterDetailRelation

null

Properties

Name	Type	Required	Restrictions	Description
referenceTo	string	false	none	none
referenceField	string	false	none	none
relationName	string	false	none	none
relationLabel	string	false	none	none
detailRelationName	string	false	none	none
detailRelationLabel	string	false	none	none

RelationMetadata

null

Properties

Name	Type	Required	Restrictions	Description
referenceObjectName	string	false	none	none
referenceFieldName	string	false	none	none
relationFieldName	string	false	none	none
relationName	string	false	none	none
relationLabel	string	false	none	none
relationType	string	false	none	none
detailAccessPolicy	DetailAccessPolicy	false	none	none

ValueSet

null

Properties

Name	Type	Required	Restrictions	Description
apiName	string	false	none	none
name	string	false	none	none
defaultValue	string	false	none	none
alphabeticallyOrdered	boolean	false	none	none
valuePairs	[ValuePair]	false	none	none

GetLayoutDetailResponse

null

Properties

Name	Type	Required	Restrictions	Description
status	string	false	none	none
message	string	false	none	none
layout	LayoutDetailInfo	false	none	none

Enumerated Values

Property	Value
status	Succeeded
status	Failed

LayoutDetailInfo

null

Properties

Name	Type	Required	Restrictions	Description
type	string	false	none	none
apiName	string	false	none	none
name	string	false	none	none
objectApiName	string	false	none	none
contentChecksum	string	false	none	none
layoutStatus	string	false	none	none
tags	[string]	false	none	none
content	string	false	none	none

Enumerated Values

Property	Value
type	FormView
type	ListView
type	SearchView
layoutStatus	Draft
layoutStatus	Active
layoutStatus	Inactive

title: LIFECYCLE MANAGER v1.0 language_tabs: - shell: Shell - http: HTTP - javascript: JavaScript - ruby: Ruby - python: Python - php: PHP - java: Java - go: Go toc_footers: [] includes: [] search: false highlight_theme: darkula headingLevel: 2

LIFECYCLE MANAGER v1.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Base URLs:

https://api.nue.io/v1

Authentication

HTTP Authentication, scheme: bearer
HTTP Authentication, scheme: basic

GraphQL Query

Support graphql query for entity: User Profile, UOM, Product, Product Feature, Product Option, Product Price Dimension, Price Book, Price Book Entry, Feature, Feature Price Dimension, Bundle Suite, Bundle Suite Bundle, Credit Conversion.

GraphQL Query API on GET

Code samples

# You can also use wget
curl -X GET https://api.nue.io/v1/async/graphql \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.nue.io/v1/async/graphql HTTP/1.1
Host: api.nue.io
Accept: application/json


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/async/graphql',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/v1/async/graphql',
  params: {
  'query' => 'string'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/v1/async/graphql', params={
  'query': null
}, headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/v1/async/graphql', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/async/graphql");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/v1/async/graphql", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /async/graphql

The graghQL query is passed in the URL.

Parameters

Name	In	Type	Required	Description
query	query	string	true	none
operationName	query	string	false	none
variables	query	string	false	none

Example responses

200 Response

null

400 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline
400	Bad Request	Bad Request	ErrorMessage

Response Schema

GraphQL Query API on POST

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/async/graphql \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Content-Type: null' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/async/graphql HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: application/json
Content-Type: null

const inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Content-Type':null,
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/async/graphql',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Content-Type' => null,
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/async/graphql',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Content-Type': null,
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/async/graphql', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Content-Type' => 'null',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/async/graphql', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/async/graphql");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Content-Type": []string{"null"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/async/graphql", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /async/graphql

The graghQL query is passed in the request body.

Body parameter

null

Parameters

Name	In	Type	Required	Description
Content-Type	header	string	false	none
query	query	string	false	none
operationName	query	string	false	none
variables	query	string	false	none
body	body	string	false	none

Example responses

200 Response

null

400 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline
400	Bad Request	Bad Request	ErrorMessage

Response Schema

Self Service Catalog

Product Catalog is a mirror cache of published products for self service.

Usage Rating

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/cpq/usage-rate \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/cpq/usage-rate HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/cpq/usage-rate',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/cpq/usage-rate',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/cpq/usage-rate', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/cpq/usage-rate', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/cpq/usage-rate");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/cpq/usage-rate", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /cpq/usage-rate

Price rate based on customer's usage

Body parameter

null

Parameters

Name	In	Type	Required	Description
body	body	BulkUsageRateRequest	true	none

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	BulkUsageRateResponse
400	Bad Request	Bad Request	ErrorMessage

Publish settings

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/catalog/usage-rating-options:publish \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/catalog/usage-rating-options:publish HTTP/1.1
Host: api.nue.io
Accept: */*


const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/catalog/usage-rating-options:publish',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/catalog/usage-rating-options:publish',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/catalog/usage-rating-options:publish', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/catalog/usage-rating-options:publish', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/catalog/usage-rating-options:publish");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/catalog/usage-rating-options:publish", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /catalog/usage-rating-options:publish

Publish Ruby settings for Self Service to access.

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline
400	Bad Request	Bad Request	ErrorMessage

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[RubySetting]	false	none	none
» id	string	false	none	none
» category	string	false	none	none
» subcategory	string	false	none	none
» name	string	false	none	none
» value	string	false	none	none

Republish products

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/catalog/products:republish \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/catalog/products:republish HTTP/1.1
Host: api.nue.io
Accept: */*


const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/catalog/products:republish',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/catalog/products:republish',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/catalog/products:republish', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/catalog/products:republish', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/catalog/products:republish");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/catalog/products:republish", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /catalog/products:republish

Republish published bundles and products to Nue mirror cache for Self Service to access.

Parameters

Name	In	Type	Required	Description
removeNonexistent	query	boolean	false	none

Example responses

400 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	None
400	Bad Request	Bad Request	ErrorMessage

Unpublish product

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/catalog/products/{id}:unpublish \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/catalog/products/{id}:unpublish HTTP/1.1
Host: api.nue.io
Accept: */*


const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/catalog/products/{id}:unpublish',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/catalog/products/{id}:unpublish',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/catalog/products/{id}:unpublish', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/catalog/products/{id}:unpublish', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/catalog/products/{id}:unpublish");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/catalog/products/{id}:unpublish", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /catalog/products/{id}:unpublish

Unpublish a product to Nue mirror cache for Self Service to access.

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Example responses

400 Response

Responses

Status	Meaning	Description	Schema
202	Accepted	Accepted	None
400	Bad Request	Bad Request	ErrorMessage

Publish product

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/catalog/products/{id}:publish \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/catalog/products/{id}:publish HTTP/1.1
Host: api.nue.io
Accept: */*


const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/catalog/products/{id}:publish',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/catalog/products/{id}:publish',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/catalog/products/{id}:publish', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/catalog/products/{id}:publish', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/catalog/products/{id}:publish");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/catalog/products/{id}:publish", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /catalog/products/{id}:publish

Publish a product to Nue mirror cache for Self Service to access.

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	Product
400	Bad Request	Bad Request	ErrorMessage

Outdate bundle suite

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/catalog/products/{id}:outdatePublishStatus \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/catalog/products/{id}:outdatePublishStatus HTTP/1.1
Host: api.nue.io
Accept: */*


const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/catalog/products/{id}:outdatePublishStatus',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/catalog/products/{id}:outdatePublishStatus',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/catalog/products/{id}:outdatePublishStatus', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/catalog/products/{id}:outdatePublishStatus', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/catalog/products/{id}:outdatePublishStatus");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/catalog/products/{id}:outdatePublishStatus", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /catalog/products/{id}:outdatePublishStatus

Set bundle suite publish status outdated.

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Example responses

400 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	None
400	Bad Request	Bad Request	ErrorMessage

Enable price book for self-service

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/catalog/priceBooks/{id}:enableSelfService \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/catalog/priceBooks/{id}:enableSelfService HTTP/1.1
Host: api.nue.io
Accept: */*


const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/catalog/priceBooks/{id}:enableSelfService',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/catalog/priceBooks/{id}:enableSelfService',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/catalog/priceBooks/{id}:enableSelfService', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/catalog/priceBooks/{id}:enableSelfService', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/catalog/priceBooks/{id}:enableSelfService");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/catalog/priceBooks/{id}:enableSelfService", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /catalog/priceBooks/{id}:enableSelfService

Enable Price Book Self Service.

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Example responses

400 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	None
400	Bad Request	Bad Request	ErrorMessage

Disable price book for self-service

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/catalog/priceBooks/{id}:disableSelfService \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/catalog/priceBooks/{id}:disableSelfService HTTP/1.1
Host: api.nue.io
Accept: */*


const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/catalog/priceBooks/{id}:disableSelfService',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/catalog/priceBooks/{id}:disableSelfService',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/catalog/priceBooks/{id}:disableSelfService', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/catalog/priceBooks/{id}:disableSelfService', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/catalog/priceBooks/{id}:disableSelfService");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/catalog/priceBooks/{id}:disableSelfService", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /catalog/priceBooks/{id}:disableSelfService

Disable Price Book Self Service.

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Example responses

400 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	None
400	Bad Request	Bad Request	ErrorMessage

Unpublish price tag

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/catalog/price-tags/{id}:unpublish \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/catalog/price-tags/{id}:unpublish HTTP/1.1
Host: api.nue.io
Accept: */*


const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/catalog/price-tags/{id}:unpublish',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/catalog/price-tags/{id}:unpublish',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/catalog/price-tags/{id}:unpublish', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/catalog/price-tags/{id}:unpublish', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/catalog/price-tags/{id}:unpublish");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/catalog/price-tags/{id}:unpublish", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /catalog/price-tags/{id}:unpublish

Unpublish a price tag to Nue mirror cache for Self Service to access.

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Example responses

400 Response

Responses

Status	Meaning	Description	Schema
202	Accepted	Accepted	None
400	Bad Request	Bad Request	ErrorMessage

Publish price tag

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/catalog/price-tags/{id}:publish \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/catalog/price-tags/{id}:publish HTTP/1.1
Host: api.nue.io
Accept: */*


const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/catalog/price-tags/{id}:publish',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/catalog/price-tags/{id}:publish',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/catalog/price-tags/{id}:publish', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/catalog/price-tags/{id}:publish', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/catalog/price-tags/{id}:publish");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/catalog/price-tags/{id}:publish", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /catalog/price-tags/{id}:publish

Publish a price tag to Nue mirror cache for Self Service to access.

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	PriceDimension
400	Bad Request	Bad Request	ErrorMessage

Outdate price tag

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/catalog/price-tags/{id}:outdatePublishStatus \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/catalog/price-tags/{id}:outdatePublishStatus HTTP/1.1
Host: api.nue.io
Accept: */*


const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/catalog/price-tags/{id}:outdatePublishStatus',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/catalog/price-tags/{id}:outdatePublishStatus',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/catalog/price-tags/{id}:outdatePublishStatus', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/catalog/price-tags/{id}:outdatePublishStatus', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/catalog/price-tags/{id}:outdatePublishStatus");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/catalog/price-tags/{id}:outdatePublishStatus", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /catalog/price-tags/{id}:outdatePublishStatus

Set price tag publish status outdated.

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Example responses

400 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	None
400	Bad Request	Bad Request	ErrorMessage

Publish object mapping settings

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/catalog/object-mapping-settings:publish \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/catalog/object-mapping-settings:publish HTTP/1.1
Host: api.nue.io
Accept: */*


const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/catalog/object-mapping-settings:publish',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/catalog/object-mapping-settings:publish',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/catalog/object-mapping-settings:publish', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/catalog/object-mapping-settings:publish', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/catalog/object-mapping-settings:publish");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/catalog/object-mapping-settings:publish", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /catalog/object-mapping-settings:publish

Publish object mapping settings for Self Service to access.

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline
400	Bad Request	Bad Request	ErrorMessage

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[ObjectMapping]	false	none	none
» id	string	false	none	none
» fromObject	string	false	none	none
» toObject	string	false	none	none
» fromField	string	false	none	none
» toField	string	false	none	none

Unpublish bundle suite

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/catalog/bundleSuites/{id}:unpublish \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/catalog/bundleSuites/{id}:unpublish HTTP/1.1
Host: api.nue.io
Accept: */*


const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/catalog/bundleSuites/{id}:unpublish',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/catalog/bundleSuites/{id}:unpublish',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/catalog/bundleSuites/{id}:unpublish', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/catalog/bundleSuites/{id}:unpublish', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/catalog/bundleSuites/{id}:unpublish");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/catalog/bundleSuites/{id}:unpublish", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /catalog/bundleSuites/{id}:unpublish

Unpublish a bundle suite to Nue mirror cache for Self Service to access.

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Example responses

400 Response

Responses

Status	Meaning	Description	Schema
202	Accepted	Accepted	None
400	Bad Request	Bad Request	ErrorMessage

Publish bundle suite

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/catalog/bundleSuites/{id}:publish \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/catalog/bundleSuites/{id}:publish HTTP/1.1
Host: api.nue.io
Accept: */*


const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/catalog/bundleSuites/{id}:publish',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/catalog/bundleSuites/{id}:publish',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/catalog/bundleSuites/{id}:publish', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/catalog/bundleSuites/{id}:publish', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/catalog/bundleSuites/{id}:publish");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/catalog/bundleSuites/{id}:publish", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /catalog/bundleSuites/{id}:publish

Publish a bundle suite to Nue mirror cache for Self Service to access.

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	BundleSuite
400	Bad Request	Bad Request	ErrorMessage

Outdate product

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/catalog/bundleSuites/{id}:outdatePublishStatus \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/catalog/bundleSuites/{id}:outdatePublishStatus HTTP/1.1
Host: api.nue.io
Accept: */*


const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/catalog/bundleSuites/{id}:outdatePublishStatus',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/catalog/bundleSuites/{id}:outdatePublishStatus',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/catalog/bundleSuites/{id}:outdatePublishStatus', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/catalog/bundleSuites/{id}:outdatePublishStatus', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/catalog/bundleSuites/{id}:outdatePublishStatus");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/catalog/bundleSuites/{id}:outdatePublishStatus", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /catalog/bundleSuites/{id}:outdatePublishStatus

Set product publish status outdated

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Example responses

400 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	None
400	Bad Request	Bad Request	ErrorMessage

Load products

Code samples

# You can also use wget
curl -X GET https://api.nue.io/v1/catalog/products \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.nue.io/v1/catalog/products HTTP/1.1
Host: api.nue.io
Accept: */*


const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/catalog/products',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/v1/catalog/products',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/v1/catalog/products', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/v1/catalog/products', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/catalog/products");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/v1/catalog/products", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /catalog/products

Load products from Nue mirror cache for Self Service to access.

Parameters

Name	In	Type	Required	Description
filter	query	string	false	none

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline
400	Bad Request	Bad Request	ErrorMessage

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[Product]	false	none	none
» id	string	false	none	none
» name	string	false	none	none
» sku	string	false	none	none
» recordType	string	false	none	none
» configurable	boolean	false	none	none
» soldIndependently	boolean	false	none	none
» status	string	false	none	none
» bundleTemplate	string	false	none	none
» description	string	false	none	none
» priceModel	string	false	none	none
» startDate	string	false	none	none
» endDate	string	false	none	none
» freeTrialUnit	integer(int32)	false	none	none
» freeTrialType	string	false	none	none
» productCategory	string	false	none	none
» autoRenew	boolean	false	none	none
» defaultRenewalTerm	number	false	none	none
» defaultSubscriptionTerm	integer(int32)	false	none	none
» billingTiming	string	false	none	none
» billingPeriod	string	false	none	none
» showIncludedProductOptions	boolean	false	none	none
» publishStatus	string	false	none	none
» lastPublishedById	string	false	none	none
» lastPublishedDate	string	false	none	none
» taxCode	string	false	none	none
» taxMode	string	false	none	none
» referenceProduct	Product	false	none	none
» uom	Uom	false	none	none
»» id	string	false	none	none
»» name	string	false	none	none
»» decimalScale	integer(int32)	false	none	none
»» roundingMode	string	false	none	none
»» quantityDimension	string	false	none	none
»» termDimension	string	false	none	none
» priceBook	PriceBook	false	none	none
»» id	string	false	none	none
»» name	string	false	none	none
»» description	string	false	none	none
»» standard	boolean	false	none	none
»» active	boolean	false	none	none
»» archived	boolean	false	none	none
»» selfServiceEnabled	boolean	false	none	none
» imageUrl	string	false	none	none
» evergreen	boolean	false	none	none
» carvesLiabilitySegment	string	false	none	none
» carvesRevenueSegment	string	false	none	none
» contractLiabilitySegment	string	false	none	none
» contractRevenueSegment	string	false	none	none
» creditConversionId	string	false	none	none
» creditConversion	CreditConversion	false	none	none
»» id	string	false	none	none
»» name	string	false	none	none
»» creditTypeId	string	false	none	none
»» uomQuantityDimension	string	false	none	none
»» uomQuantity	number	false	none	none
»» creditQuantity	number	false	none	none
»» conversionRate	number	false	none	none
»» decimalScale	integer(int32)	false	none	none
»» roundingMode	string	false	none	none
» priceBookEntries	[PriceBookEntry]	false	none	none
»» id	string	false	none	none
»» listPrice	number	false	none	none
»» active	boolean	false	none	none
»» currencyIsoCode	string	false	none	none
»» recommended	boolean	false	none	none
»» billingTiming	string	false	none	none
»» uom	Uom	false	none	none
»» priceBookId	string	false	none	none
»» pricingAttributes	[PricingAttribute]	false	none	none
»»» id	string	false	none	none
»»» name	string	false	none	none
»»» description	string	false	none	none
»»» mapping	string	false	none	none
»»» label	string	false	none	none
»»» value	string	false	none	none
» productFeatures	[ProductFeature]	false	none	none
»» id	string	false	none	none
»» name	string	false	none	none
»» featureOrder	integer(int32)	false	none	none
»» minOptions	integer(int32)	false	none	none
»» maxOptions	integer(int32)	false	none	none
»» featureName	string	false	none	none
»» featureDescription	string	false	none	none
»» feature	Feature	false	none	none
»»» id	string	false	none	none
»»» name	string	false	none	none
»»» imageSignedUrl	string	false	none	none
»»» status	string	false	none	none
»»» featurePriceTags	[FeaturePriceDimension]	false	none	none
»»»» id	string	false	none	none
»»»» name	string	false	none	none
»»»» serialNumber	integer(int32)	false	none	none
»»»» active	boolean	false	none	none
»»»» priceTag	PriceDimension	false	none	none
»»»»» id	string	false	none	none
»»»»» name	string	false	none	none
»»»»» description	string	false	none	none
»»»»» recordType	string	false	none	none
»»»»» priceTagType	string	false	none	none
»»»»» startTime	string	false	none	none
»»»»» endTime	string	false	none	none
»»»»» priceType	string	false	none	none
»»»»» active	boolean	false	none	none
»»»»» objectId	string	false	none	none
»»»»» objectType	string	false	none	none
»»»»» code	string	false	none	none
»»»»» uomDimension	string	false	none	none
»»»»» priceBook	PriceBook	false	none	none
»»»»» uom	Uom	false	none	none
»»»»» priceTiers	[PriceTier]	false	none	none
»»»»»» id	string	false	none	none
»»»»»» name	string	false	none	none
»»»»»» amount	number	false	none	none
»»»»»» chargeModel	string	false	none	none
»»»»»» discountPercentage	number	false	none	none
»»»»»» endUnit	number	false	none	none
»»»»»» endUnitDimension	string	false	none	none
»»»»»» startUnit	number	false	none	none
»»»»»» startUnitDimension	string	false	none	none
»»»»»» tierNumber	number	false	none	none
»»»»» publishStatus	string	false	none	none
»»»»» lastPublishedById	string	false	none	none
»»»»» lastPublishedDate	string	false	none	none
»» productOptions	[ProductOption]	false	none	none
»»» id	string	false	none	none
»»» name	string	false	none	none
»»» optionName	string	false	none	none
»»» optionOrder	integer(int32)	false	none	none
»»» optionType	string	false	none	none
»»» defaultQuantity	number	false	none	none
»»» includedQuantity	number	false	none	none
»»» minQuantity	number	false	none	none
»»» maxQuantity	number	false	none	none
»»» quantityEditable	boolean	false	none	none
»»» required	boolean	false	none	none
»»» bundled	boolean	false	none	none
»»» recommended	boolean	false	none	none
»»» independentPricing	boolean	false	none	none
»»» priceBookEntry	PriceBookEntry	false	none	none
»»» product	Product	false	none	none
»»» productOptionPriceTags	[ProductOptionPriceDimension]	false	none	none
»»»» id	string	false	none	none
»»»» name	string	false	none	none
»»»» serialNumber	integer(int32)	false	none	none
»»»» active	boolean	false	none	none
»»»» priceTag	PriceDimension	false	none	none
» productOptions	[ProductOption]	false	none	none
» productPriceTags	[ProductPriceDimension]	false	none	none
»» id	string	false	none	none
»» name	string	false	none	none
»» serialNumber	integer(int32)	false	none	none
»» active	boolean	false	none	none
»» priceBookEntry	PriceBookEntry	false	none	none
»» priceTag	PriceDimension	false	none	none
» carvesEligible	boolean	false	none	none
» customFields	object	false	none	none
»» additionalProperties	object	false	none	none

Enumerated Values

Property	Value
publishStatus	Unpublished
publishStatus	Published
publishStatus	Outdated
roundingMode	Up
roundingMode	Down
publishStatus	Unpublished
publishStatus	Published
publishStatus	Outdated

Load product

Code samples

# You can also use wget
curl -X GET https://api.nue.io/v1/catalog/products/{id} \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.nue.io/v1/catalog/products/{id} HTTP/1.1
Host: api.nue.io
Accept: */*


const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/catalog/products/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/v1/catalog/products/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/v1/catalog/products/{id}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/v1/catalog/products/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/catalog/products/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/v1/catalog/products/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /catalog/products/{id}

Load product by Id from Nue mirror cache for Self Service to access.

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	Product
400	Bad Request	Bad Request	ErrorMessage

Load price tags

Code samples

# You can also use wget
curl -X GET https://api.nue.io/v1/catalog/price-tags/{tagCode} \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.nue.io/v1/catalog/price-tags/{tagCode} HTTP/1.1
Host: api.nue.io
Accept: */*


const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/catalog/price-tags/{tagCode}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/v1/catalog/price-tags/{tagCode}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/v1/catalog/price-tags/{tagCode}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/v1/catalog/price-tags/{tagCode}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/catalog/price-tags/{tagCode}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/v1/catalog/price-tags/{tagCode}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /catalog/price-tags/{tagCode}

Load price tags from Nue mirror cache by price tag code for Self Service to access.

Parameters

Name	In	Type	Required	Description
tagCode	path	string	true	none

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	PriceDimension
400	Bad Request	Bad Request	ErrorMessage

Load object mapping settings

Code samples

# You can also use wget
curl -X GET https://api.nue.io/v1/catalog/object-mapping-settings \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.nue.io/v1/catalog/object-mapping-settings HTTP/1.1
Host: api.nue.io
Accept: */*


const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/catalog/object-mapping-settings',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/v1/catalog/object-mapping-settings',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/v1/catalog/object-mapping-settings', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/v1/catalog/object-mapping-settings', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/catalog/object-mapping-settings");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/v1/catalog/object-mapping-settings", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /catalog/object-mapping-settings

Load Object Mapping Settings from Nue mirror cache for Self Service to access.

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline
400	Bad Request	Bad Request	ErrorMessage

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[ObjectMapping]	false	none	none
» id	string	false	none	none
» fromObject	string	false	none	none
» toObject	string	false	none	none
» fromField	string	false	none	none
» toField	string	false	none	none

Load bundle suite by ID

Code samples

# You can also use wget
curl -X GET https://api.nue.io/v1/catalog/bundleSuites/{id} \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.nue.io/v1/catalog/bundleSuites/{id} HTTP/1.1
Host: api.nue.io
Accept: */*


const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/catalog/bundleSuites/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/v1/catalog/bundleSuites/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/v1/catalog/bundleSuites/{id}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/v1/catalog/bundleSuites/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/catalog/bundleSuites/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/v1/catalog/bundleSuites/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /catalog/bundleSuites/{id}

Load bundle suite by Id from Nue mirror cache for Self Service to access.

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	BundleSuite
400	Bad Request	Bad Request	ErrorMessage

Orders

Create and Activate Order

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/cpq/create-order \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/cpq/create-order HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/cpq/create-order',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/cpq/create-order',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/cpq/create-order', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/cpq/create-order', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/cpq/create-order");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/cpq/create-order", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /cpq/create-order

Create and activate a new order with order products. All order products will be created into subscriptions, assets and entitlements upon activation.

Body parameter

null

Parameters

Name	In	Type	Required	Description
body	body	CreateOrderRequest	true	Specify orders and order products

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	string
400	Bad Request	Bad Request	ErrorMessage

Create and Activate Change Order

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/cpq/change-order \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/cpq/change-order HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/cpq/change-order',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/cpq/change-order',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/cpq/change-order', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/cpq/change-order', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/cpq/change-order");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/cpq/change-order", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /cpq/change-order

Create and activate an order that makes changes to existing subscriptions and other assets. Generate and activate an invoice optionally when the order is to be activated. When activating an invoice, it can specify if the order and the invoice should be canceled upon payment fails.

Specify option parameter "activateOrder" to true to activate the order, "generateInvoice" to true to generate the invoice, "activateInvoice" to true to activate the invoice and "cancelOnPayment" to true to cancel activated the order and the invoice upon payment fails.

Body parameter

null

Parameters

Name	In	Type	Required	Description
body	body	ChangeOrderRequest	true	Specify orders and order products

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Create and Activate Change Order response	ChangeOrderResponse
400	Bad Request	Bad Request	ErrorMessage

Preview Change Order

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/cpq/change-order:preview \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/cpq/change-order:preview HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/cpq/change-order:preview',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/cpq/change-order:preview',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/cpq/change-order:preview', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/cpq/change-order:preview', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/cpq/change-order:preview");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/cpq/change-order:preview", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /cpq/change-order:preview

Preview an order that make changes to existing subscriptions and other assets.
It will not only preview the order price for the changes, but also billing information for today's charge and next billing period

Body parameter

null

Parameters

Name	In	Type	Required	Description
body	body	ChangeOrderRequest	true	Specify orders and order products

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Change order preview response	ChangeOrderPreviewBulkResponse
400	Bad Request	Bad Request	ErrorMessage

Adjust Prices of a bulk of subscriptions belonging to different accounts

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/cpq/change-order-in-bulk \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/cpq/change-order-in-bulk HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/cpq/change-order-in-bulk',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/cpq/change-order-in-bulk',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/cpq/change-order-in-bulk', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/cpq/change-order-in-bulk', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/cpq/change-order-in-bulk");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/cpq/change-order-in-bulk", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /cpq/change-order-in-bulk

Call this api to adjust prices for a big number of subscriptions belonging to different accounts, currencies, and price books.Generate and activate an invoice optionally when these orders is to be activated. When activating an invoice, it can specify if the order and the invoice should be canceled upon payment fails.

Body parameter

null

Parameters

Name	In	Type	Required	Description
body	body	AssetBulkChangeOrderRequest	true	none

Example responses

202 Response

Responses

Status	Meaning	Description	Schema
202	Accepted	The job created to run the change order.	JobCreateResponse
400	Bad Request	Bad Request	ErrorMessage

Get a job information

Code samples

# You can also use wget
curl -X GET https://api.nue.io/v1/cpq/change-order-in-bulk/jobs/{jobId} \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.nue.io/v1/cpq/change-order-in-bulk/jobs/{jobId} HTTP/1.1
Host: api.nue.io
Accept: */*


const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/cpq/change-order-in-bulk/jobs/{jobId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/v1/cpq/change-order-in-bulk/jobs/{jobId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/v1/cpq/change-order-in-bulk/jobs/{jobId}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/v1/cpq/change-order-in-bulk/jobs/{jobId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/cpq/change-order-in-bulk/jobs/{jobId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/v1/cpq/change-order-in-bulk/jobs/{jobId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /cpq/change-order-in-bulk/jobs/{jobId}

Get the job and its details information with the given job id

Parameters

Name	In	Type	Required	Description
jobId	path	string	true	none

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	GetJobResponse
400	Bad Request	Bad Request	ErrorMessage

Nue Objects

A Nue Object represents the properties and fields of a business object, for example, Product, Price Book, Subscription, etc. Nue provides a set of APIs to create, update, delete and query Nue objects in a generic, metadata-driven way.

To describe a Nue object, use the metadata API https://api.nue.io/api/metadata/objects/{objectName}, for example, https://api.nue.io/api/metadata/objects/Customer

Create an Object

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/objects/{objectName} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/objects/{objectName} HTTP/1.1
Host: api.nue.io
Accept: application/json


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/objects/{objectName}',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/objects/{objectName}',
  params: {
  'payload' => 'object'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/objects/{objectName}', params={
  'payload': null
}, headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/objects/{objectName}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/objects/{objectName}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/objects/{objectName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /objects/{objectName}

Create a new instance of the business object specified in objectName.

Parameters

Name	In	Type	Required	Description
objectName	path	string	true	none
payload	query	object	true	none

Example responses

400 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	None
400	Bad Request	Bad Request	ErrorMessage

Response Schema

Create Objects

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/objects/{objectName}List \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/objects/{objectName}List HTTP/1.1
Host: api.nue.io
Accept: application/json


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/objects/{objectName}List',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/objects/{objectName}List',
  params: {
  'objectCollection' => 'object'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/objects/{objectName}List', params={
  'objectCollection': null
}, headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/objects/{objectName}List', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/objects/{objectName}List");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/objects/{objectName}List", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /objects/{objectName}List

Create a list of new instances of the business object specified in objectName.

Parameters

Name	In	Type	Required	Description
objectName	path	string	true	none
objectCollection	query	object	true	none

Example responses

400 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	None
400	Bad Request	Bad Request	ErrorMessage

Response Schema

Delete Objects

Code samples

# You can also use wget
curl -X DELETE https://api.nue.io/v1/objects/{objectName}List \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

DELETE https://api.nue.io/v1/objects/{objectName}List HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: application/json

const inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/objects/{objectName}List',
{
  method: 'DELETE',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete 'https://api.nue.io/v1/objects/{objectName}List',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('https://api.nue.io/v1/objects/{objectName}List', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.nue.io/v1/objects/{objectName}List', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/objects/{objectName}List");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.nue.io/v1/objects/{objectName}List", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /objects/{objectName}List

Delete a list of object instances given the objectName.

Body parameter

null

Parameters

Name	In	Type	Required	Description
objectName	path	string	true	none
body	body	DeleteIds	true	The objects to delete.

Example responses

400 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	None
400	Bad Request	Bad Request	ErrorMessage

Response Schema

Patch Objects

Code samples

# You can also use wget
curl -X PATCH https://api.nue.io/v1/objects/{objectName}List \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

PATCH https://api.nue.io/v1/objects/{objectName}List HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: application/json

const inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/objects/{objectName}List',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch 'https://api.nue.io/v1/objects/{objectName}List',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('https://api.nue.io/v1/objects/{objectName}List', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','https://api.nue.io/v1/objects/{objectName}List', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/objects/{objectName}List");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "https://api.nue.io/v1/objects/{objectName}List", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PATCH /objects/{objectName}List

Patch a list of instances of the business object given the objectName.

Body parameter

null

Parameters

Name	In	Type	Required	Description
objectName	path	string	true	none
body	body	object	true	The list of objects to persist.

Example responses

400 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	None
400	Bad Request	Bad Request	ErrorMessage

Response Schema

Composite CRUD

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/objects/composite/{objectName}List \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/objects/composite/{objectName}List HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: application/json

const inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/objects/composite/{objectName}List',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/objects/composite/{objectName}List',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/objects/composite/{objectName}List', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/objects/composite/{objectName}List', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/objects/composite/{objectName}List");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/objects/composite/{objectName}List", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /objects/composite/{objectName}List

A composite CRUD operation that can operate a hybrid list of objects, for example, create, update, or delete a list of objects.

Body parameter

null

Parameters

Name	In	Type	Required	Description
objectName	path	string	true	none
body	body	CompositePersistentObjectCollection	true	The composite objects to operate on

Example responses

200 Response

null

400 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	CompositePersistentObjectResponse
400	Bad Request	Bad Request	ErrorMessage

Delete an Object

Code samples

# You can also use wget
curl -X DELETE https://api.nue.io/v1/objects/{objectName}/{id} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

DELETE https://api.nue.io/v1/objects/{objectName}/{id} HTTP/1.1
Host: api.nue.io
Accept: application/json


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/objects/{objectName}/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete 'https://api.nue.io/v1/objects/{objectName}/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('https://api.nue.io/v1/objects/{objectName}/{id}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.nue.io/v1/objects/{objectName}/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/objects/{objectName}/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.nue.io/v1/objects/{objectName}/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /objects/{objectName}/{id}

Delete an object instance given the id and the objectName.

Parameters

Name	In	Type	Required	Description
objectName	path	string	true	none
id	path	string	true	none

Example responses

200 Response

null

400 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline
400	Bad Request	Bad Request	ErrorMessage

Response Schema

Patch an Object

Code samples

# You can also use wget
curl -X PATCH https://api.nue.io/v1/objects/{objectName}/{id} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

PATCH https://api.nue.io/v1/objects/{objectName}/{id} HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: application/json

const inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/objects/{objectName}/{id}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch 'https://api.nue.io/v1/objects/{objectName}/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('https://api.nue.io/v1/objects/{objectName}/{id}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','https://api.nue.io/v1/objects/{objectName}/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/objects/{objectName}/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "https://api.nue.io/v1/objects/{objectName}/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PATCH /objects/{objectName}/{id}

Patch an instance of the business object given the id and the objectName.

Body parameter

null

Parameters

Name	In	Type	Required	Description
objectName	path	string	true	none
id	path	string	true	none
body	body	object	true	The object to persist.

Example responses

400 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	None
400	Bad Request	Bad Request	ErrorMessage

Response Schema

Export and Import

Create Import Job

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/cpq/async/imports \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/cpq/async/imports HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/cpq/async/imports',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/cpq/async/imports',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/cpq/async/imports', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/cpq/async/imports', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/cpq/async/imports");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/cpq/async/imports", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /cpq/async/imports

Create an import job to import a single type of object type.

Body parameter

null

Parameters

Name	In	Type	Required	Description
body	body	CreateImportRequest	true	Specify the file format and object name.

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	string
400	Bad Request	Bad Request	ErrorMessage

Import products and pricing data

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/cpq/async/imports/revenue-builder-data \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/cpq/async/imports/revenue-builder-data HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/cpq/async/imports/revenue-builder-data',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/cpq/async/imports/revenue-builder-data',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/cpq/async/imports/revenue-builder-data', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/cpq/async/imports/revenue-builder-data', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/cpq/async/imports/revenue-builder-data");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/cpq/async/imports/revenue-builder-data", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /cpq/async/imports/revenue-builder-data

Create an import job to import a list of product and pricing objects.

Body parameter

null

Parameters

Name	In	Type	Required	Description
import-operation	query	string	false	The type of import operation to perform, either insert or upsert
body	body	object	false	none
» uom	body	string(binary)	false	Unit of measure import file
» credit-type	body	string(binary)	false	Credit types import file
» credit-pool	body	string(binary)	false	Credit pools import file
» credit-conversion	body	string(binary)	false	Credit conversion import file
» price-book	body	string(binary)	false	Price books import file
» price-tag	body	string(binary)	false	Price tags import file
» product-group	body	string(binary)	false	Product groups import file
» product	body	string(binary)	false	Standalone products import file
» bundle	body	string(binary)	false	Bundle products import file
» bundle-suite	body	string(binary)	false	Bundle suites import file
» product-relationship	body	string(binary)	false	Product relationships import file
» custom-setting	body	string(binary)	false	Custom settings import file

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline
400	Bad Request	Bad Request	ErrorMessage

Response Schema

Create Data Export Job

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/cpq/async/exports \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/cpq/async/exports HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/cpq/async/exports',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/cpq/async/exports',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/cpq/async/exports', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/cpq/async/exports', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/cpq/async/exports");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/cpq/async/exports", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /cpq/async/exports

Body parameter

null

Parameters

Name	In	Type	Required	Description
body	body	CreateExportRequest	true	Specify the file format and object name.

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	string
400	Bad Request	Bad Request	ErrorMessage

Create Export Job with GraphQL Filter

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/async/graphql/exports \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/async/graphql/exports HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/async/graphql/exports',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/async/graphql/exports',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/async/graphql/exports', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/async/graphql/exports', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/async/graphql/exports");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/async/graphql/exports", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /async/graphql/exports

Create an export job with GraphQL filtering condition.

To construct a GraphQL filter, login to Nue, and navigate to System Settings > GraphQL Generator, and use the generated GraphQL query to create the export request.

To retrieve the export result, use API https://api.nue.io/async/exports/exportJobId

Body parameter

null

Parameters

Name	In	Type	Required	Description
format	query	string	false	none
objectName	query	string	false	none
body	body	string	true	none

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	string
400	Bad Request	Bad Request	ErrorMessage

Upload Import File

Code samples

# You can also use wget
curl -X PATCH https://api.nue.io/v1/cpq/async/imports/{jobId}/content \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

PATCH https://api.nue.io/v1/cpq/async/imports/{jobId}/content HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/cpq/async/imports/{jobId}/content',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch 'https://api.nue.io/v1/cpq/async/imports/{jobId}/content',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('https://api.nue.io/v1/cpq/async/imports/{jobId}/content', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','https://api.nue.io/v1/cpq/async/imports/{jobId}/content', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/cpq/async/imports/{jobId}/content");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "https://api.nue.io/v1/cpq/async/imports/{jobId}/content", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PATCH /cpq/async/imports/{jobId}/content

Upload the file content for the import job.

Before calling this API, call Create Import Job first to get an import job ID.

Body parameter

null

Parameters

Name	In	Type	Required	Description
jobId	path	string	true	The import job ID
body	body	object	false	none
» data	body	string(binary)	true	Import file. The object type referenced in the file needs to match the object name specified with the import job.

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	string
400	Bad Request	Bad Request	ErrorMessage

Get Import Job Status

Code samples

# You can also use wget
curl -X GET https://api.nue.io/v1/cpq/async/imports/{jobId} \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.nue.io/v1/cpq/async/imports/{jobId} HTTP/1.1
Host: api.nue.io
Accept: */*


const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/cpq/async/imports/{jobId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/v1/cpq/async/imports/{jobId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/v1/cpq/async/imports/{jobId}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/v1/cpq/async/imports/{jobId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/cpq/async/imports/{jobId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/v1/cpq/async/imports/{jobId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /cpq/async/imports/{jobId}

Retrieve the status of the import job.

Parameters

Name	In	Type	Required	Description
jobId	path	string	true	The import job ID

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	string
400	Bad Request	Bad Request	ErrorMessage

Get Products and Pricing Import Status

Code samples

# You can also use wget
curl -X GET https://api.nue.io/v1/cpq/async/imports/revenue-builder-data/{jobId} \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.nue.io/v1/cpq/async/imports/revenue-builder-data/{jobId} HTTP/1.1
Host: api.nue.io
Accept: */*


const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/cpq/async/imports/revenue-builder-data/{jobId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/v1/cpq/async/imports/revenue-builder-data/{jobId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/v1/cpq/async/imports/revenue-builder-data/{jobId}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/v1/cpq/async/imports/revenue-builder-data/{jobId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/cpq/async/imports/revenue-builder-data/{jobId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/v1/cpq/async/imports/revenue-builder-data/{jobId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /cpq/async/imports/revenue-builder-data/{jobId}

Retrieve the product and pricing import job status.

Parameters

Name	In	Type	Required	Description
jobId	path	string	true	The import job ID.

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline
400	Bad Request	Bad Request	ErrorMessage

Response Schema

Get Data Export Job Status

Code samples

# You can also use wget
curl -X GET https://api.nue.io/v1/cpq/async/exports/{jobId} \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.nue.io/v1/cpq/async/exports/{jobId} HTTP/1.1
Host: api.nue.io
Accept: */*


const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/cpq/async/exports/{jobId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/v1/cpq/async/exports/{jobId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/v1/cpq/async/exports/{jobId}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/v1/cpq/async/exports/{jobId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/cpq/async/exports/{jobId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/v1/cpq/async/exports/{jobId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /cpq/async/exports/{jobId}

Retrieve the status of the data export job.

Parameters

Name	In	Type	Required	Description
jobId	path	string	true	The export job ID.

Example responses

400 Response

default Response

null

Responses

Status	Meaning	Description	Schema
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Job ID not found	ExportJobResponse
default	Default	The export results.	ExportJobResponse

Prices

Provide a list of services for price books, price tags, and other pricing structures.

Replicate Price Tag

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/objects/PriceDimension/{id}:duplicate \
  -H 'Accept: application/json'

POST https://api.nue.io/v1/objects/PriceDimension/{id}:duplicate HTTP/1.1
Host: api.nue.io
Accept: application/json


const headers = {
  'Accept':'application/json'
};

fetch('https://api.nue.io/v1/objects/PriceDimension/{id}:duplicate',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'https://api.nue.io/v1/objects/PriceDimension/{id}:duplicate',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('https://api.nue.io/v1/objects/PriceDimension/{id}:duplicate', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/objects/PriceDimension/{id}:duplicate', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/objects/PriceDimension/{id}:duplicate");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/objects/PriceDimension/{id}:duplicate", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /objects/PriceDimension/{id}:duplicate

Replicate a price tag into a new price tag.

Parameters

Name	In	Type	Required	Description
id	path	string	true	The ID of the price tag to replicate from.

Example responses

400 Response

Responses

Status	Meaning	Description	Schema
200	OK	Returns the replicated price tag ID.	None
400	Bad Request	Bad Request	ErrorMessage

Response Schema

Copy Price Book

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/objects/PriceBook/{id}:copy \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*'

POST https://api.nue.io/v1/objects/PriceBook/{id}:copy HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*'
};

fetch('https://api.nue.io/v1/objects/PriceBook/{id}:copy',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*'
}

result = RestClient.post 'https://api.nue.io/v1/objects/PriceBook/{id}:copy',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*'
}

r = requests.post('https://api.nue.io/v1/objects/PriceBook/{id}:copy', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/objects/PriceBook/{id}:copy', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/objects/PriceBook/{id}:copy");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/objects/PriceBook/{id}:copy", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /objects/PriceBook/{id}:copy

Copy the price book entries from an existing price book.

Body parameter

null

Parameters

Name	In	Type	Required	Description
id	path	string	true	The price book to copy from.
body	body	CopyPriceBookRequest	true	Specify the file format and object name.

Example responses

400 Response

Responses

Status	Meaning	Description	Schema
202	Accepted	Accepted	None
400	Bad Request	Bad Request	ErrorMessage

Clone Price Book

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/objects/PriceBook/{id}:clone \
  -H 'Accept: */*'

POST https://api.nue.io/v1/objects/PriceBook/{id}:clone HTTP/1.1
Host: api.nue.io
Accept: */*


const headers = {
  'Accept':'*/*'
};

fetch('https://api.nue.io/v1/objects/PriceBook/{id}:clone',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*'
}

result = RestClient.post 'https://api.nue.io/v1/objects/PriceBook/{id}:clone',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*'
}

r = requests.post('https://api.nue.io/v1/objects/PriceBook/{id}:clone', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/objects/PriceBook/{id}:clone', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/objects/PriceBook/{id}:clone");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/objects/PriceBook/{id}:clone", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /objects/PriceBook/{id}:clone

Clone an existing pricebook into a new one without copying over the price book entries.

Parameters

Name	In	Type	Required	Description
id	path	string	true	The price book to clone from.

Example responses

201 Response

Responses

Status	Meaning	Description	Schema
201	Created	Created	string
400	Bad Request	Bad Request	ErrorMessage

Products

A product defines a physical product, a recurring service or a one-time service that is manufactured or provisioned for sale.

A bundle product represents a set of products or services sold together with one price. A bundle product itself is a product. It shares all the attributes and capability of a standalone product. In addition, it contains one or more layers of product options that defines the optionality of a list of products included in the bundle.

All APIs should be used with base URL https://api.nue.io/

Deactivate Products

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/objects/ProductList:deactivate \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

POST https://api.nue.io/v1/objects/ProductList:deactivate HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: application/json

const inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.nue.io/v1/objects/ProductList:deactivate',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'https://api.nue.io/v1/objects/ProductList:deactivate',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.nue.io/v1/objects/ProductList:deactivate', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/objects/ProductList:deactivate', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/objects/ProductList:deactivate");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/objects/ProductList:deactivate", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /objects/ProductList:deactivate

Deactivate a list of products.

Body parameter

null

Parameters

Name	In	Type	Required	Description
body	body	ProductListRequest	true	Specify a list of products

Example responses

400 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	None
400	Bad Request	Bad Request	ErrorMessage

Response Schema

Activate Products

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/objects/ProductList:activate \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

POST https://api.nue.io/v1/objects/ProductList:activate HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: application/json

const inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.nue.io/v1/objects/ProductList:activate',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'https://api.nue.io/v1/objects/ProductList:activate',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.nue.io/v1/objects/ProductList:activate', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/objects/ProductList:activate', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/objects/ProductList:activate");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/objects/ProductList:activate", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /objects/ProductList:activate

Activate a list of products.

Body parameter

null

Parameters

Name	In	Type	Required	Description
body	body	ProductListRequest	true	Specify a list of products

Example responses

400 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	None
400	Bad Request	Bad Request	ErrorMessage

Response Schema

Replicate Product

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/objects/Product/{id}:duplicate \
  -H 'Accept: application/json'

POST https://api.nue.io/v1/objects/Product/{id}:duplicate HTTP/1.1
Host: api.nue.io
Accept: application/json


const headers = {
  'Accept':'application/json'
};

fetch('https://api.nue.io/v1/objects/Product/{id}:duplicate',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'https://api.nue.io/v1/objects/Product/{id}:duplicate',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('https://api.nue.io/v1/objects/Product/{id}:duplicate', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/objects/Product/{id}:duplicate', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/objects/Product/{id}:duplicate");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/objects/Product/{id}:duplicate", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /objects/Product/{id}:duplicate

Replicate a product or bundle product into another product or bundle product.

Parameters

Name	In	Type	Required	Description
id	path	string	true	The Product ID

Example responses

400 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	None
400	Bad Request	Bad Request	ErrorMessage

Response Schema

Deactivate a Product

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/objects/Product/{id}:deactivate \
  -H 'Accept: application/json'

POST https://api.nue.io/v1/objects/Product/{id}:deactivate HTTP/1.1
Host: api.nue.io
Accept: application/json


const headers = {
  'Accept':'application/json'
};

fetch('https://api.nue.io/v1/objects/Product/{id}:deactivate',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'https://api.nue.io/v1/objects/Product/{id}:deactivate',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('https://api.nue.io/v1/objects/Product/{id}:deactivate', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/objects/Product/{id}:deactivate', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/objects/Product/{id}:deactivate");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/objects/Product/{id}:deactivate", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /objects/Product/{id}:deactivate

Deactivate a given product.

Parameters

Name	In	Type	Required	Description
id	path	string	true	The Product ID

Example responses

400 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	None
400	Bad Request	Bad Request	ErrorMessage

Response Schema

Convert to Bundle

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/objects/Product/{id}:convertToBundle \
  -H 'Accept: application/json'

POST https://api.nue.io/v1/objects/Product/{id}:convertToBundle HTTP/1.1
Host: api.nue.io
Accept: application/json


const headers = {
  'Accept':'application/json'
};

fetch('https://api.nue.io/v1/objects/Product/{id}:convertToBundle',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'https://api.nue.io/v1/objects/Product/{id}:convertToBundle',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('https://api.nue.io/v1/objects/Product/{id}:convertToBundle', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/objects/Product/{id}:convertToBundle', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/objects/Product/{id}:convertToBundle");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/objects/Product/{id}:convertToBundle", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /objects/Product/{id}:convertToBundle

Convert a standalone product into a bundle product.

Parameters

Name	In	Type	Required	Description
id	path	string	true	The Product ID

Example responses

400 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	None
400	Bad Request	Bad Request	ErrorMessage

Response Schema

Upload Image

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/objects/Product/{id}:addImage \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

POST https://api.nue.io/v1/objects/Product/{id}:addImage HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: application/json

const inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.nue.io/v1/objects/Product/{id}:addImage',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'https://api.nue.io/v1/objects/Product/{id}:addImage',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.nue.io/v1/objects/Product/{id}:addImage', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/objects/Product/{id}:addImage', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/objects/Product/{id}:addImage");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/objects/Product/{id}:addImage", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /objects/Product/{id}:addImage

Upload product image of a given product.

Body parameter

null

Parameters

Name	In	Type	Required	Description
id	path	string	true	The Product ID
body	body	object	false	none
» file	body	string(binary)	true	none

Example responses

400 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	None
400	Bad Request	Bad Request	ErrorMessage

Response Schema

Activate a Product

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/objects/Product/{id}:activate \
  -H 'Accept: application/json'

POST https://api.nue.io/v1/objects/Product/{id}:activate HTTP/1.1
Host: api.nue.io
Accept: application/json


const headers = {
  'Accept':'application/json'
};

fetch('https://api.nue.io/v1/objects/Product/{id}:activate',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'https://api.nue.io/v1/objects/Product/{id}:activate',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('https://api.nue.io/v1/objects/Product/{id}:activate', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/objects/Product/{id}:activate', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/objects/Product/{id}:activate");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/objects/Product/{id}:activate", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /objects/Product/{id}:activate

Deactivate a given product.

Parameters

Name	In	Type	Required	Description
id	path	string	true	The Product ID

Example responses

400 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	None
400	Bad Request	Bad Request	ErrorMessage

Response Schema

Get Image

Code samples

# You can also use wget
curl -X GET https://api.nue.io/v1/objects/Product/{id}:getImage \
  -H 'Accept: application/json'

GET https://api.nue.io/v1/objects/Product/{id}:getImage HTTP/1.1
Host: api.nue.io
Accept: application/json


const headers = {
  'Accept':'application/json'
};

fetch('https://api.nue.io/v1/objects/Product/{id}:getImage',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api.nue.io/v1/objects/Product/{id}:getImage',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.nue.io/v1/objects/Product/{id}:getImage', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/v1/objects/Product/{id}:getImage', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/objects/Product/{id}:getImage");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/v1/objects/Product/{id}:getImage", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /objects/Product/{id}:getImage

Retrieve the product image of a given product.

Parameters

Name	In	Type	Required	Description
id	path	string	true	The Product ID

Example responses

400 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	None
400	Bad Request	Bad Request	ErrorMessage

Response Schema

Get Referenced Products

Code samples

# You can also use wget
curl -X GET https://api.nue.io/v1/objects/Product/{id}/referenceProducts \
  -H 'Accept: application/json'

GET https://api.nue.io/v1/objects/Product/{id}/referenceProducts HTTP/1.1
Host: api.nue.io
Accept: application/json


const headers = {
  'Accept':'application/json'
};

fetch('https://api.nue.io/v1/objects/Product/{id}/referenceProducts',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api.nue.io/v1/objects/Product/{id}/referenceProducts',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.nue.io/v1/objects/Product/{id}/referenceProducts', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/v1/objects/Product/{id}/referenceProducts', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/objects/Product/{id}/referenceProducts");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/v1/objects/Product/{id}/referenceProducts", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /objects/Product/{id}/referenceProducts

Get a list of referenced products of a bundle.

When a bundle product is created by inheriting product options of another bundle product, the product options of the other bundle product are referenced products.

Parameters

Name	In	Type	Required	Description
id	path	string	true	The Product ID

Example responses

400 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	None
400	Bad Request	Bad Request	ErrorMessage

Response Schema

System Settings

Import Settings

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/cpq/settings/setting:import \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/cpq/settings/setting:import HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/cpq/settings/setting:import',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/cpq/settings/setting:import',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/cpq/settings/setting:import', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/cpq/settings/setting:import', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/cpq/settings/setting:import");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/cpq/settings/setting:import", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /cpq/settings/setting:import

Import system setting to a tenant.

Body parameter

null

Parameters

Name	In	Type	Required	Description
body	body	SettingsImportAndExportVO	true	none

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	string
400	Bad Request	Bad Request	ErrorMessage

Get Quantity Tier Attributes.

Code samples

# You can also use wget
curl -X GET https://api.nue.io/v1/cpq/ruby_settings/quantityTierAttributes \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.nue.io/v1/cpq/ruby_settings/quantityTierAttributes HTTP/1.1
Host: api.nue.io
Accept: */*


const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/cpq/ruby_settings/quantityTierAttributes',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/v1/cpq/ruby_settings/quantityTierAttributes',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/v1/cpq/ruby_settings/quantityTierAttributes', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/v1/cpq/ruby_settings/quantityTierAttributes', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/cpq/ruby_settings/quantityTierAttributes");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/v1/cpq/ruby_settings/quantityTierAttributes", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /cpq/ruby_settings/quantityTierAttributes

Get all quantity tier attributes.

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline
400	Bad Request	Bad Request	ErrorMessage

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[QuantityTierAttribute]	false	none	[Quantity tier attribute object.]
» apiName	string	false	none	Api name of the quantity tier attribute
» name	string	false	none	Display name of the quantity tier attribute
» description	string	false	none	Description of the quantity tier attribute
» mapping	string	false	none	Mapping field of the quantity tier attribute
» active	boolean	false	none	Status of the quantity tier attribute

Create Quantity Tier Attributes.

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/cpq/ruby_settings/quantityTierAttributes \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/cpq/ruby_settings/quantityTierAttributes HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/cpq/ruby_settings/quantityTierAttributes',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/cpq/ruby_settings/quantityTierAttributes',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/cpq/ruby_settings/quantityTierAttributes', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/cpq/ruby_settings/quantityTierAttributes', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/cpq/ruby_settings/quantityTierAttributes");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/cpq/ruby_settings/quantityTierAttributes", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /cpq/ruby_settings/quantityTierAttributes

Define a quantity tier attribute, which could be any number type fields on Quote Line Item, Quote, Opportunity, Account or any custom objects.

Body parameter

null

Parameters

Name	In	Type	Required	Description
body	body	CreateQuantityTierAttributeRequest	true	none

Example responses

201 Response

Responses

Status	Meaning	Description	Schema
201	Created	Created	CreateQuantityTierAttributeResponse
400	Bad Request	Bad Request	ErrorMessage

Delete a Quantity Tier Attribute.

Code samples

# You can also use wget
curl -X DELETE https://api.nue.io/v1/cpq/ruby_settings/quantityTierAttributes/{apiName} \
  -H 'Accept: */*'

DELETE https://api.nue.io/v1/cpq/ruby_settings/quantityTierAttributes/{apiName} HTTP/1.1
Host: api.nue.io
Accept: */*


const headers = {
  'Accept':'*/*'
};

fetch('https://api.nue.io/v1/cpq/ruby_settings/quantityTierAttributes/{apiName}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*'
}

result = RestClient.delete 'https://api.nue.io/v1/cpq/ruby_settings/quantityTierAttributes/{apiName}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*'
}

r = requests.delete('https://api.nue.io/v1/cpq/ruby_settings/quantityTierAttributes/{apiName}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.nue.io/v1/cpq/ruby_settings/quantityTierAttributes/{apiName}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/cpq/ruby_settings/quantityTierAttributes/{apiName}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.nue.io/v1/cpq/ruby_settings/quantityTierAttributes/{apiName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /cpq/ruby_settings/quantityTierAttributes/{apiName}

Delete a quantity tier attribute.

Parameters

Name	In	Type	Required	Description
apiName	path	string	true	none

Example responses

400 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	None
400	Bad Request	Bad Request	ErrorMessage

Update Quantity Tier Attributes.

Code samples

# You can also use wget
curl -X PATCH https://api.nue.io/v1/cpq/ruby_settings/quantityTierAttributes/{apiName} \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

PATCH https://api.nue.io/v1/cpq/ruby_settings/quantityTierAttributes/{apiName} HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/cpq/ruby_settings/quantityTierAttributes/{apiName}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch 'https://api.nue.io/v1/cpq/ruby_settings/quantityTierAttributes/{apiName}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('https://api.nue.io/v1/cpq/ruby_settings/quantityTierAttributes/{apiName}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','https://api.nue.io/v1/cpq/ruby_settings/quantityTierAttributes/{apiName}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/cpq/ruby_settings/quantityTierAttributes/{apiName}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "https://api.nue.io/v1/cpq/ruby_settings/quantityTierAttributes/{apiName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PATCH /cpq/ruby_settings/quantityTierAttributes/{apiName}

Update a quantity tier attribute.

Body parameter

null

Parameters

Name	In	Type	Required	Description
apiName	path	string	true	none
body	body	UpdateQuantityTierAttributeRequest	true	none

Example responses

400 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	None
400	Bad Request	Bad Request	ErrorMessage

Export Settings

Code samples

# You can also use wget
curl -X GET https://api.nue.io/v1/cpq/settings/setting:export \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.nue.io/v1/cpq/settings/setting:export HTTP/1.1
Host: api.nue.io
Accept: */*


const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/cpq/settings/setting:export',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/v1/cpq/settings/setting:export',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/v1/cpq/settings/setting:export', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/v1/cpq/settings/setting:export', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/cpq/settings/setting:export");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/v1/cpq/settings/setting:export", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /cpq/settings/setting:export

Export tenant system setting.

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	SettingsImportAndExportVO
400	Bad Request	Bad Request	ErrorMessage

Products and Bundles

A Bundle Product is a product with children products bundled together and sold for one price. There can also be add-on product options available for a bundle product.

Get Bundle Definition

Code samples

# You can also use wget
curl -X GET https://api.nue.io/v1/objects/Product/{id}/bundleDefinition \
  -H 'Accept: application/json'

GET https://api.nue.io/v1/objects/Product/{id}/bundleDefinition HTTP/1.1
Host: api.nue.io
Accept: application/json


const headers = {
  'Accept':'application/json'
};

fetch('https://api.nue.io/v1/objects/Product/{id}/bundleDefinition',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api.nue.io/v1/objects/Product/{id}/bundleDefinition',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.nue.io/v1/objects/Product/{id}/bundleDefinition', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/v1/objects/Product/{id}/bundleDefinition', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/objects/Product/{id}/bundleDefinition");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/v1/objects/Product/{id}/bundleDefinition", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /objects/Product/{id}/bundleDefinition

Retrieve bundle product definition

Parameters

Name	In	Type	Required	Description
id	path	string	true	none
priceBookId	query	string	false	none
uomId	query	string	false	none

Example responses

200 Response

null

400 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	BundleProduct
400	Bad Request	Bad Request	ErrorMessage

Metadata Sync

Synchronize custom field metadata from Salesforce to Nue.

Retrieve Simple Asset Custom Fields

Code samples

# You can also use wget
curl -X GET https://api.nue.io/v1/objects/custom-fields/subscription-asset-entitlement/simple \
  -H 'Accept: */*'

GET https://api.nue.io/v1/objects/custom-fields/subscription-asset-entitlement/simple HTTP/1.1
Host: api.nue.io
Accept: */*


const headers = {
  'Accept':'*/*'
};

fetch('https://api.nue.io/v1/objects/custom-fields/subscription-asset-entitlement/simple',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*'
}

result = RestClient.get 'https://api.nue.io/v1/objects/custom-fields/subscription-asset-entitlement/simple',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*'
}

r = requests.get('https://api.nue.io/v1/objects/custom-fields/subscription-asset-entitlement/simple', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/v1/objects/custom-fields/subscription-asset-entitlement/simple', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/objects/custom-fields/subscription-asset-entitlement/simple");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/v1/objects/custom-fields/subscription-asset-entitlement/simple", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /objects/custom-fields/subscription-asset-entitlement/simple

Fetches a simplified structure of custom fields associated with Subscription, Asset, and Entitlement entities.

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	CombinedSimpleCustomFieldsResponse
400	Bad Request	Bad Request	ErrorMessage

Entities

A entity defines a sales or legal entity which can be tagged onto account, order product and related transactional data like invoices.

All APIs should be used with base URL https://api.nue.io/

Deactivate Entity

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/objects/Entity/{id}:deactivate \
  -H 'Accept: application/json'

POST https://api.nue.io/v1/objects/Entity/{id}:deactivate HTTP/1.1
Host: api.nue.io
Accept: application/json


const headers = {
  'Accept':'application/json'
};

fetch('https://api.nue.io/v1/objects/Entity/{id}:deactivate',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'https://api.nue.io/v1/objects/Entity/{id}:deactivate',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('https://api.nue.io/v1/objects/Entity/{id}:deactivate', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/objects/Entity/{id}:deactivate', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/objects/Entity/{id}:deactivate");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/objects/Entity/{id}:deactivate", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /objects/Entity/{id}:deactivate

Deactivate an entity

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Example responses

400 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	None
400	Bad Request	Bad Request	ErrorMessage

Response Schema

Activate Entity

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/objects/Entity/{id}:activate \
  -H 'Accept: application/json'

POST https://api.nue.io/v1/objects/Entity/{id}:activate HTTP/1.1
Host: api.nue.io
Accept: application/json


const headers = {
  'Accept':'application/json'
};

fetch('https://api.nue.io/v1/objects/Entity/{id}:activate',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'https://api.nue.io/v1/objects/Entity/{id}:activate',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('https://api.nue.io/v1/objects/Entity/{id}:activate', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/objects/Entity/{id}:activate', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/objects/Entity/{id}:activate");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/objects/Entity/{id}:activate", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /objects/Entity/{id}:activate

Activate an entity

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Example responses

400 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	None
400	Bad Request	Bad Request	ErrorMessage

Response Schema

Schemas

ErrorMessage

null

Properties

Name	Type	Required	Restrictions	Description
title	string	false	none	none
message	string	false	none	none
errorCode	string	false	none	none

CompositePersistentObject

null

Properties

Name	Type	Required	Restrictions	Description
content	object	false	none	Please refer to Ruby Object Metadata API for this field's schema.
id	string	false	none	none
operation	string	false	none	none
referenceId	string	false	none	none
new	boolean	false	none	none
patch	boolean	false	none	none
update	boolean	false	none	none
delete	boolean	false	none	none

Enumerated Values

Property	Value
operation	Create
operation	Patch
operation	Update
operation	Delete
operation	None

CompositePersistentObjectCollection

null

Please refer to Ruby Object Metadata API for this field's schema.

Properties

Name	Type	Required	Restrictions	Description
persistentObjects	[CompositePersistentObject]	false	none	none

CompositePersistentObjectResponse

null

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
referenceId	string	false	none	none
_action	string	false	none	none

ProductListRequest

null

Properties

Name	Type	Required	Restrictions	Description
idList	[string]	true	none	none

CopyPriceBookRequest

null

Properties

Name	Type	Required	Restrictions	Description
fromPriceBookId	string	true	none	The price book ID to copy from

BulkUsageRateRequest

null

Usage rate bulk request which included a list of usage rating requests.

Properties

Name	Type	Required	Restrictions	Description
usageRateRequests	[UsageRateRequest]	true	none	A list of usage rate requests.

UsageRateRequest

null

A list of usage rate requests.

Properties

Name	Type	Required	Restrictions	Description
referenceId	string	false	none	none
subscriptionNumber	string	true	none	none
consumedQuantity	number	true	none	none
deltaQuantity	number	true	none	none
ratingDate	string(date)	true	none	none

BulkUsageRateResponse

null

The bulk usage rate response which includes a list of usage rating results

Properties

Name	Type	Required	Restrictions	Description
state	string	false	none	none
error	string	false	none	none
usageRateResults	[UsageRateResponse]	false	none	none

Enumerated Values

Property	Value
state	Completed
state	PartialCompleted
state	Failed

UsageRateResponse

null

Properties

Name	Type	Required	Restrictions	Description
referenceId	string	false	none	none
subscriptionNumber	string	false	none	none
orderItemId	string	false	none	none
orderItemNumber	string	false	none	none
orderNumber	string	false	none	none
totalPrice	number	false	none	none
totalAmount	number	false	none	none
subtotal	number	false	none	none
listTotal	number	false	none	none
quantity	number	false	none	none
discountAmount	number	false	none	none
discountPercentage	number	false	none	none
systemDiscount	number	false	none	none
systemDiscountAmount	number	false	none	none
netSalesPrice	number	false	none	none
salesPrice	number	false	none	none
ratedCredit	number	false	none	none
success	boolean	false	none	none
error	string	false	none	none

PricingAttributeVO

null

Properties

Name	Type	Required	Restrictions	Description
name	string	false	none	none
description	string	false	none	none
mapping	string	false	none	none
apiName	string	false	none	none
options	[string]	false	none	none

RubySettingVO

null

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
category	string	false	none	none
subCategory	string	false	none	none
settings	object	false	none	none
» additionalProperties	object	false	none	none

SettingsImportAndExportVO

null

Properties

Name	Type	Required	Restrictions	Description
allSettings	[RubySettingVO]	false	none	none
pricingAttributes	[PricingAttributeVO]	false	none	none

CreateQuantityTierAttributeRequest

null

Request to create a quantity tier attribute

Properties

Name	Type	Required	Restrictions	Description
apiName	string	true	none	apiName of the quantity tier attribute
name	string	false	none	Display name of the quantity tier attribute
description	string	false	none	Description of the quantity tier attribute
mapping	string	true	none	Mapping field of the quantity tier attribute
active	boolean	false	none	none

CreateQuantityTierAttributeResponse

null

Properties

Name	Type	Required	Restrictions	Description
apiName	string	false	none	The api name of the quantity tier attribute
mapping	string	false	none	The mapping field of the quantity tier attribute

CreateOrderProductRequest

null

The request to create a list of order products.

Properties

Name	Type	Required	Restrictions	Description
subscriptionTerm	number	false	none	The subscription term of the recurring product or service of this line item, measured by UOM.
subscriptionStartDate	string(date)	true	none	The start date of the product or service of this line item.
subscriptionEndDate	string(date)	true	none	The end date of recurring products or services of this line item.
productId	string	true	none	ID of the product.
priceBookEntryId	string	true	none	ID of the associated price book entry.
quantity	number	true	none	The quantity of the product. Default value is 1.
salesPrice	number	false	none	Alias for netSalesPrice field.
netSalesPrice	number	false	none	The actual net sales price after the on-the-fly discount.
totalPrice	number	true	none	The total price of the line item, not including tax amount.
totalAmount	number	false	none	The total amount of the line item, including tax amount.
childrenOrderProducts	[CreateOrderProductRequest]	false	none	The children order products of this order product.
autoRenew	boolean	false	none	Indicates this subscription is auto-renewed. The default value is inherited from that of the product, but can be changed at quoting or ordering time.
renewalTerm	number	false	none	The renewal term for this line item.
uomId	string	true	none	The unit of measure, e.g. User/Month, User/Year. Each UOM has a quantity dimension, and optionally has a term dimension.
billingTiming	string	false	none	Billing timing

CreateOrderRequest

null

Properties

Name	Type	Required	Restrictions	Description
options	Options	false	none	The options when creating the order.
customerId	string	true	none	The customer account ID
billingAccountId	string	false	none	The billing account ID. If not specified, customer ID will be used instead.
effectiveDate	string(date)	true	none	The order effective date
priceBookId	string	true	none	The price book ID used to place this order.
orderProducts	[CreateOrderProductRequest]	true	none	The request to create a list of order products.

Options

null

The options when creating the order.

Properties

Name	Type	Required	Restrictions	Description
activateOrder	boolean	false	none	If set as false, the order will not be activated after creation. Default value is true

ChangeOrderResponse

null

Properties

Name	Type	Required	Restrictions	Description
options	CheckOutOptions	false	none	The check out options.
headerObjectIds	[string]	false	none	none
messages	[string]	false	none	none
order	object	false	none	none
» additionalProperties	object	false	none	none
orderProducts	[object]	false	none	none
» additionalProperties	object	false	none	none
subscriptions	[object]	false	none	none
» additionalProperties	object	false	none	none
assets	[object]	false	none	none
» additionalProperties	object	false	none	none
entitlements	[object]	false	none	none
» additionalProperties	object	false	none	none
invoices	[SalesforceInvoice]	false	none	none

CheckOutOptions

null

The check out options.

Properties

Name	Type	Required	Restrictions	Description
generateInvoice	boolean	false	none	If set as true, invoice will be generated.
activateInvoice	boolean	false	none	If set as true, invoice will be activated.
cancelOnPaymentFail	boolean	false	none	If set as true, invoice and order will be canceled when payment fails.
activateOrder	boolean	false	none	If set as true, if `CreateOrder` or `UseExistingOrder` is chosen, the order will be activated. If `CreateQuote` or `UseExistingQuote` is chosen, the quote will be converted to order and activated.
proceedOption	string	true	none	The options when processing a change set in a change cart.
opportunityId	string	false	none	If `CreateQuote` or `CreateOrder` option is chosen, specify the opportunity ID to associate with the newly created quote or order.
containedObjectId	string	false	none	If `UseExistingQuote` or `UseExistingOrder` is chosen, specify the quote or order ID to add the change line items into.

Enumerated Values

Property	Value
proceedOption	UseExistingQuote
proceedOption	UseExistingOrder
proceedOption	CreateOrder
proceedOption	CreateQuote

SalesforceInvoice

null

Properties

Name	Type	Required	Restrictions	Description
invoice	SalesforceInvoiceSummary	false	none	none
items	[SalesforceInvoiceItemResponse]	false	none	none

SalesforceInvoiceItemResponse

null

Properties

Name	Type	Required	Restrictions	Description
transactionQuantity	number	false	none	none
endDate	string	false	none	none
productName	string	false	none	none
assetNumber	string	false	none	none
balance	number	false	none	none
lastModifiedById	string	false	none	none
transactionAmount	number	false	none	none
invoiceNumber	string	false	none	none
id	string	false	none	none
createdById	string	false	none	none
productId	string	false	none	none
lastModifiedDate	string	false	none	none
recordType	string	false	none	none
billingTiming	string	false	none	none
uomId	string	false	none	none
transactionDate	string	false	none	none
assetType	string	false	none	none
appliedCredits	number	false	none	none
accountId	string	false	none	none
createdDate	string	false	none	none
tenantId	string	false	none	none
name	string	false	none	none
invoiceId	string	false	none	none
taxAmount	number	false	none	none
currencyCode	string	false	none	none
startDate	string	false	none	none
ratedCredits	number	false	none	none

SalesforceInvoiceSummary

null

Properties

Name	Type	Required	Restrictions	Description
activatedById	string	false	none	none
syncTime	string	false	none	none
endDate	string	false	none	none
dueDate	string	false	none	none
taxStatus	string	false	none	none
balance	number	false	none	none
lastModifiedById	string	false	none	none
customerId	string	false	none	none
id	string	false	none	none
billToContactId	string	false	none	none
paymentDetails	string	false	none	none
createdById	string	false	none	none
paymentStatus	string	false	none	none
amountWithoutTax	number	false	none	none
amount	number	false	none	none
lastModifiedDate	string	false	none	none
recordType	string	false	none	none
targetDate	string	false	none	none
invoiceDate	string	false	none	none
accountingStatus	string	false	none	none
paymentHostedUrl	string	false	none	none
invoicePdf	string	false	none	none
createdDate	string	false	none	none
activatedTime	string	false	none	none
tenantId	string	false	none	none
name	string	false	none	none
externalInvoiceId	string	false	none	none
taxAmount	number	false	none	none
currencyCode	string	false	none	none
startDate	string	false	none	none
status	string	false	none	none

AdjustPriceChangeRequest

null

Properties

allOf - discriminator: AssetChangeRequest.changeType

Name	Type	Required	Restrictions	Description
anonymous	AssetChangeRequest	false	none	The change request for an asset

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» netSalesPrice	number	false	none	The new net sales price that the asset price will be changed to.
» startDate	string(date)	false	none	The start date of the price change
» endDate	string(date)	false	none	The end date of the price change
» term	number	false	none	The terms of the price change. Please use either end date or term to represent the time period of the price change.
» discount	DiscountChange	false	none	The discount of the price change. If netSalesPrice is not available in the request, the discount will be used instead.
» trueUpPrice	boolean	false	none	Adjust the price accurately based on the price tier determined by the current quantity tier attribute value. This adjustment accounts for any discrepancies between the initial price and the actual price over a specified period due to changes in the quantity tier attribute value.

AssetChangeRequest

null

The change request for an asset

Properties

Name	Type	Required	Restrictions	Description
assetNumber	string	true	none	The Asset Number of the subscription to change.
changeType	string	true	none	The change type

Enumerated Values

Property	Value
changeType	Renew
changeType	UpdateQuantity
changeType	UpdateTerm
changeType	CoTerm
changeType	Cancel
changeType	Reconfigure
changeType	ConvertFreeTrial
changeType	AdjustPrice

AssetUpdateQuantityRequest

null

Properties

allOf - discriminator: AssetChangeRequest.changeType

Name	Type	Required	Restrictions	Description
anonymous	AssetChangeRequest	false	none	The change request for an asset

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» quantity	number(double)	false	none	none
» startDate	string(date)	false	none	The start date of the quantity change.
» endDate	string(date)	false	none	The end date of the quantity change.

ChangeOrderRequest

null

Properties

Name	Type	Required	Restrictions	Description
options	CheckOutOptions	true	none	The check out options.
assetChanges	[AssetChangeRequest]	true	none	List of change requests for assets
taxRates	[ProductTaxRate]	false	none	none

ConvertFreeTrialRequest

null

Properties

allOf - discriminator: AssetChangeRequest.changeType

Name	Type	Required	Restrictions	Description
anonymous	AssetChangeRequest	false	none	The change request for an asset

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» startDate	string(date)	false	none	The start date of the paid subscription
» term	number(double)	false	none	The term this free trial subscription will be converted to
» switchToEvergreen	boolean	false	none	If true, the free trial subscription will be converted to an evergreen subscription
» coTermToBundleSubscription	boolean	false	none	If true, the free trial subscription will be converted to a paid subscription and co-term to the end date of the bundle
» overrideTrialEnd	boolean	false	none	If true and the free trial conversion start date is before the trial end date, the left free trial term will be converted to a paid subscription.

DiscountChange

null

The discount of the price change. If netSalesPrice is not available in the request, the discount will be used instead.

Properties

Name	Type	Required	Restrictions	Description
discountPercentage	number	false	none	Discount percentage of the price change. (Use 30 instead of 0.3 for 30% discount.)
applyToChildren	boolean	false	none	If true, the discount will be applied to all child assets.

ProductTaxRate

null

Properties

Name	Type	Required	Restrictions	Description
productSku	string	true	none	none
taxPercentage	number	true	none	none

SubscriptionCancelRequest

null

Properties

allOf - discriminator: AssetChangeRequest.changeType

Name	Type	Required	Restrictions	Description
anonymous	AssetChangeRequest	false	none	The change request for an asset

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» cancellationDate	string(date)	false	none	The subscription cancellation date.

SubscriptionCoTermRequest

null

Properties

allOf - discriminator: AssetChangeRequest.changeType

Name	Type	Required	Restrictions	Description
anonymous	AssetChangeRequest	false	none	The change request for an asset

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» coTermDate	string(date)	false	none	The co-termination date that the subscription(s) will be co-termed to.

SubscriptionReconfigureRequest

null

Properties

allOf - discriminator: AssetChangeRequest.changeType

Name	Type	Required	Restrictions	Description
anonymous	AssetChangeRequest	false	none	The change request for an asset

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» startDate	string(date)	false	none	The reconfiguration effective date.

SubscriptionRenewalRequest

null

Properties

allOf - discriminator: AssetChangeRequest.changeType

Name	Type	Required	Restrictions	Description
anonymous	AssetChangeRequest	false	none	The change request for an asset

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» renewalTerm	number(double)	false	none	The subscription's renewal term.
» switchToEvergreen	boolean	false	none	Switch the termed subscription to evergreen

SubscriptionUpdateTermRequest

null

Properties

allOf - discriminator: AssetChangeRequest.changeType

Name	Type	Required	Restrictions	Description
anonymous	AssetChangeRequest	false	none	The change request for an asset

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» term	number(double)	false	none	The subscription term to add or reduce.
» switchToEvergreen	boolean	false	none	Switch the termed subscription to evergreen

BillingPreviewPrice

null

Properties

Name	Type	Required	Restrictions	Description
todayChargePrice	number	false	none	none
todayChargeAmount	number	false	none	none
nextBillingPeriodPrice	number	false	none	none
nextBillingPeriodAmount	number	false	none	none
nextBillingDate	string	false	none	none

ChangeLineItemPriceResult

null

Properties

Name	Type	Required	Restrictions	Description
refId	string	false	none	none
salesPrice	number	false	none	none
netSalesPrice	number	false	none	none
subtotal	number	false	none	none
totalPrice	number	false	none	none
totalAmount	number	false	none	none
deltaTCV	number	false	none	none
deltaACV	number	false	none	none
deltaCMRR	number	false	none	none
deltaARR	number	false	none	none
discountAmount	number	false	none	none
discountPercentage	number	false	none	none
systemDiscountAmount	number	false	none	none
systemDiscount	number	false	none	none
listTotal	number	false	none	none
endDate	string	false	none	none
startDate	string	false	none	none
term	number	false	none	none
quantity	number	false	none	none
lineType	string	false	none	none
changeType	string	false	none	none
changeReferenceId	string	false	none	none

ChangeOrderAssetPreviewResult

null

change order prices for the changed asset and its descendent assets. ( include orderPrice and billingPrice)

Properties

Name	Type	Required	Restrictions	Description
assetNumber	string	false	none	none
quantity	number	false	none	none
term	number	false	none	none
endDate	string	false	none	none
startDate	string	false	none	none
cancellationDate	string	false	none	none
reconfigureStartDate	string	false	none	none
orderPrice	LineItemPriceResult	false	none	none
billingPrice	BillingPreviewPrice	false	none	none
changes	[ChangeLineItemPriceResult]	false	none	none
childrenAssets	[ChangeOrderAssetPreviewResult]	false	none	[change order prices for the changed asset and its descendent assets. ( include orderPrice and billingPrice)]

ChangeOrderPreviewBulkResponse

null

Properties

Name	Type	Required	Restrictions	Description
results	[ChangeOrderPreviewResult]	false	none	[Change order preview includes price summary and change order prices for the changed asset and its descendent assets.]

ChangeOrderPreviewResult

null

Change order preview includes price summary and change order prices for the changed asset and its descendent assets.

Properties

Name	Type	Required	Restrictions	Description
priceSummary	PreviewPriceSummary	false	none	Order and billing price summary including the aggregation of all descendants of this asset/subscription.
previewResult	ChangeOrderAssetPreviewResult	false	none	change order prices for the changed asset and its descendent assets. ( include orderPrice and billingPrice)
previewRequest	object	false	none	Preview request reused for self-service client library to preview order and billing price.
» additionalProperties	object	false	none	Preview request reused for self-service client library to preview order and billing price.
assetNumber	string	false	none	The subscription or asset number

LineItemPriceResult

null

Properties

Name	Type	Required	Restrictions	Description
refId	string	false	none	none
salesPrice	number	false	none	none
netSalesPrice	number	false	none	none
subtotal	number	false	none	none
totalPrice	number	false	none	none
totalAmount	number	false	none	none
deltaTCV	number	false	none	none
deltaACV	number	false	none	none
deltaCMRR	number	false	none	none
deltaARR	number	false	none	none
discountAmount	number	false	none	none
discountPercentage	number	false	none	none
systemDiscountAmount	number	false	none	none
systemDiscount	number	false	none	none
listTotal	number	false	none	none

PreviewPriceSummary

null

Order and billing price summary including the aggregation of all descendants of this asset/subscription.

Properties

Name	Type	Required	Restrictions	Description
totalPrice	number	false	none	none
totalAmount	number	false	none	none
todayChargePrice	number	false	none	none
todayChargeAmount	number	false	none	none
nextBillingPeriodPrice	number	false	none	none
nextBillingPeriodAmount	number	false	none	none
nextBillingDate	string	false	none	none

JobCreateResponse

null

The async job created after an asynchronous API is triggered.

Properties

Name	Type	Required	Restrictions	Description
jobId	string	false	none	The job id of the async job.

AssetBulkChangeOrder

null

The change request for bulk change order

Properties

Name	Type	Required	Restrictions	Description
changeType	string	true	none	The change type
assetNumber	string	false	none	The Asset Number of the subscription to change.
graphqlQuery	string	false	none	The GraphQL query will be used to retrieve all assets that the change request will be applied

Enumerated Values

Property	Value
changeType	Renew
changeType	UpdateQuantity
changeType	UpdateTerm
changeType	CoTerm
changeType	Cancel
changeType	Reconfigure
changeType	ConvertFreeTrial
changeType	AdjustPrice

AssetBulkChangeOrderOptions

null

The options for the change requests.

Properties

Name	Type	Required	Restrictions	Description
generateInvoice	boolean	false	none	If set as true, invoice will be generated.
activateInvoice	boolean	false	none	If set as true, invoice will be activated.
cancelOnPaymentFail	boolean	false	none	If set as true, invoice and order will be canceled when payment fails.
proceedOption	string	true	none	Indicate whether to create an order or a quote
batchSize	integer(int32)	false	none	Batch size for bulk change order, maximum value is 100, minimum and default value are both 20
activateOrder	boolean	false	none	If set as true, if `CreateOrder` or `UseExistingOrder` is chosen, the order will be activated. If `CreateQuote` or `UseExistingQuote` is chosen, the quote will be converted to order and activated.

Enumerated Values

Property	Value
proceedOption	CreateOrder
proceedOption	CreateQuote

AssetBulkChangeOrderRequest

null

Properties

Name	Type	Required	Restrictions	Description
options	AssetBulkChangeOrderOptions	true	none	The options for the change requests.
assetChanges	[oneOf]	true	none	List of change requests for assets. Currently only AdjustPrice changes are supported

BulkAdjustPrice

null

Represent the request to apply AdjustPrice changes on a big number of assets.

Properties

allOf - discriminator: AssetBulkChangeOrder.changeType

Name	Type	Required	Restrictions	Description
anonymous	AssetBulkChangeOrder	false	none	The change request for bulk change order

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» discountPercentage	number	false	none	Discount percentage of the price change. (Use 30 instead of 0.3 for 30% discount.)
» netSalesPrice	number	false	none	The new net sales price that the asset price will be changed to.
» startDate	string(date)	false	none	The start date of the price change
» endDate	string(date)	false	none	The end date of the price change
» term	number	false	none	The terms of the price change. Please use either end date or term to represent the time period of the price change.
» trueUpPrice	boolean	false	none	Adjust the price accurately based on the price tier determined by the current quantity tier attribute value. This adjustment accounts for any discrepancies between the initial price and the actual price over a specified period due to changes in the quantity tier attribute value.

CreateImportRequest

null

Properties

Name	Type	Required	Restrictions	Description
format	string	false	none	File format
objectName	string	true	none	Object name

Enumerated Values

Property	Value
format	JSON
format	CSV
objectName	UOM
objectName	PriceBook
objectName	PriceTag
objectName	ProductGroup
objectName	Product
objectName	Bundle
objectName	BundleSuite
objectName	Subscription

CreateExportRequest

null

Properties

Name	Type	Required	Restrictions	Description
format	string	false	none	File format
objectNames	[string]	false	none	Object names
query	string	false	none	none
childQueries	[string]	false	none	none
exportObjectConfig	object	false	none	none
» additionalProperties	ExportObjectConfig	false	none	none

Enumerated Values

Property	Value
format	JSON
format	CSV
objectNames	UOM
objectNames	PriceBook
objectNames	PriceTag
objectNames	ProductGroup
objectNames	Product
objectNames	Bundle
objectNames	BundleSuite
objectNames	Subscription
objectNames	CreditType
objectNames	CreditPool
objectNames	CreditConversion
objectNames	CustomSetting
objectNames	Usage
objectNames	Order
objectNames	Invoice
objectNames	CreditMemo
objectNames	TransactionHub
objectNames	ProductRelationship

ExportObjectConfig

null

Properties

Name	Type	Required	Restrictions	Description
exportId	string	false	none	none

RubySetting

null

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
category	string	false	none	none
subcategory	string	false	none	none
name	string	false	none	none
value	string	false	none	none

CreditConversion

null

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
name	string	false	none	none
creditTypeId	string	false	none	none
uomQuantityDimension	string	false	none	none
uomQuantity	number	false	none	none
creditQuantity	number	false	none	none
conversionRate	number	false	none	none
decimalScale	integer(int32)	false	none	none
roundingMode	string	false	none	none

Feature

null

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
name	string	false	none	none
imageSignedUrl	string	false	none	none
status	string	false	none	none
featurePriceTags	[FeaturePriceDimension]	false	none	none

FeaturePriceDimension

null

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
name	string	false	none	none
serialNumber	integer(int32)	false	none	none
active	boolean	false	none	none
priceTag	PriceDimension	false	none	none

PriceBook

null

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
name	string	false	none	none
description	string	false	none	none
standard	boolean	false	none	none
active	boolean	false	none	none
archived	boolean	false	none	none
selfServiceEnabled	boolean	false	none	none

PriceBookEntry

null

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
listPrice	number	false	none	none
active	boolean	false	none	none
currencyIsoCode	string	false	none	none
recommended	boolean	false	none	none
billingTiming	string	false	none	none
uom	Uom	false	none	none
priceBookId	string	false	none	none
pricingAttributes	[PricingAttribute]	false	none	none

PriceDimension

null

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
name	string	false	none	none
description	string	false	none	none
recordType	string	false	none	none
priceTagType	string	false	none	none
startTime	string	false	none	none
endTime	string	false	none	none
priceType	string	false	none	none
active	boolean	false	none	none
objectId	string	false	none	none
objectType	string	false	none	none
code	string	false	none	none
uomDimension	string	false	none	none
priceBook	PriceBook	false	none	none
uom	Uom	false	none	none
priceTiers	[PriceTier]	false	none	none
publishStatus	string	false	none	none
lastPublishedById	string	false	none	none
lastPublishedDate	string	false	none	none

Enumerated Values

Property	Value
publishStatus	Unpublished
publishStatus	Published
publishStatus	Outdated

PriceTier

null

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
name	string	false	none	none
amount	number	false	none	none
chargeModel	string	false	none	none
discountPercentage	number	false	none	none
endUnit	number	false	none	none
endUnitDimension	string	false	none	none
startUnit	number	false	none	none
startUnitDimension	string	false	none	none
tierNumber	number	false	none	none

PricingAttribute

null

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
name	string	false	none	none
description	string	false	none	none
mapping	string	false	none	none
label	string	false	none	none
value	string	false	none	none

Product

null

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
name	string	false	none	none
sku	string	false	none	none
recordType	string	false	none	none
configurable	boolean	false	none	none
soldIndependently	boolean	false	none	none
status	string	false	none	none
bundleTemplate	string	false	none	none
description	string	false	none	none
priceModel	string	false	none	none
startDate	string	false	none	none
endDate	string	false	none	none
freeTrialUnit	integer(int32)	false	none	none
freeTrialType	string	false	none	none
productCategory	string	false	none	none
autoRenew	boolean	false	none	none
defaultRenewalTerm	number	false	none	none
defaultSubscriptionTerm	integer(int32)	false	none	none
billingTiming	string	false	none	none
billingPeriod	string	false	none	none
showIncludedProductOptions	boolean	false	none	none
publishStatus	string	false	none	none
lastPublishedById	string	false	none	none
lastPublishedDate	string	false	none	none
taxCode	string	false	none	none
taxMode	string	false	none	none
referenceProduct	Product	false	none	none
uom	Uom	false	none	none
priceBook	PriceBook	false	none	none
imageUrl	string	false	none	none
evergreen	boolean	false	none	none
carvesLiabilitySegment	string	false	none	none
carvesRevenueSegment	string	false	none	none
contractLiabilitySegment	string	false	none	none
contractRevenueSegment	string	false	none	none
creditConversionId	string	false	none	none
creditConversion	CreditConversion	false	none	none
priceBookEntries	[PriceBookEntry]	false	none	none
productFeatures	[ProductFeature]	false	none	none
productOptions	[ProductOption]	false	none	none
productPriceTags	[ProductPriceDimension]	false	none	none
carvesEligible	boolean	false	none	none
customFields	object	false	none	none
» additionalProperties	object	false	none	none

Enumerated Values

Property	Value
publishStatus	Unpublished
publishStatus	Published
publishStatus	Outdated

ProductFeature

null

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
name	string	false	none	none
featureOrder	integer(int32)	false	none	none
minOptions	integer(int32)	false	none	none
maxOptions	integer(int32)	false	none	none
featureName	string	false	none	none
featureDescription	string	false	none	none
feature	Feature	false	none	none
productOptions	[ProductOption]	false	none	none

ProductOption

null

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
name	string	false	none	none
optionName	string	false	none	none
optionOrder	integer(int32)	false	none	none
optionType	string	false	none	none
defaultQuantity	number	false	none	none
includedQuantity	number	false	none	none
minQuantity	number	false	none	none
maxQuantity	number	false	none	none
quantityEditable	boolean	false	none	none
required	boolean	false	none	none
bundled	boolean	false	none	none
recommended	boolean	false	none	none
independentPricing	boolean	false	none	none
priceBookEntry	PriceBookEntry	false	none	none
product	Product	false	none	none
productOptionPriceTags	[ProductOptionPriceDimension]	false	none	none

ProductOptionPriceDimension

null

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
name	string	false	none	none
serialNumber	integer(int32)	false	none	none
active	boolean	false	none	none
priceTag	PriceDimension	false	none	none

ProductPriceDimension

null

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
name	string	false	none	none
serialNumber	integer(int32)	false	none	none
active	boolean	false	none	none
priceBookEntry	PriceBookEntry	false	none	none
priceTag	PriceDimension	false	none	none

Uom

null

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
name	string	false	none	none
decimalScale	integer(int32)	false	none	none
roundingMode	string	false	none	none
quantityDimension	string	false	none	none
termDimension	string	false	none	none

Enumerated Values

Property	Value
roundingMode	Up
roundingMode	Down

ObjectMapping

null

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
fromObject	string	false	none	none
toObject	string	false	none	none
fromField	string	false	none	none
toField	string	false	none	none

Bundle

null

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
name	string	false	none	none
popular	boolean	false	none	none
sortOrder	integer(int64)	false	none	none
product	Product	false	none	none

BundleSuite

null

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
name	string	false	none	none
status	string	false	none	none
startDate	string	false	none	none
endDate	string	false	none	none
publishStatus	string	false	none	none
lastPublishedById	string	false	none	none
lastPublishedDate	string	false	none	none
priceBook	PriceBook	false	none	none
uom	Uom	false	none	none
bundles	[Bundle]	false	none	none

Enumerated Values

Property	Value
publishStatus	Unpublished
publishStatus	Published
publishStatus	Outdated

UpdateQuantityTierAttributeRequest

null

Request to update quantity tier attributes

Properties

Name	Type	Required	Restrictions	Description
name	string	false	none	The new display name for the quantity tier attribute
description	string	false	none	The new description for the quantity tier attribute
mapping	string	false	none	The new mapping field for the quantity tier attribute
active	boolean	false	none	Set the status of the quantity tier attribute to be active or inactive

CombinedSimpleCustomFieldsResponse

null

Properties

Name	Type	Required	Restrictions	Description
customFieldToObjectMap	object	false	none	none
» additionalProperties	[string]	false	none	none

BundleProduct

null

Model for Bundle

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
name	string	false	none	none
sku	string	false	none	none
recordType	string	false	none	none
configurable	boolean	false	none	none
soldIndependently	boolean	false	none	none
status	string	false	none	none
bundleTemplate	string	false	none	none
defaultUomId	string	false	none	none
description	string	false	none	none
longDescription	string	false	none	none
priceModel	string	false	none	none
referenceProductId	string	false	none	none
startDate	string	false	none	none
endDate	string	false	none	none
freeTrialUnit	integer(int32)	false	none	none
freeTrialType	string	false	none	none
productCategory	string	false	none	none
autoRenew	boolean	false	none	none
defaultRenewalTerm	number	false	none	none
defaultSubscriptionTerm	integer(int32)	false	none	none
referenceProduct	BundleProduct	false	none	Model for Bundle
taxCode	string	false	none	none
taxMode	string	false	none	none
productFeatures	[ProductFeatureVO]	false	none	none
priceBookEntries	[PriceBookEntryVO]	false	none	[Price Book Entry]
showIncludedProductOptions	boolean	false	none	none
productOptions	[ProductOptionVO]	false	none	[Model for getting the Product Options in a Bundle]
uom	UomVO	false	none	Uom
priceBookId	string	false	none	none
billingTiming	string	false	none	none
billingPeriod	string	false	none	none
creditConversionId	string	false	none	none
creditPoolId	string	false	none	none
revenueRuleExternalId	string	false	none	none
publishStatus	string	false	none	none
lastPublishedById	string	false	none	none
lastPublishedDate	string	false	none	none
evergreen	boolean	false	none	none
contractLiabilitySegment	string	false	none	none
contractRevenueSegment	string	false	none	none
carvesLiabilitySegment	string	false	none	none
carvesRevenueSegment	string	false	none	none
carvesEligible	boolean	false	none	none
productCode	string	false	none	none
taxCategory	string	false	none	none

FeatureVO

null

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
imagePath	string	false	none	none
status	string	false	none	none
name	string	false	none	none

PriceBookEntryVO

null

Price Book Entry

Properties

Name	Type	Required	Restrictions	Description
listPrice	number	false	none	none
active	boolean	false	none	none
id	string	false	none	none
currencyIsoCode	string	false	none	none
uomId	string	false	none	none
priceBookId	string	false	none	none
recommended	boolean	false	none	none
uom	UomVO	false	none	Uom
billingTiming	string	false	none	none
pricingAttribute_1	string	false	none	none
pricingAttribute_2	string	false	none	none
pricingAttribute_3	string	false	none	none
pricingAttribute_4	string	false	none	none
pricingAttribute_5	string	false	none	none
pricingAttribute_6	string	false	none	none
pricingAttribute_7	string	false	none	none
pricingAttribute_8	string	false	none	none
pricingAttribute_9	string	false	none	none
pricingAttribute_10	string	false	none	none

ProductFeatureVO

null

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
name	string	false	none	none
featureId	string	false	none	none
featureOrder	integer(int32)	false	none	none
configuredProductId	string	false	none	none
minOptions	integer(int32)	false	none	none
maxOptions	integer(int32)	false	none	none
featureName	string	false	none	none
featureDescription	string	false	none	none
productOptions	[ProductOptionVO]	false	none	[Model for getting the Product Options in a Bundle]
feature	FeatureVO	false	none	none

ProductOptionVO

null

Model for getting the Product Options in a Bundle

Properties

Name	Type	Required	Restrictions	Description
optionProductId	string	false	none	none
configuredProductId	string	false	none	none
productFeatureId	string	false	none	none
name	string	false	none	none
optionName	string	false	none	none
id	string	false	none	none
optionOrder	integer(int32)	false	none	none
optionType	string	false	none	none
defaultQuantity	number	false	none	none
includedQuantity	number	false	none	none
minQuantity	number	false	none	none
maxQuantity	number	false	none	none
quantityEditable	boolean	false	none	none
required	boolean	false	none	none
bundled	boolean	false	none	none
recommended	boolean	false	none	none
independentPricing	boolean	false	none	none
priceBookEntryId	string	false	none	none
defaultQuantityMode	string	false	none	none
product	BundleProduct	false	none	Model for Bundle
optionProductFilter	string	false	none	none
optionPriceFilter	string	false	none	none

UomVO

null

Uom

Properties

Name	Type	Required	Restrictions	Description
decimalScale	integer(int32)	false	none	none
name	string	false	none	none
quantityDimension	string	false	none	none
termDimension	string	false	none	none
roundingMode	string	false	none	none

QuantityTierAttribute

null

Quantity tier attribute object.

Properties

Name	Type	Required	Restrictions	Description
apiName	string	false	none	Api name of the quantity tier attribute
name	string	false	none	Display name of the quantity tier attribute
description	string	false	none	Description of the quantity tier attribute
mapping	string	false	none	Mapping field of the quantity tier attribute
active	boolean	false	none	Status of the quantity tier attribute

GetJobResponse

null

The result of a job.

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	The job id.
status	string	false	none	Status of the job.
error	string	false	none	Error message if the job failed.
jobType	string	false	none	The type of the job.
startTime	string(date-time)	false	none	The start time of the job
endTime	string(date-time)	false	none	The start time of the job
stages	[GetJobStageResponse]	false	none	none

Enumerated Values

Property	Value
status	Queued
status	Processing
status	Completed
status	PartialCompleted
status	Failed

GetJobStageResponse

null

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	The id of the job stage.
startTime	string(date-time)	false	none	Start time of the job stage
endTime	string(date-time)	false	none	End time of the job stage
status	string	false	none	Status of the job stage
processResult	object	false	none	Process result of the job stage.
» additionalProperties	object	false	none	Process result of the job stage.

Enumerated Values

Property	Value
status	Queued
status	Processing
status	Completed
status	PartialCompleted
status	Failed

ExportJobResponse

null

Properties

Name	Type	Required	Restrictions	Description
status	string	false	none	Job status
format	string	false	none	none
objects	[ExportStageResponse]	false	none	none

ExportStageResponse

null

Properties

Name	Type	Required	Restrictions	Description
name	string	false	none	none
status	string	false	none	none
totalSize	integer(int32)	false	none	none
totalRecordCount	integer(int32)	false	none	none
fileUrls	[string]	false	none	none
errors	[string]	false	none	none

DeleteIds

null

Ids of objects to delete

Properties

Name	Type	Required	Restrictions	Description
idList	[string]	true	none	none

title: Revenue Manager v1.0 language_tabs: - shell: Shell - http: HTTP - javascript: JavaScript - ruby: Ruby - python: Python - php: PHP - java: Java - go: Go toc_footers: [] includes: [] search: false highlight_theme: darkula headingLevel: 2

Revenue Manager v1.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Base URLs:

https://api.nue.io/v1

Authentication

HTTP Authentication, scheme: bearer
HTTP Authentication, scheme: basic

GraphQL Queries

Support graphql query for entity: Order, Order Product, Billing Schedule, Billing Job, Invoice, Invoice Item, Credit Memo, Credit Memo Item, Debit Memo, Debit Memo Item, Payment Application, Payment Application Item, Credit Type, Credit Pool, Account Credit Pool, Credit.

GraphQL Query API on GET

Code samples

# You can also use wget
curl -X GET https://api.nue.io/v1/orders/async/graphql?query=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.nue.io/v1/orders/async/graphql?query=string HTTP/1.1
Host: api.nue.io
Accept: application/json


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/orders/async/graphql?query=string',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/v1/orders/async/graphql',
  params: {
  'query' => 'string'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/v1/orders/async/graphql', params={
  'query': 'string'
}, headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/v1/orders/async/graphql', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/orders/async/graphql?query=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/v1/orders/async/graphql", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /orders/async/graphql

The graghQL query is passed in the URL.

Parameters

Name	In	Type	Required	Description
query	query	string	true	none
operationName	query	string	false	none
variables	query	string	false	none

Example responses

200 Response

{}

400 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline

Response Schema

GraphQL Query API on POST

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/orders/async/graphql \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Content-Type: string' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/orders/async/graphql HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: application/json
Content-Type: string

const inputBody = 'string';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Content-Type':'string',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/orders/async/graphql',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Content-Type' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/orders/async/graphql',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Content-Type': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/orders/async/graphql', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Content-Type' => 'string',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/orders/async/graphql', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/orders/async/graphql");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Content-Type": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/orders/async/graphql", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /orders/async/graphql

The graghQL query is passed in the request body.

Body parameter

"string"

Parameters

Name	In	Type	Required	Description
Content-Type	header	string	false	none
query	query	string	false	none
operationName	query	string	false	none
variables	query	string	false	none
body	body	string	false	none

Example responses

200 Response

{}

400 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline

Response Schema

Magic Link

Magic Link related operations.

Get Magic Link

Code samples

# You can also use wget
curl -X GET https://api.nue.io/v1/orders/magiclink/{objectType}/{objectId} \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.nue.io/v1/orders/magiclink/{objectType}/{objectId} HTTP/1.1
Host: api.nue.io
Accept: */*


const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/orders/magiclink/{objectType}/{objectId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/v1/orders/magiclink/{objectType}/{objectId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/v1/orders/magiclink/{objectType}/{objectId}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/v1/orders/magiclink/{objectType}/{objectId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/orders/magiclink/{objectType}/{objectId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/v1/orders/magiclink/{objectType}/{objectId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /orders/magiclink/{objectType}/{objectId}

Get Magic Link

Parameters

Name	In	Type	Required	Description
objectType	path	string	true	none
objectId	path	string	true	none
internal	query	boolean	false	none

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline

Response Schema

Get Magic Link with Template

Code samples

# You can also use wget
curl -X GET https://api.nue.io/v1/orders/magiclink/{objectType}/{objectId}/template/{templateId} \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.nue.io/v1/orders/magiclink/{objectType}/{objectId}/template/{templateId} HTTP/1.1
Host: api.nue.io
Accept: */*


const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/orders/magiclink/{objectType}/{objectId}/template/{templateId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/v1/orders/magiclink/{objectType}/{objectId}/template/{templateId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/v1/orders/magiclink/{objectType}/{objectId}/template/{templateId}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/v1/orders/magiclink/{objectType}/{objectId}/template/{templateId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/orders/magiclink/{objectType}/{objectId}/template/{templateId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/v1/orders/magiclink/{objectType}/{objectId}/template/{templateId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /orders/magiclink/{objectType}/{objectId}/template/{templateId}

Get Magic Link with Template

Parameters

Name	In	Type	Required	Description
objectType	path	string	true	none
objectId	path	string	true	none
templateId	path	string	true	none
internal	query	boolean	false	none

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline

Response Schema

Billing Schedules

A Billing Schedule is a collection of billing options, which can be used to create billing jobs, either on-demand or on a recurring basis, such as daily, weekly.

Create Billing Schedule

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/billing/schedules \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/billing/schedules HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = '{
  "createdThrough": "API",
  "autoActivate": true,
  "scheduleStartDate": "2022-04-24",
  "invoiceDate": "2022-05-01",
  "targetDate": null,
  "scheduleType": "Recurring",
  "status": "Draft",
  "recurringSchedule": "0 0 3 * * ? *",
  "dailyObject": {},
  "customExpression": [],
  "recordType": "BillingSchedule",
  "customerFilter": "{id:{_in:[\"0011D00001CLlZ2QAL\"]}}",
  "orderFilter": "{id:{_in:[\"8011D000001V7jyQAC\"]}}",
  "billCycleDayFilter": null,
  "productFilter": "{priceModel:{_in:[\"recurring\"]}}",
  "zoneId": "-07:00",
  "splitByPeriod": false,
  "cleanCatchUp": true,
  "catchUpMode": "Simulation",
  "description": "This is a sample billing schedule!",
  "targetDateIncrement": "0",
  "targetDateIncrementSign": "Plus",
  "targetDateIncrementTimeUnit": "Days"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/billing/schedules',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/billing/schedules',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/billing/schedules', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/billing/schedules', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/billing/schedules");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/billing/schedules", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /billing/schedules

Create a billing schedule.

Body parameter

Sample Billing Schedule

{
  "createdThrough": "API",
  "autoActivate": true,
  "scheduleStartDate": "2022-04-24",
  "invoiceDate": "2022-05-01",
  "targetDate": null,
  "scheduleType": "Recurring",
  "status": "Draft",
  "recurringSchedule": "0 0 3 * * ? *",
  "dailyObject": {},
  "customExpression": [],
  "recordType": "BillingSchedule",
  "customerFilter": "{id:{_in:[\"0011D00001CLlZ2QAL\"]}}",
  "orderFilter": "{id:{_in:[\"8011D000001V7jyQAC\"]}}",
  "billCycleDayFilter": null,
  "productFilter": "{priceModel:{_in:[\"recurring\"]}}",
  "zoneId": "-07:00",
  "splitByPeriod": false,
  "cleanCatchUp": true,
  "catchUpMode": "Simulation",
  "description": "This is a sample billing schedule!",
  "targetDateIncrement": "0",
  "targetDateIncrementSign": "Plus",
  "targetDateIncrementTimeUnit": "Days"
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	See metadata of BillingSchedule

Example responses

201 Response

Responses

Status	Meaning	Description	Schema
201	Created	Created	Inline
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline

Response Schema

Replicate Billing Schedule

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/billing/schedules/{id}:duplicate \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/billing/schedules/{id}:duplicate HTTP/1.1
Host: api.nue.io
Accept: */*


const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/billing/schedules/{id}:duplicate',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/billing/schedules/{id}:duplicate',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/billing/schedules/{id}:duplicate', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/billing/schedules/{id}:duplicate', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/billing/schedules/{id}:duplicate");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/billing/schedules/{id}:duplicate", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /billing/schedules/{id}:duplicate

Replicate a billing schedule.

Parameters

Name	In	Type	Required	Description
id	path	string	true	The Billing Schedule ID

Example responses

201 Response

Responses

Status	Meaning	Description	Schema
201	Created	Created	Inline
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline

Response Schema

Update Billing Schedule

Code samples

# You can also use wget
curl -X PATCH https://api.nue.io/v1/billing/schedules/{id} \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

PATCH https://api.nue.io/v1/billing/schedules/{id} HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = '{
  "createdThrough": "API",
  "autoActivate": true,
  "scheduleStartDate": "2022-04-24",
  "invoiceDate": "2022-05-01",
  "targetDate": null,
  "scheduleType": "Recurring",
  "status": "Draft",
  "recurringSchedule": "0 0 3 * * ? *",
  "dailyObject": {},
  "customExpression": [],
  "recordType": "BillingSchedule",
  "customerFilter": "{id:{_in:[\"0011D00001CLlZ2QAL\"]}}",
  "orderFilter": "{id:{_in:[\"8011D000001V7jyQAC\"]}}",
  "billCycleDayFilter": null,
  "targetDateIncrement": "0",
  "targetDateIncrementSign": "Plus",
  "targetDateIncrementTimeUnit": "Days",
  "productFilter": "{priceModel:{_in:[\"recurring\"]}}"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/billing/schedules/{id}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch 'https://api.nue.io/v1/billing/schedules/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('https://api.nue.io/v1/billing/schedules/{id}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','https://api.nue.io/v1/billing/schedules/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/billing/schedules/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "https://api.nue.io/v1/billing/schedules/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PATCH /billing/schedules/{id}

Update a billing schedule. Only draft billing schedules can be updated.

Body parameter

Sample Billing Schedule

{
  "createdThrough": "API",
  "autoActivate": true,
  "scheduleStartDate": "2022-04-24",
  "invoiceDate": "2022-05-01",
  "targetDate": null,
  "scheduleType": "Recurring",
  "status": "Draft",
  "recurringSchedule": "0 0 3 * * ? *",
  "dailyObject": {},
  "customExpression": [],
  "recordType": "BillingSchedule",
  "customerFilter": "{id:{_in:[\"0011D00001CLlZ2QAL\"]}}",
  "orderFilter": "{id:{_in:[\"8011D000001V7jyQAC\"]}}",
  "billCycleDayFilter": null,
  "targetDateIncrement": "0",
  "targetDateIncrementSign": "Plus",
  "targetDateIncrementTimeUnit": "Days",
  "productFilter": "{priceModel:{_in:[\"recurring\"]}}"
}

Parameters

Name	In	Type	Required	Description
id	path	string(uuid)	true	none
body	body	object	true	See metadata of BillingSchedule

Example responses

400 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	None
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline

Response Schema

Cancel Billing Schedules

Code samples

# You can also use wget
curl -X PATCH https://api.nue.io/v1/billing/schedules/cancel \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

PATCH https://api.nue.io/v1/billing/schedules/cancel HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = '{
  "scheduleIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/billing/schedules/cancel',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch 'https://api.nue.io/v1/billing/schedules/cancel',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('https://api.nue.io/v1/billing/schedules/cancel', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','https://api.nue.io/v1/billing/schedules/cancel', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/billing/schedules/cancel");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "https://api.nue.io/v1/billing/schedules/cancel", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PATCH /billing/schedules/cancel

Cancel a list of billing schedules.

Body parameter

{
  "scheduleIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	CancelBillingSchedulesRequest	true	The request to create a billing schedule.

Example responses

400 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	None
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline

Response Schema

Activate Billing Schedules

Code samples

# You can also use wget
curl -X PATCH https://api.nue.io/v1/billing/schedules/activate \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

PATCH https://api.nue.io/v1/billing/schedules/activate HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = '{
  "scheduleIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/billing/schedules/activate',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch 'https://api.nue.io/v1/billing/schedules/activate',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('https://api.nue.io/v1/billing/schedules/activate', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','https://api.nue.io/v1/billing/schedules/activate', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/billing/schedules/activate");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "https://api.nue.io/v1/billing/schedules/activate", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PATCH /billing/schedules/activate

Activate a billing schedule.

Body parameter

{
  "scheduleIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	ActivateBillingSchedulesRequest	true	The request to create a billing schedule.

Example responses

400 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	None
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline

Response Schema

Download billing job error log

Code samples

# You can also use wget
curl -X GET https://api.nue.io/v1/billing/job/{jobId}/error-log \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.nue.io/v1/billing/job/{jobId}/error-log HTTP/1.1
Host: api.nue.io
Accept: */*


const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/billing/job/{jobId}/error-log',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/v1/billing/job/{jobId}/error-log',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/v1/billing/job/{jobId}/error-log', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/v1/billing/job/{jobId}/error-log', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/billing/job/{jobId}/error-log");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/v1/billing/job/{jobId}/error-log", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /billing/job/{jobId}/error-log

Download billing job error log by billing job id

Parameters

Name	In	Type	Required	Description
jobId	path	string(uuid)	true	none

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline

Response Schema

Delete Billing Schedule

Code samples

# You can also use wget
curl -X DELETE https://api.nue.io/v1/billing/schedules/{scheduleId} \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

DELETE https://api.nue.io/v1/billing/schedules/{scheduleId} HTTP/1.1
Host: api.nue.io
Accept: */*


const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/billing/schedules/{scheduleId}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete 'https://api.nue.io/v1/billing/schedules/{scheduleId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('https://api.nue.io/v1/billing/schedules/{scheduleId}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.nue.io/v1/billing/schedules/{scheduleId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/billing/schedules/{scheduleId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.nue.io/v1/billing/schedules/{scheduleId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /billing/schedules/{scheduleId}

Delete a billing schedule.

Parameters

Name	In	Type	Required	Description
scheduleId	path	string(uuid)	true	The ID of the billing schedule to delete.

Example responses

400 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	None
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline

Response Schema

System Settings

Billing Parameters provide a set of APIs to configure billing related parameters.

Import Order System Settings

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/orders/settings/setting:import \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/orders/settings/setting:import HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = '{
  "settings": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/orders/settings/setting:import',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/orders/settings/setting:import',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/orders/settings/setting:import', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/orders/settings/setting:import', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/orders/settings/setting:import");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/orders/settings/setting:import", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /orders/settings/setting:import

Import all order system settings.

Body parameter

{
  "settings": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	ImportAndExportOrderSettingsVO	true	The request to update all order settings.

Example responses

400 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	None
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline

Response Schema

Import system settings

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/billing/tenant-settings/setting:import \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/billing/tenant-settings/setting:import HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = '{
  "subscriptionDateFieldForBcd": {
    "fieldApiName": "string"
  },
  "autoSetBcdMode": {
    "mode": "AutoSetToFirstSubscription",
    "setting": "string"
  },
  "sfCustomSettings": {
    "autoAlignBillingPeriodEnabled": true,
    "billingPeriodAlign": "Order",
    "autoAlignPaymentTermEnabled": true,
    "paymentMethod": "string",
    "autoAlignPaymentMethodEnabled": true,
    "customerRealtimeSyncEnabled": true
  },
  "billingSettings": {
    "Bill Cycle Day": "string",
    "Billing Period": "Month",
    "Billing Start Month": "string",
    "Billing Timing": "In Advance",
    "prorationEnabled": true,
    "Payment Term": "string",
    "hideZeroItems": true,
    "Credit Memo Mode": "Disabled",
    "Term Basis": "US30360",
    "revenueModelMapping": {
      "property1": "string",
      "property2": "string"
    },
    "splitBySalesAccount": true,
    "splitForMilestone": true,
    "specificPeriods": 0,
    "groupingAttributes": [
      {
        "id": "string",
        "name": "string",
        "status": "Active",
        "isStandard": true,
        "groupingField": "string",
        "description": "string",
        "conditions": [
          {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "name": "string",
            "filters": [
              {
                "apiName": "string",
                "name": "string",
                "operand": "string",
                "operator": "string",
                "type": "string",
                "value": "string"
              }
            ]
          }
        ]
      }
    ]
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/billing/tenant-settings/setting:import',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/billing/tenant-settings/setting:import',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/billing/tenant-settings/setting:import', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/billing/tenant-settings/setting:import', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/billing/tenant-settings/setting:import");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/billing/tenant-settings/setting:import", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /billing/tenant-settings/setting:import

Import all billing setting.

Body parameter

{
  "subscriptionDateFieldForBcd": {
    "fieldApiName": "string"
  },
  "autoSetBcdMode": {
    "mode": "AutoSetToFirstSubscription",
    "setting": "string"
  },
  "sfCustomSettings": {
    "autoAlignBillingPeriodEnabled": true,
    "billingPeriodAlign": "Order",
    "autoAlignPaymentTermEnabled": true,
    "paymentMethod": "string",
    "autoAlignPaymentMethodEnabled": true,
    "customerRealtimeSyncEnabled": true
  },
  "billingSettings": {
    "Bill Cycle Day": "string",
    "Billing Period": "Month",
    "Billing Start Month": "string",
    "Billing Timing": "In Advance",
    "prorationEnabled": true,
    "Payment Term": "string",
    "hideZeroItems": true,
    "Credit Memo Mode": "Disabled",
    "Term Basis": "US30360",
    "revenueModelMapping": {
      "property1": "string",
      "property2": "string"
    },
    "splitBySalesAccount": true,
    "splitForMilestone": true,
    "specificPeriods": 0,
    "groupingAttributes": [
      {
        "id": "string",
        "name": "string",
        "status": "Active",
        "isStandard": true,
        "groupingField": "string",
        "description": "string",
        "conditions": [
          {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "name": "string",
            "filters": [
              {
                "apiName": "string",
                "name": "string",
                "operand": "string",
                "operator": "string",
                "type": "string",
                "value": "string"
              }
            ]
          }
        ]
      }
    ]
  }
}

Parameters

Name	In	Type	Required	Description
body	body	ImportAndExportBillingSettingsVO	true	The request to update all billing settings.

Example responses

400 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	None
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline

Response Schema

Export Order System Settings

Code samples

# You can also use wget
curl -X GET https://api.nue.io/v1/orders/settings/setting:export \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.nue.io/v1/orders/settings/setting:export HTTP/1.1
Host: api.nue.io
Accept: */*


const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/orders/settings/setting:export',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/v1/orders/settings/setting:export',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/v1/orders/settings/setting:export', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/v1/orders/settings/setting:export', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/orders/settings/setting:export");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/v1/orders/settings/setting:export", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /orders/settings/setting:export

Export all order system settings.

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	ImportAndExportOrderSettingsVO
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline

Response Schema

Export system settings

Code samples

# You can also use wget
curl -X GET https://api.nue.io/v1/billing/tenant-settings/setting:export \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.nue.io/v1/billing/tenant-settings/setting:export HTTP/1.1
Host: api.nue.io
Accept: */*


const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/billing/tenant-settings/setting:export',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/v1/billing/tenant-settings/setting:export',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/v1/billing/tenant-settings/setting:export', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/v1/billing/tenant-settings/setting:export', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/billing/tenant-settings/setting:export");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/v1/billing/tenant-settings/setting:export", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /billing/tenant-settings/setting:export

Export all billing setting.

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	ImportAndExportBillingSettingsVO
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline

Response Schema

Get Credit Settings

Code samples

# You can also use wget
curl -X GET https://api.nue.io/v1/billing/credit-tenant-settings \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.nue.io/v1/billing/credit-tenant-settings HTTP/1.1
Host: api.nue.io
Accept: */*


const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/billing/credit-tenant-settings',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/v1/billing/credit-tenant-settings',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/v1/billing/credit-tenant-settings', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/v1/billing/credit-tenant-settings', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/billing/credit-tenant-settings");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/v1/billing/credit-tenant-settings", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /billing/credit-tenant-settings

Get Credit Settings.

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	CreditSettingsResponse
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline

Response Schema

Orders

Create Order

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/orders \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/orders HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = '{
  "options": {
    "asyncPayment": true,
    "generateInvoice": true,
    "activateInvoice": true,
    "cancelOnPaymentFail": true,
    "activateOrder": true,
    "calculateTax": true,
    "calculatePrice": true,
    "previewInvoice": true,
    "empty": true,
    "property1": {},
    "property2": {}
  },
  "id": "string",
  "customFields": {
    "property1": {},
    "property2": {}
  },
  "orderProducts": [
    {
      "description": "string",
      "customFields": {
        "property1": {},
        "property2": {}
      },
      "billingTiming": "string",
      "entityId": "string",
      "quantity": 0,
      "subscriptionStartDate": "2019-08-24T14:15:22Z",
      "productId": "string",
      "priceBookEntryId": "string",
      "subscriptionTerm": 0,
      "productOptionId": "string",
      "productOptionQuantity": 0,
      "autoRenew": true,
      "currencyIsoCode": "string",
      "billCycleStartMonth": "string",
      "billCycleDay": "string",
      "billingPeriod": "string",
      "entityUseCode": "string",
      "defaultRenewalTerm": 0,
      "contractLiabilitySegment": "string",
      "contractRevenueSegment": "string",
      "carvesLiabilitySegment": "string",
      "carvesRevenueSegment": "string",
      "carvesEligible": true,
      "requestDisplayId": "string",
      "addOns": [
        {
          "productOptionId": "string",
          "requestDisplayId": "string",
          "tenantId": "string",
          "objectDisplayName": "string",
          "empty": true,
          "property1": {},
          "property2": {}
        }
      ],
      "priceTagCodes": [
        "string"
      ],
      "priceTagIds": [
        "string"
      ],
      "tenantId": "string",
      "objectDisplayName": "string",
      "empty": true,
      "property1": {},
      "property2": {}
    }
  ],
  "transactionHub": {
    "property1": "string",
    "property2": "string"
  },
  "customer": {
    "contacts": [
      {
        "customerId": "string",
        "requestDisplayId": "string",
        "id": "string",
        "tenantId": "string",
        "objectDisplayName": "string",
        "empty": true,
        "property1": {},
        "property2": {}
      }
    ],
    "shippingCity": "string",
    "shippingPostalCode": "string",
    "shippingState": "string",
    "shippingStreet": "string",
    "requestDisplayId": "string",
    "id": "string",
    "tenantId": "string",
    "objectDisplayName": "string",
    "empty": true,
    "property1": {},
    "property2": {}
  },
  "shippingAddress": "string",
  "billingAddress": "string",
  "billingPeriod": "string",
  "shippingAddressValid": true,
  "billingAddressValid": true,
  "shippingSameAsBillingAddress": true,
  "shippingAddressSameAsBilling": true,
  "shippingAddressSameAsBillingKeyExists": true,
  "requestDisplayId": "string",
  "billToContact": {
    "customerId": "string",
    "requestDisplayId": "string",
    "id": "string",
    "tenantId": "string",
    "objectDisplayName": "string",
    "empty": true,
    "property1": {},
    "property2": {}
  },
  "tenantId": "string",
  "objectDisplayName": "string",
  "empty": true,
  "property1": {},
  "property2": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/orders',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/orders',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/orders', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/orders', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/orders");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/orders", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /orders

Create Order. Create orders with the options to recalculate prices and preview invoices

Body parameter

{
  "options": {
    "asyncPayment": true,
    "generateInvoice": true,
    "activateInvoice": true,
    "cancelOnPaymentFail": true,
    "activateOrder": true,
    "calculateTax": true,
    "calculatePrice": true,
    "previewInvoice": true,
    "empty": true,
    "property1": {},
    "property2": {}
  },
  "id": "string",
  "customFields": {
    "property1": {},
    "property2": {}
  },
  "orderProducts": [
    {
      "description": "string",
      "customFields": {
        "property1": {},
        "property2": {}
      },
      "billingTiming": "string",
      "entityId": "string",
      "quantity": 0,
      "subscriptionStartDate": "2019-08-24T14:15:22Z",
      "productId": "string",
      "priceBookEntryId": "string",
      "subscriptionTerm": 0,
      "productOptionId": "string",
      "productOptionQuantity": 0,
      "autoRenew": true,
      "currencyIsoCode": "string",
      "billCycleStartMonth": "string",
      "billCycleDay": "string",
      "billingPeriod": "string",
      "entityUseCode": "string",
      "defaultRenewalTerm": 0,
      "contractLiabilitySegment": "string",
      "contractRevenueSegment": "string",
      "carvesLiabilitySegment": "string",
      "carvesRevenueSegment": "string",
      "carvesEligible": true,
      "requestDisplayId": "string",
      "addOns": [
        {
          "productOptionId": "string",
          "requestDisplayId": "string",
          "tenantId": "string",
          "objectDisplayName": "string",
          "empty": true,
          "property1": {},
          "property2": {}
        }
      ],
      "priceTagCodes": [
        "string"
      ],
      "priceTagIds": [
        "string"
      ],
      "tenantId": "string",
      "objectDisplayName": "string",
      "empty": true,
      "property1": {},
      "property2": {}
    }
  ],
  "transactionHub": {
    "property1": "string",
    "property2": "string"
  },
  "customer": {
    "contacts": [
      {
        "customerId": "string",
        "requestDisplayId": "string",
        "id": "string",
        "tenantId": "string",
        "objectDisplayName": "string",
        "empty": true,
        "property1": {},
        "property2": {}
      }
    ],
    "shippingCity": "string",
    "shippingPostalCode": "string",
    "shippingState": "string",
    "shippingStreet": "string",
    "requestDisplayId": "string",
    "id": "string",
    "tenantId": "string",
    "objectDisplayName": "string",
    "empty": true,
    "property1": {},
    "property2": {}
  },
  "shippingAddress": "string",
  "billingAddress": "string",
  "billingPeriod": "string",
  "shippingAddressValid": true,
  "billingAddressValid": true,
  "shippingSameAsBillingAddress": true,
  "shippingAddressSameAsBilling": true,
  "shippingAddressSameAsBillingKeyExists": true,
  "requestDisplayId": "string",
  "billToContact": {
    "customerId": "string",
    "requestDisplayId": "string",
    "id": "string",
    "tenantId": "string",
    "objectDisplayName": "string",
    "empty": true,
    "property1": {},
    "property2": {}
  },
  "tenantId": "string",
  "objectDisplayName": "string",
  "empty": true,
  "property1": {},
  "property2": {}
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» additionalProperties	body	object	false	none
» options	body	object	false	none
»» additionalProperties	body	object	false	none
»» asyncPayment	body	boolean	false	none
»» generateInvoice	body	boolean	false	none
»» activateInvoice	body	boolean	false	none
»» cancelOnPaymentFail	body	boolean	false	none
»» activateOrder	body	boolean	false	none
»» calculateTax	body	boolean	false	none
»» calculatePrice	body	boolean	false	none
»» previewInvoice	body	boolean	false	none
»» empty	body	boolean	false	none
» id	body	string	false	none
» customFields	body	object	false	none
»» additionalProperties	body	object	false	none
» orderProducts	body	[OrderProductRequestMap]	false	none
»» additionalProperties	body	object	false	none
»» description	body	string	false	none
»» customFields	body	object	false	none
»»» additionalProperties	body	object	false	none
»» billingTiming	body	string	false	none
»» entityId	body	string	false	none
»» quantity	body	number	false	none
»» subscriptionStartDate	body	string(date-time)	false	none
»» productId	body	string	false	none
»» priceBookEntryId	body	string	false	none
»» subscriptionTerm	body	number	false	none
»» productOptionId	body	string	false	none
»» productOptionQuantity	body	number	false	none
»» autoRenew	body	boolean	false	none
»» currencyIsoCode	body	string	false	none
»» billCycleStartMonth	body	string	false	none
»» billCycleDay	body	string	false	none
»» billingPeriod	body	string	false	none
»» entityUseCode	body	string	false	none
»» defaultRenewalTerm	body	number	false	none
»» contractLiabilitySegment	body	string	false	none
»» contractRevenueSegment	body	string	false	none
»» carvesLiabilitySegment	body	string	false	none
»» carvesRevenueSegment	body	string	false	none
»» carvesEligible	body	boolean	false	none
»» requestDisplayId	body	string	false	none
»» addOns	body	[ProductOptionRequestMap]	false	none
»»» additionalProperties	body	object	false	none
»»» productOptionId	body	string	false	none
»»» requestDisplayId	body	string	false	none
»»» tenantId	body	string	false	none
»»» objectDisplayName	body	string	false	none
»»» empty	body	boolean	false	none
»» priceTagCodes	body	[string]	false	none
»» priceTagIds	body	[string]	false	none
»» tenantId	body	string	false	none
»» objectDisplayName	body	string	false	none
»» empty	body	boolean	false	none
» transactionHub	body	object	false	none
»» additionalProperties	body	string	false	none
» customer	body	object	false	none
»» additionalProperties	body	object	false	none
»» contacts	body	[ContactRequestMap]	false	none
»»» additionalProperties	body	object	false	none
»»» customerId	body	string	false	none
»»» requestDisplayId	body	string	false	none
»»» id	body	string	false	none
»»» tenantId	body	string	false	none
»»» objectDisplayName	body	string	false	none
»»» empty	body	boolean	false	none
»» shippingCity	body	string	false	none
»» shippingPostalCode	body	string	false	none
»» shippingState	body	string	false	none
»» shippingStreet	body	string	false	none
»» requestDisplayId	body	string	false	none
»» id	body	string	false	none
»» tenantId	body	string	false	none
»» objectDisplayName	body	string	false	none
»» empty	body	boolean	false	none
» shippingAddress	body	string	false	none
» billingAddress	body	string	false	none
» billingPeriod	body	string	false	none
» shippingAddressValid	body	boolean	false	none
» billingAddressValid	body	boolean	false	none
» shippingSameAsBillingAddress	body	boolean	false	none
» shippingAddressSameAsBilling	body	boolean	false	none
» shippingAddressSameAsBillingKeyExists	body	boolean	false	none
» requestDisplayId	body	string	false	none
» billToContact	body	ContactRequestMap	false	none
» tenantId	body	string	false	none
» objectDisplayName	body	string	false	none
» empty	body	boolean	false	none

Example responses

400 Response

Create Order Response

{
  "order": {
    "id": "851e1510-3930-4f86-8ddd-d1a52859c0d7",
    "status": "Activated",
    "effectiveDate": "2023-06-22",
    "customerId": "4da6ed1d-ceb2-41f8-b0a9-7acdbccfe943",
    "priceBookId": "01sDE000008OgdTYAS",
    "listTotal": 118.8,
    "subtotal": 118.8,
    "totalPrice": 118.8,
    "taxAmount": 10.25,
    "totalAmount": 129.05,
    "discountAmount": 0,
    "discountPercentage": 0,
    "systemDiscountAmount": 0,
    "systemDiscount": 0
  },
  "orderProducts": [
    {
      "id": "e3e2fe23-208c-4c24-843a-b4183d64d09d",
      "orderId": "851e1510-3930-4f86-8ddd-d1a52859c0d7",
      "description": null,
      "sortOrder": 1,
      "lineType": "LineItem",
      "status": "Activated",
      "isChange": null,
      "uomId": "a0aDE00000D0TvLYAV",
      "productId": "01tDE00000He44PYAR",
      "priceBookEntryId": "01uDE00000Jnm1jYAB",
      "customerId": "4da6ed1d-ceb2-41f8-b0a9-7acdbccfe943",
      "parentId": null,
      "rootId": "e3e2fe23-208c-4c24-843a-b4183d64d09d",
      "summaryItemId": null,
      "quantity": 1,
      "actualQuantity": 1,
      "subscriptionTerm": 12,
      "subscriptionStartDate": "2023-06-22",
      "subscriptionEndDate": "2024-06-21",
      "includedUnits": null,
      "listPrice": 9.9,
      "listTotalPrice": 118.8,
      "totalPrice": 118.8,
      "totalAmount": 129.05,
      "salesPrice": 9.9,
      "netSalesPrice": 9.9,
      "subtotal": 118.8,
      "discount": 0,
      "discountAmount": 0,
      "systemDiscount": 0,
      "systemDiscountAmount": 0,
      "taxAmount": 10.25,
      "deltaCMRR": 9.9,
      "deltaARR": 118.8,
      "deltaACV": 118.8,
      "deltaTCV": 118.8
    }
  ],
  "previewInvoices": null,
  "subscriptions": [
    {
      "id": "f8708d8b-f052-4a9a-92d6-a1dda5e3b7cf",
      "customerId": "4da6ed1d-ceb2-41f8-b0a9-7acdbccfe943",
      "subscriptionInternalNumber": null,
      "name": "SUB-000275",
      "subscriptionVersion": 1,
      "status": "Active",
      "currencyIsoCode": null,
      "subscriptionTerm": 12,
      "actualSubscriptionTerm": 12,
      "uomId": "a0aDE00000D0TvLYAV",
      "subscriptionStartDate": "2023-06-22",
      "subscriptionEndDate": "2024-06-21",
      "autoRenew": null,
      "renewalTerm": 12,
      "productId": "01tDE00000He44PYAR",
      "priceBookEntryId": "01uDE00000Jnm1jYAB",
      "parentId": null,
      "rootId": "f8708d8b-f052-4a9a-92d6-a1dda5e3b7cf",
      "parentObjectType": "Subscription",
      "originalSubscriptionId": null,
      "originalSubscriptionNumber": null,
      "lastVersionedSubscriptionId": null,
      "subscriptionCompositeId": "SUB-000275_1",
      "quantity": 1,
      "salesPrice": 9.9,
      "totalPrice": 118.8,
      "totalAmount": 129.05,
      "taxAmount": 10.25,
      "orderOnDate": null,
      "todayARR": null,
      "todayCMRR": null,
      "totalTCV": 118.8,
      "totalACV": 0,
      "todaysQuantity": null,
      "orderProductId": "e3e2fe23-208c-4c24-843a-b4183d64d09d",
      "priceBookId": "01sDE000008OgdTYAS",
      "listPrice": 9.9,
      "bundled": null,
      "billingTiming": null,
      "billingPeriod": null,
      "includedUnits": null,
      "tcv": 118.8,
      "subscriptionLevel": 1,
      "createdById": null,
      "lastModifiedById": null,
      "reconfigureEffectiveDate": null,
      "cancellationDate": null
    }
  ],
  "assets": [],
  "entitlements": [],
  "invoices": [
    {
      "invoice": {
        "activatedById": null,
        "syncTime": null,
        "endDate": "2023-06-30",
        "dueDate": "2023-07-22",
        "appliedById": null,
        "taxStatus": "Calculated",
        "balance": 3.22625,
        "lastModifiedById": "f02ae75e-2b9a-49dc-bc72-6dc6a2e67fca",
        "customerId": "4da6ed1d-ceb2-41f8-b0a9-7acdbccfe943",
        "id": "0c2610d9-6870-49f4-b82e-57c8f71f8cf6",
        "billToContactId": null,
        "paymentDetails": null,
        "createdById": "f02ae75e-2b9a-49dc-bc72-6dc6a2e67fca",
        "paymentStatus": "NotTransferred",
        "amountWithoutTax": 2.97,
        "amount": 3.22625,
        "appliedByObject": "Invoice",
        "lastModifiedDate": "2023-06-21T19:40:14.909+00:00",
        "recordType": "Invoice",
        "targetDate": "2023-06-22",
        "invoiceDate": "2023-06-22",
        "accountingStatus": "Not Started",
        "invoicePdf": null,
        "paymentHostedUrl": null,
        "createdDate": "2023-06-21T19:40:13.161+00:00",
        "activatedTime": null,
        "name": "INV-00032001",
        "tenantId": "6464400a-58bb-49cd-baf1-e5b4176a5dd8",
        "externalInvoiceId": null,
        "currencyIsoCode": null,
        "taxAmount": 0,
        "isCatchUp": false,
        "startDate": "2023-06-22",
        "status": "Draft"
      },
      "items": [
        {
          "transactionQuantity": 1,
          "endDate": "2023-06-30",
          "productName": "Nue Platform",
          "assetNumber": "SUB-000275",
          "balance": 3.22625,
          "lastModifiedById": "f02ae75e-2b9a-49dc-bc72-6dc6a2e67fca",
          "appliedByItemId": null,
          "transactionAmount": 2.97,
          "invoiceNumber": "INV-00032001",
          "id": "01d24bc8-2090-4e99-b789-931d4af57346",
          "createdById": "f02ae75e-2b9a-49dc-bc72-6dc6a2e67fca",
          "appliedByObject": "Invoice",
          "productId": "01tDE00000He44PYAR",
          "lastModifiedDate": "2023-06-21T19:40:14.904+00:00",
          "recordType": "Invoice",
          "billingTiming": "In Advance",
          "uomId": "a0aDE00000D0TvLYAV",
          "transactionDate": "2023-06-22",
          "assetType": "Subscription",
          "appliedCredits": 0,
          "accountId": "4da6ed1d-ceb2-41f8-b0a9-7acdbccfe943",
          "createdDate": "2023-06-21T19:40:13.172+00:00",
          "tenantId": "6464400a-58bb-49cd-baf1-e5b4176a5dd8",
          "name": "II-00032001",
          "invoiceId": "0c2610d9-6870-49f4-b82e-57c8f71f8cf6",
          "currencyIsoCode": null,
          "taxAmount": 0,
          "isCatchUp": false,
          "ratedCredits": 0,
          "startDate": "2023-06-22"
        }
      ]
    }
  ]
}

Responses

Status	Meaning	Description	Schema
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline
default	Default	default response	CreateOrderResponse

Response Schema

deleteOrders

Code samples

# You can also use wget
curl -X DELETE https://api.nue.io/v1/orders \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*'

DELETE https://api.nue.io/v1/orders HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = '{
  "orderIds": [
    "string"
  ],
  "allowDeleteCanceledOrder": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*'
};

fetch('https://api.nue.io/v1/orders',
{
  method: 'DELETE',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*'
}

result = RestClient.delete 'https://api.nue.io/v1/orders',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*'
}

r = requests.delete('https://api.nue.io/v1/orders', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.nue.io/v1/orders', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/orders");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.nue.io/v1/orders", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /orders

Body parameter

{
  "orderIds": [
    "string"
  ],
  "allowDeleteCanceledOrder": true
}

Parameters

Name	In	Type	Required	Description
body	body	DeleteOrderRequest	true	none

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	OrdersDeleteResponse
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline

Response Schema

Get Order

Code samples

# You can also use wget
curl -X GET https://api.nue.io/v1/orders/{orderId} \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.nue.io/v1/orders/{orderId} HTTP/1.1
Host: api.nue.io
Accept: */*


const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/orders/{orderId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/v1/orders/{orderId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/v1/orders/{orderId}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/v1/orders/{orderId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/orders/{orderId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/v1/orders/{orderId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /orders/{orderId}

Get Order. Get order by order Id.

Parameters

Name	In	Type	Required	Description
orderId	path	string	true	none

Example responses

400 Response

Get Order Response

{
  "order": {
    "id": "851e1510-3930-4f86-8ddd-d1a52859c0d7",
    "status": "Activated",
    "effectiveDate": "2023-06-22",
    "customerId": "4da6ed1d-ceb2-41f8-b0a9-7acdbccfe943",
    "priceBookId": "01sDE000008OgdTYAS",
    "listTotal": 118.8,
    "subtotal": 118.8,
    "totalPrice": 118.8,
    "taxAmount": 10.25,
    "totalAmount": 129.05,
    "discountAmount": 0,
    "discountPercentage": 0,
    "systemDiscountAmount": 0,
    "systemDiscount": 0
  },
  "orderProducts": [
    {
      "id": "e3e2fe23-208c-4c24-843a-b4183d64d09d",
      "orderId": "851e1510-3930-4f86-8ddd-d1a52859c0d7",
      "description": null,
      "sortOrder": 1,
      "lineType": "LineItem",
      "status": null,
      "isChange": null,
      "uomId": "a0aDE00000D0TvLYAV",
      "productId": "01tDE00000He44PYAR",
      "priceBookEntryId": "01uDE00000Jnm1jYAB",
      "customerId": "4da6ed1d-ceb2-41f8-b0a9-7acdbccfe943",
      "parentId": null,
      "rootId": "e3e2fe23-208c-4c24-843a-b4183d64d09d",
      "summaryItemId": null,
      "quantity": 1,
      "actualQuantity": 1,
      "subscriptionTerm": 12,
      "subscriptionStartDate": "2023-06-22",
      "subscriptionEndDate": "2024-06-21",
      "includedUnits": null,
      "listPrice": 9.9,
      "listTotalPrice": 118.8,
      "totalPrice": 118.8,
      "totalAmount": 129.05,
      "salesPrice": 9.9,
      "netSalesPrice": 9.9,
      "subtotal": 118.8,
      "discount": 0,
      "discountAmount": 0,
      "systemDiscount": 0,
      "systemDiscountAmount": 0,
      "taxAmount": 10.25,
      "deltaCMRR": 9.9,
      "deltaARR": 118.8,
      "deltaACV": 118.8,
      "deltaTCV": 118.8
    }
  ],
  "previewInvoices": null,
  "subscriptions": [
    {
      "id": "f8708d8b-f052-4a9a-92d6-a1dda5e3b7cf",
      "customerId": "4da6ed1d-ceb2-41f8-b0a9-7acdbccfe943",
      "subscriptionInternalNumber": null,
      "name": "SUB-000275",
      "subscriptionVersion": 1,
      "status": "Active",
      "currencyIsoCode": null,
      "subscriptionTerm": 12,
      "actualSubscriptionTerm": 12,
      "uomId": "a0aDE00000D0TvLYAV",
      "subscriptionStartDate": "2023-06-22",
      "subscriptionEndDate": "2024-06-21",
      "autoRenew": null,
      "renewalTerm": 12,
      "productId": "01tDE00000He44PYAR",
      "priceBookEntryId": "01uDE00000Jnm1jYAB",
      "parentId": null,
      "rootId": "f8708d8b-f052-4a9a-92d6-a1dda5e3b7cf",
      "parentObjectType": "Subscription",
      "originalSubscriptionId": null,
      "originalSubscriptionNumber": null,
      "lastVersionedSubscriptionId": null,
      "subscriptionCompositeId": "SUB-000275_1",
      "quantity": 1,
      "salesPrice": 9.9,
      "totalPrice": 118.8,
      "totalAmount": 129.05,
      "taxAmount": 10.25,
      "orderOnDate": null,
      "todayARR": null,
      "todayCMRR": null,
      "totalTCV": 118.8,
      "totalACV": 0,
      "todaysQuantity": null,
      "orderProductId": "e3e2fe23-208c-4c24-843a-b4183d64d09d",
      "priceBookId": "01sDE000008OgdTYAS",
      "listPrice": 9.9,
      "bundled": null,
      "billingTiming": null,
      "billingPeriod": null,
      "includedUnits": null,
      "tcv": 118.8,
      "subscriptionLevel": 1,
      "createdById": null,
      "lastModifiedById": null,
      "reconfigureEffectiveDate": null,
      "cancellationDate": null
    }
  ],
  "assets": [],
  "entitlements": [],
  "invoices": null
}

Responses

Status	Meaning	Description	Schema
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline
default	Default	default response	CreateOrderResponse

Response Schema

Update Order

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/orders/{orderId} \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/orders/{orderId} HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = '{
  "options": {
    "asyncPayment": true,
    "generateInvoice": true,
    "activateInvoice": true,
    "cancelOnPaymentFail": true,
    "activateOrder": true,
    "calculateTax": true,
    "calculatePrice": true,
    "previewInvoice": true,
    "empty": true,
    "property1": {},
    "property2": {}
  },
  "id": "string",
  "customFields": {
    "property1": {},
    "property2": {}
  },
  "orderProducts": [
    {
      "description": "string",
      "customFields": {
        "property1": {},
        "property2": {}
      },
      "billingTiming": "string",
      "entityId": "string",
      "quantity": 0,
      "subscriptionStartDate": "2019-08-24T14:15:22Z",
      "productId": "string",
      "priceBookEntryId": "string",
      "subscriptionTerm": 0,
      "productOptionId": "string",
      "productOptionQuantity": 0,
      "autoRenew": true,
      "currencyIsoCode": "string",
      "billCycleStartMonth": "string",
      "billCycleDay": "string",
      "billingPeriod": "string",
      "entityUseCode": "string",
      "defaultRenewalTerm": 0,
      "contractLiabilitySegment": "string",
      "contractRevenueSegment": "string",
      "carvesLiabilitySegment": "string",
      "carvesRevenueSegment": "string",
      "carvesEligible": true,
      "requestDisplayId": "string",
      "addOns": [
        {
          "productOptionId": "string",
          "requestDisplayId": "string",
          "tenantId": "string",
          "objectDisplayName": "string",
          "empty": true,
          "property1": {},
          "property2": {}
        }
      ],
      "priceTagCodes": [
        "string"
      ],
      "priceTagIds": [
        "string"
      ],
      "tenantId": "string",
      "objectDisplayName": "string",
      "empty": true,
      "property1": {},
      "property2": {}
    }
  ],
  "transactionHub": {
    "property1": "string",
    "property2": "string"
  },
  "customer": {
    "contacts": [
      {
        "customerId": "string",
        "requestDisplayId": "string",
        "id": "string",
        "tenantId": "string",
        "objectDisplayName": "string",
        "empty": true,
        "property1": {},
        "property2": {}
      }
    ],
    "shippingCity": "string",
    "shippingPostalCode": "string",
    "shippingState": "string",
    "shippingStreet": "string",
    "requestDisplayId": "string",
    "id": "string",
    "tenantId": "string",
    "objectDisplayName": "string",
    "empty": true,
    "property1": {},
    "property2": {}
  },
  "shippingAddress": "string",
  "billingAddress": "string",
  "billingPeriod": "string",
  "shippingAddressValid": true,
  "billingAddressValid": true,
  "shippingSameAsBillingAddress": true,
  "shippingAddressSameAsBilling": true,
  "shippingAddressSameAsBillingKeyExists": true,
  "requestDisplayId": "string",
  "billToContact": {
    "customerId": "string",
    "requestDisplayId": "string",
    "id": "string",
    "tenantId": "string",
    "objectDisplayName": "string",
    "empty": true,
    "property1": {},
    "property2": {}
  },
  "tenantId": "string",
  "objectDisplayName": "string",
  "empty": true,
  "property1": {},
  "property2": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/orders/{orderId}',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/orders/{orderId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/orders/{orderId}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/orders/{orderId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/orders/{orderId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/orders/{orderId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /orders/{orderId}

Update Order. Update draft orders with the options to recalculate prices and preview invoices

Body parameter

{
  "options": {
    "asyncPayment": true,
    "generateInvoice": true,
    "activateInvoice": true,
    "cancelOnPaymentFail": true,
    "activateOrder": true,
    "calculateTax": true,
    "calculatePrice": true,
    "previewInvoice": true,
    "empty": true,
    "property1": {},
    "property2": {}
  },
  "id": "string",
  "customFields": {
    "property1": {},
    "property2": {}
  },
  "orderProducts": [
    {
      "description": "string",
      "customFields": {
        "property1": {},
        "property2": {}
      },
      "billingTiming": "string",
      "entityId": "string",
      "quantity": 0,
      "subscriptionStartDate": "2019-08-24T14:15:22Z",
      "productId": "string",
      "priceBookEntryId": "string",
      "subscriptionTerm": 0,
      "productOptionId": "string",
      "productOptionQuantity": 0,
      "autoRenew": true,
      "currencyIsoCode": "string",
      "billCycleStartMonth": "string",
      "billCycleDay": "string",
      "billingPeriod": "string",
      "entityUseCode": "string",
      "defaultRenewalTerm": 0,
      "contractLiabilitySegment": "string",
      "contractRevenueSegment": "string",
      "carvesLiabilitySegment": "string",
      "carvesRevenueSegment": "string",
      "carvesEligible": true,
      "requestDisplayId": "string",
      "addOns": [
        {
          "productOptionId": "string",
          "requestDisplayId": "string",
          "tenantId": "string",
          "objectDisplayName": "string",
          "empty": true,
          "property1": {},
          "property2": {}
        }
      ],
      "priceTagCodes": [
        "string"
      ],
      "priceTagIds": [
        "string"
      ],
      "tenantId": "string",
      "objectDisplayName": "string",
      "empty": true,
      "property1": {},
      "property2": {}
    }
  ],
  "transactionHub": {
    "property1": "string",
    "property2": "string"
  },
  "customer": {
    "contacts": [
      {
        "customerId": "string",
        "requestDisplayId": "string",
        "id": "string",
        "tenantId": "string",
        "objectDisplayName": "string",
        "empty": true,
        "property1": {},
        "property2": {}
      }
    ],
    "shippingCity": "string",
    "shippingPostalCode": "string",
    "shippingState": "string",
    "shippingStreet": "string",
    "requestDisplayId": "string",
    "id": "string",
    "tenantId": "string",
    "objectDisplayName": "string",
    "empty": true,
    "property1": {},
    "property2": {}
  },
  "shippingAddress": "string",
  "billingAddress": "string",
  "billingPeriod": "string",
  "shippingAddressValid": true,
  "billingAddressValid": true,
  "shippingSameAsBillingAddress": true,
  "shippingAddressSameAsBilling": true,
  "shippingAddressSameAsBillingKeyExists": true,
  "requestDisplayId": "string",
  "billToContact": {
    "customerId": "string",
    "requestDisplayId": "string",
    "id": "string",
    "tenantId": "string",
    "objectDisplayName": "string",
    "empty": true,
    "property1": {},
    "property2": {}
  },
  "tenantId": "string",
  "objectDisplayName": "string",
  "empty": true,
  "property1": {},
  "property2": {}
}

Parameters

Name	In	Type	Required	Description
orderId	path	string	true	none
body	body	object	true	none
» additionalProperties	body	object	false	none
» options	body	object	false	none
»» additionalProperties	body	object	false	none
»» asyncPayment	body	boolean	false	none
»» generateInvoice	body	boolean	false	none
»» activateInvoice	body	boolean	false	none
»» cancelOnPaymentFail	body	boolean	false	none
»» activateOrder	body	boolean	false	none
»» calculateTax	body	boolean	false	none
»» calculatePrice	body	boolean	false	none
»» previewInvoice	body	boolean	false	none
»» empty	body	boolean	false	none
» id	body	string	false	none
» customFields	body	object	false	none
»» additionalProperties	body	object	false	none
» orderProducts	body	[OrderProductRequestMap]	false	none
»» additionalProperties	body	object	false	none
»» description	body	string	false	none
»» customFields	body	object	false	none
»»» additionalProperties	body	object	false	none
»» billingTiming	body	string	false	none
»» entityId	body	string	false	none
»» quantity	body	number	false	none
»» subscriptionStartDate	body	string(date-time)	false	none
»» productId	body	string	false	none
»» priceBookEntryId	body	string	false	none
»» subscriptionTerm	body	number	false	none
»» productOptionId	body	string	false	none
»» productOptionQuantity	body	number	false	none
»» autoRenew	body	boolean	false	none
»» currencyIsoCode	body	string	false	none
»» billCycleStartMonth	body	string	false	none
»» billCycleDay	body	string	false	none
»» billingPeriod	body	string	false	none
»» entityUseCode	body	string	false	none
»» defaultRenewalTerm	body	number	false	none
»» contractLiabilitySegment	body	string	false	none
»» contractRevenueSegment	body	string	false	none
»» carvesLiabilitySegment	body	string	false	none
»» carvesRevenueSegment	body	string	false	none
»» carvesEligible	body	boolean	false	none
»» requestDisplayId	body	string	false	none
»» addOns	body	[ProductOptionRequestMap]	false	none
»»» additionalProperties	body	object	false	none
»»» productOptionId	body	string	false	none
»»» requestDisplayId	body	string	false	none
»»» tenantId	body	string	false	none
»»» objectDisplayName	body	string	false	none
»»» empty	body	boolean	false	none
»» priceTagCodes	body	[string]	false	none
»» priceTagIds	body	[string]	false	none
»» tenantId	body	string	false	none
»» objectDisplayName	body	string	false	none
»» empty	body	boolean	false	none
» transactionHub	body	object	false	none
»» additionalProperties	body	string	false	none
» customer	body	object	false	none
»» additionalProperties	body	object	false	none
»» contacts	body	[ContactRequestMap]	false	none
»»» additionalProperties	body	object	false	none
»»» customerId	body	string	false	none
»»» requestDisplayId	body	string	false	none
»»» id	body	string	false	none
»»» tenantId	body	string	false	none
»»» objectDisplayName	body	string	false	none
»»» empty	body	boolean	false	none
»» shippingCity	body	string	false	none
»» shippingPostalCode	body	string	false	none
»» shippingState	body	string	false	none
»» shippingStreet	body	string	false	none
»» requestDisplayId	body	string	false	none
»» id	body	string	false	none
»» tenantId	body	string	false	none
»» objectDisplayName	body	string	false	none
»» empty	body	boolean	false	none
» shippingAddress	body	string	false	none
» billingAddress	body	string	false	none
» billingPeriod	body	string	false	none
» shippingAddressValid	body	boolean	false	none
» billingAddressValid	body	boolean	false	none
» shippingSameAsBillingAddress	body	boolean	false	none
» shippingAddressSameAsBilling	body	boolean	false	none
» shippingAddressSameAsBillingKeyExists	body	boolean	false	none
» requestDisplayId	body	string	false	none
» billToContact	body	ContactRequestMap	false	none
» tenantId	body	string	false	none
» objectDisplayName	body	string	false	none
» empty	body	boolean	false	none

Example responses

400 Response

Update Order Response

{
  "order": {
    "id": "851e1510-3930-4f86-8ddd-d1a52859c0d7",
    "status": "Activated",
    "effectiveDate": "2023-06-22",
    "customerId": "4da6ed1d-ceb2-41f8-b0a9-7acdbccfe943",
    "priceBookId": "01sDE000008OgdTYAS",
    "listTotal": 118.8,
    "subtotal": 118.8,
    "totalPrice": 118.8,
    "taxAmount": 10.25,
    "totalAmount": 129.05,
    "discountAmount": 0,
    "discountPercentage": 0,
    "systemDiscountAmount": 0,
    "systemDiscount": 0
  },
  "orderProducts": [
    {
      "id": "e3e2fe23-208c-4c24-843a-b4183d64d09d",
      "orderId": "851e1510-3930-4f86-8ddd-d1a52859c0d7",
      "description": null,
      "sortOrder": 1,
      "lineType": "LineItem",
      "status": "Activated",
      "isChange": null,
      "uomId": "a0aDE00000D0TvLYAV",
      "productId": "01tDE00000He44PYAR",
      "priceBookEntryId": "01uDE00000Jnm1jYAB",
      "customerId": "4da6ed1d-ceb2-41f8-b0a9-7acdbccfe943",
      "parentId": null,
      "rootId": "e3e2fe23-208c-4c24-843a-b4183d64d09d",
      "summaryItemId": null,
      "quantity": 1,
      "actualQuantity": 1,
      "subscriptionTerm": 12,
      "subscriptionStartDate": "2023-06-22",
      "subscriptionEndDate": "2024-06-21",
      "includedUnits": null,
      "listPrice": 9.9,
      "listTotalPrice": 118.8,
      "totalPrice": 118.8,
      "totalAmount": 129.05,
      "salesPrice": 9.9,
      "netSalesPrice": 9.9,
      "subtotal": 118.8,
      "discount": 0,
      "discountAmount": 0,
      "systemDiscount": 0,
      "systemDiscountAmount": 0,
      "taxAmount": 10.25,
      "deltaCMRR": 9.9,
      "deltaARR": 118.8,
      "deltaACV": 118.8,
      "deltaTCV": 118.8
    }
  ],
  "previewInvoices": null,
  "subscriptions": [
    {
      "id": "f8708d8b-f052-4a9a-92d6-a1dda5e3b7cf",
      "customerId": "4da6ed1d-ceb2-41f8-b0a9-7acdbccfe943",
      "subscriptionInternalNumber": null,
      "name": "SUB-000275",
      "subscriptionVersion": 1,
      "status": "Active",
      "currencyIsoCode": null,
      "subscriptionTerm": 12,
      "actualSubscriptionTerm": 12,
      "uomId": "a0aDE00000D0TvLYAV",
      "subscriptionStartDate": "2023-06-22",
      "subscriptionEndDate": "2024-06-21",
      "autoRenew": null,
      "renewalTerm": 12,
      "productId": "01tDE00000He44PYAR",
      "priceBookEntryId": "01uDE00000Jnm1jYAB",
      "parentId": null,
      "rootId": "f8708d8b-f052-4a9a-92d6-a1dda5e3b7cf",
      "parentObjectType": "Subscription",
      "originalSubscriptionId": null,
      "originalSubscriptionNumber": null,
      "lastVersionedSubscriptionId": null,
      "subscriptionCompositeId": "SUB-000275_1",
      "quantity": 1,
      "salesPrice": 9.9,
      "totalPrice": 118.8,
      "totalAmount": 129.05,
      "taxAmount": 10.25,
      "orderOnDate": null,
      "todayARR": null,
      "todayCMRR": null,
      "totalTCV": 118.8,
      "totalACV": 0,
      "todaysQuantity": null,
      "orderProductId": "e3e2fe23-208c-4c24-843a-b4183d64d09d",
      "priceBookId": "01sDE000008OgdTYAS",
      "listPrice": 9.9,
      "bundled": null,
      "billingTiming": null,
      "billingPeriod": null,
      "includedUnits": null,
      "tcv": 118.8,
      "subscriptionLevel": 1,
      "createdById": null,
      "lastModifiedById": null,
      "reconfigureEffectiveDate": null,
      "cancellationDate": null
    }
  ],
  "assets": [],
  "entitlements": [],
  "invoices": [
    {
      "invoice": {
        "activatedById": null,
        "syncTime": null,
        "endDate": "2023-06-30",
        "dueDate": "2023-07-22",
        "appliedById": null,
        "taxStatus": "Calculated",
        "balance": 3.22625,
        "lastModifiedById": "f02ae75e-2b9a-49dc-bc72-6dc6a2e67fca",
        "customerId": "4da6ed1d-ceb2-41f8-b0a9-7acdbccfe943",
        "id": "0c2610d9-6870-49f4-b82e-57c8f71f8cf6",
        "billToContactId": null,
        "paymentDetails": null,
        "createdById": "f02ae75e-2b9a-49dc-bc72-6dc6a2e67fca",
        "paymentStatus": "NotTransferred",
        "amountWithoutTax": 2.97,
        "amount": 3.22625,
        "appliedByObject": "Invoice",
        "lastModifiedDate": "2023-06-21T19:40:14.909+00:00",
        "recordType": "Invoice",
        "targetDate": "2023-06-22",
        "invoiceDate": "2023-06-22",
        "accountingStatus": "Not Started",
        "invoicePdf": null,
        "paymentHostedUrl": null,
        "createdDate": "2023-06-21T19:40:13.161+00:00",
        "activatedTime": null,
        "name": "INV-00032001",
        "tenantId": "6464400a-58bb-49cd-baf1-e5b4176a5dd8",
        "externalInvoiceId": null,
        "currencyIsoCode": null,
        "taxAmount": 0,
        "isCatchUp": false,
        "startDate": "2023-06-22",
        "status": "Draft"
      },
      "items": [
        {
          "transactionQuantity": 1,
          "endDate": "2023-06-30",
          "productName": "Nue Platform",
          "assetNumber": "SUB-000275",
          "balance": 3.22625,
          "lastModifiedById": "f02ae75e-2b9a-49dc-bc72-6dc6a2e67fca",
          "appliedByItemId": null,
          "transactionAmount": 2.97,
          "invoiceNumber": "INV-00032001",
          "id": "01d24bc8-2090-4e99-b789-931d4af57346",
          "createdById": "f02ae75e-2b9a-49dc-bc72-6dc6a2e67fca",
          "appliedByObject": "Invoice",
          "productId": "01tDE00000He44PYAR",
          "lastModifiedDate": "2023-06-21T19:40:14.904+00:00",
          "recordType": "Invoice",
          "billingTiming": "In Advance",
          "uomId": "a0aDE00000D0TvLYAV",
          "transactionDate": "2023-06-22",
          "assetType": "Subscription",
          "appliedCredits": 0,
          "accountId": "4da6ed1d-ceb2-41f8-b0a9-7acdbccfe943",
          "createdDate": "2023-06-21T19:40:13.172+00:00",
          "tenantId": "6464400a-58bb-49cd-baf1-e5b4176a5dd8",
          "name": "II-00032001",
          "invoiceId": "0c2610d9-6870-49f4-b82e-57c8f71f8cf6",
          "currencyIsoCode": null,
          "taxAmount": 0,
          "isCatchUp": false,
          "ratedCredits": 0,
          "startDate": "2023-06-22"
        }
      ]
    }
  ]
}

Responses

Status	Meaning	Description	Schema
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline
default	Default	default response	CreateOrderResponse

Response Schema

Cancel Orders

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/orders/{orderId}:cancel \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/orders/{orderId}:cancel HTTP/1.1
Host: api.nue.io
Accept: */*


const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/orders/{orderId}:cancel',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/orders/{orderId}:cancel',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/orders/{orderId}:cancel', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/orders/{orderId}:cancel', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/orders/{orderId}:cancel");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/orders/{orderId}:cancel", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /orders/{orderId}:cancel

Cancel an activated orders.

Parameters

Name	In	Type	Required	Description
orderId	path	string	true	none

Example responses

400 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	None
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline

Response Schema

Activate Order

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/orders/{orderId}:activate \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/orders/{orderId}:activate HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = '{
  "generateInvoice": true,
  "activateInvoice": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/orders/{orderId}:activate',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/orders/{orderId}:activate',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/orders/{orderId}:activate', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/orders/{orderId}:activate', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/orders/{orderId}:activate");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/orders/{orderId}:activate", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /orders/{orderId}:activate

Activate Order. Activate draft order by order Id.

Body parameter

Activate Order Request Sample

{
  "generateInvoice": true,
  "activateInvoice": true
}

Parameters

Name	In	Type	Required	Description
orderId	path	string	true	none
body	body	ActivateOrderRequest	true	The request to activate a draft order.

Example responses

400 Response

Activate Order Response

{
  "order": {
    "id": "bd8476ce-9e97-4dfc-9c78-660713f6e018",
    "status": "Activated",
    "effectiveDate": "2023-06-22",
    "customerId": "e4d5e620-9cd5-493f-b66a-864e64941a6d",
    "priceBookId": "01sDE000008OgdTYAS",
    "listTotal": 118.8,
    "subtotal": 118.8,
    "totalPrice": 118.8,
    "taxAmount": null,
    "totalAmount": 118.8,
    "discountAmount": 0,
    "discountPercentage": 0,
    "systemDiscountAmount": 0,
    "systemDiscount": 0
  },
  "orderProducts": [
    {
      "id": "00299fef-21cd-4441-965e-717e878c0bda",
      "orderId": "bd8476ce-9e97-4dfc-9c78-660713f6e018",
      "description": null,
      "sortOrder": 1,
      "lineType": "LineItem",
      "status": "Activated",
      "isChange": null,
      "uomId": "a0aDE00000D0TvLYAV",
      "productId": "01tDE00000He44PYAR",
      "priceBookEntryId": "01uDE00000Jnm1jYAB",
      "customerId": "e4d5e620-9cd5-493f-b66a-864e64941a6d",
      "parentId": null,
      "rootId": "00299fef-21cd-4441-965e-717e878c0bda",
      "summaryItemId": null,
      "quantity": 1,
      "actualQuantity": 1,
      "subscriptionTerm": 12,
      "subscriptionStartDate": "2023-06-22",
      "subscriptionEndDate": "2024-06-21",
      "includedUnits": null,
      "listPrice": 9.9,
      "listTotalPrice": 118.8,
      "totalPrice": 118.8,
      "totalAmount": 118.8,
      "salesPrice": 9.9,
      "netSalesPrice": 9.9,
      "subtotal": 118.8,
      "discount": 0,
      "discountAmount": 0,
      "systemDiscount": 0,
      "systemDiscountAmount": 0,
      "taxAmount": 0,
      "deltaCMRR": 9.9,
      "deltaARR": 118.8,
      "deltaACV": 118.8,
      "deltaTCV": 118.8
    }
  ],
  "subscriptions": [
    {
      "id": "8d87b8c8-b762-4895-bc8d-43e4224b2247",
      "customerId": "e4d5e620-9cd5-493f-b66a-864e64941a6d",
      "subscriptionInternalNumber": null,
      "name": "SUB-000276",
      "subscriptionVersion": 1,
      "status": "Active",
      "currencyIsoCode": null,
      "subscriptionTerm": 12,
      "actualSubscriptionTerm": 12,
      "uomId": "a0aDE00000D0TvLYAV",
      "subscriptionStartDate": "2023-06-22",
      "subscriptionEndDate": "2024-06-21",
      "autoRenew": null,
      "renewalTerm": 12,
      "productId": "01tDE00000He44PYAR",
      "priceBookEntryId": "01uDE00000Jnm1jYAB",
      "parentId": null,
      "rootId": "8d87b8c8-b762-4895-bc8d-43e4224b2247",
      "parentObjectType": "Subscription",
      "originalSubscriptionId": null,
      "originalSubscriptionNumber": null,
      "lastVersionedSubscriptionId": null,
      "subscriptionCompositeId": "SUB-000276_1",
      "quantity": 1,
      "salesPrice": 9.9,
      "totalPrice": 118.8,
      "totalAmount": 118.8,
      "taxAmount": 0,
      "orderOnDate": null,
      "todayARR": null,
      "todayCMRR": null,
      "totalTCV": 118.8,
      "totalACV": 0,
      "todaysQuantity": null,
      "orderProductId": "00299fef-21cd-4441-965e-717e878c0bda",
      "priceBookId": "01sDE000008OgdTYAS",
      "listPrice": 9.9,
      "bundled": null,
      "billingTiming": null,
      "billingPeriod": null,
      "includedUnits": null,
      "tcv": 118.8,
      "subscriptionLevel": 1,
      "createdById": null,
      "lastModifiedById": null,
      "reconfigureEffectiveDate": null,
      "cancellationDate": null
    }
  ],
  "assets": [],
  "entitlements": [],
  "invoices": null
}

Responses

Status	Meaning	Description	Schema
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline
default	Default	default response	ActivateOrderAndInvoiceResponse

Response Schema

Preview Billing Information

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/orders/invoices:preview \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/orders/invoices:preview HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = '{
  "targetDate": "2023-10-09",
  "orderProducts": [
    {
      "totalPrice": 118.8,
      "tax": 0,
      "startDate": "2023-10-06",
      "quantity": 1,
      "productName": "Nue Platform",
      "productId": "01t8G000002Rf6gQAC",
      "priceModel": "Recurring",
      "netSalesPrice": 9.9,
      "lineType": "LineItem",
      "id": "8028G000001KXtcQAG",
      "endDate": "2024-10-05"
    }
  ],
  "customerId": "0018G00000WpYFiQAN",
  "billingCycle": "Month",
  "currencyIsoCode": "USD",
  "entityId": "a0EQL000003oWuD2AU"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/orders/invoices:preview',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/orders/invoices:preview',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/orders/invoices:preview', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/orders/invoices:preview', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/orders/invoices:preview");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/orders/invoices:preview", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /orders/invoices:preview

Generate the preview invoices in memory for a list of order products of a given customer. The generated invoices will be included in the response payload. There are 2 preview modes:

- First Invoice Only

- Invoices with a Target Date

When choose first invoice only option, only the first invoice will be previewed. The system will use Today’s date or the next billing date, which comes later as the invoice target date to generate a preview of the first invoice. To choose this option, set the firstInvoiceOnly parameter to true.

When choose invoice with a target date option, the system will default the invoice target date as the Start Date of the quote or the order. To choose this option. set the firstInvoiceOnly parameter to false and set the targetDate parameter to the desired target date.

Body parameter

Invoice preview response sample

{
  "targetDate": "2023-10-09",
  "orderProducts": [
    {
      "totalPrice": 118.8,
      "tax": 0,
      "startDate": "2023-10-06",
      "quantity": 1,
      "productName": "Nue Platform",
      "productId": "01t8G000002Rf6gQAC",
      "priceModel": "Recurring",
      "netSalesPrice": 9.9,
      "lineType": "LineItem",
      "id": "8028G000001KXtcQAG",
      "endDate": "2024-10-05"
    }
  ],
  "customerId": "0018G00000WpYFiQAN",
  "billingCycle": "Month",
  "currencyIsoCode": "USD",
  "entityId": "a0EQL000003oWuD2AU"
}

Parameters

Name	In	Type	Required	Description
body	body	OrderInvoicePreviewRequest	true	Invoice preview request

Example responses

400 Response

Invoice preview response sample

[
  {
    "accountId": "0018G00000WpYFiQAN",
    "status": "Draft",
    "accountingStatus": "NotStarted",
    "recordType": "Invoice",
    "amount": 8.25,
    "amountWithoutTax": 8.25,
    "taxAmount": 0,
    "taxStatus": "NotCalculated",
    "balance": 8.25,
    "invoiceDate": "2023-10-25",
    "dueDate": "2023-11-24",
    "startDate": "2023-10-06",
    "endDate": "2023-11-01",
    "targetDate": "2023-10-09",
    "items": [
      {
        "accountId": "0018G00000WpYFiQAN",
        "recordType": "Invoice",
        "productId": "01t8G000002Rf6gQAC",
        "productName": "Nue Platform",
        "assetId": "01t8G000002Rf6gQAC_preview",
        "transactionDate": "2023-10-25",
        "transactionAmount": 8.25,
        "transactionAmountWithoutTax": 8.25,
        "transactionQuantity": 1,
        "taxAmount": 0,
        "ratedCredits": 0,
        "appliedCredits": 0,
        "netSalesPrice": 8.25,
        "balance": 8.25,
        "startDate": "2023-10-06",
        "endDate": "2023-11-01",
        "billingTiming": "InAdvance",
        "status": "Draft",
        "taxStatus": "NotCalculated",
        "details": [
          {
            "accountId": "0018G00000WpYFiQAN",
            "orderProductId": "8028G000001KXtcQAG",
            "detailType": "Committed",
            "billedAmount": 8.25,
            "transactionAmount": 8.25,
            "transactionAmountWithoutTax": 8.25,
            "transactionQuantity": 1,
            "taxAmount": 0,
            "ratedCredits": 0,
            "appliedCredits": 0,
            "startDate": "2023-10-06",
            "endDate": "2023-11-01",
            "billingTiming": "InAdvance",
            "status": "Draft",
            "taxStatus": "NotCalculated"
          }
        ],
        "priceModel": "Recurring"
      }
    ]
  }
]

Responses

Status	Meaning	Description	Schema
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[Invoice]	false	none	[Preview Invoices.]
» accountEx	string	false	none	none
» accountId	string	false	none	none
» accountingStatus	string	false	none	none
» activatedById	string	false	none	none
» activatedTime	string(date-time)	false	none	none
» amount	number	false	none	none
» amountWithoutTax	number	false	none	none
» autoNumberFormat	string	false	none	none
» autoNumberSequence	integer(int64)	false	none	none
» balance	number	false	none	none
» billToContactEx	string	false	none	none
» billToContactId	string	false	none	none
» cancellationDate	string(date)	false	none	none
» currencyIsoCode	string	false	none	none
» dueDate	string(date)	false	none	none
» einvoicingDocId	string(uuid)	false	none	none
» einvoicingDocStatus	string	false	none	none
» einvoicingMandateCode	string	false	none	none
» einvoicingMandateId	string(uuid)	false	none	none
» einvoicingMessage	string	false	none	none
» endDate	string(date)	false	none	none
» entityId	string	false	none	none
» externalInvoiceId	string	false	none	none
» externalTaxId	string	false	none	none
» groupKey	object	true	none	none
»» additionalProperties	string	false	none	none
»» empty	boolean	false	none	none
» id	string(uuid)	false	none	none
» invoiceDate	string(date)	false	none	none
» invoiceNumber	string	false	none	none
» invoicePdf	string	false	none	none
» isCatchUp	boolean	false	none	none
» items	[InvoiceItem]	false	none	none
»» tenantId	string(uuid)	false	none	none
»» accountId	string	false	none	none
»» groupKey	object	false	none	none
»»» additionalProperties	string	false	none	none
»»» empty	boolean	false	none	none
»» invoiceId	string(uuid)	false	none	none
»» invoiceNumber	string	false	none	none
»» id	string(uuid)	false	none	none
»» recordType	string	false	none	none
»» isCatchUp	boolean	false	none	none
»» invoiceItemNumber	string	false	none	none
»» productId	string	false	none	none
»» productName	string	false	none	none
»» assetId	string	false	none	none
»» assetNumber	string	false	none	none
»» assetType	string	false	none	none
»» uomId	string	false	none	none
»» uomEx	string	false	none	none
»» currencyIsoCode	string	false	none	none
»» transactionDate	string(date)	false	none	none
»» transactionAmount	number	false	none	none
»» transactionAmountWithoutTax	number	false	none	none
»» transactionQuantity	number	false	none	none
»» shippingAndHandling	number	false	none	none
»» taxAmount	number	false	none	none
»» ratedCredits	number	false	none	none
»» appliedCredits	number	false	none	none
»» netSalesPrice	number	false	none	none
»» balance	number	false	none	none
»» startDate	string(date)	false	none	none
»» endDate	string(date)	false	none	none
»» billingTiming	string	false	none	none
»» status	string	false	none	none
»» taxStatus	string	false	none	none
»» salesAccountId	string	false	none	none
»» details	[InvoiceItemDetail]	false	none	none
»»» tenantId	string(uuid)	false	none	none
»»» accountId	string	false	none	none
»»» invoiceId	string(uuid)	false	none	none
»»» invoiceItemId	string(uuid)	false	none	none
»»» id	string(uuid)	false	none	none
»»» isCatchUp	boolean	false	none	none
»»» orderProductId	string	false	none	none
»»» detailType	string	false	none	none
»»» billedAmount	number	false	none	none
»»» transactionAmount	number	false	none	none
»»» transactionAmountWithoutTax	number	false	none	none
»»» transactionQuantity	number	false	none	none
»»» shippingAndHandling	number	false	none	none
»»» billedShipping	number	false	none	none
»»» taxAmount	number	false	none	none
»»» netSalesPrice	number	false	none	none
»»» ratedCredits	number	false	none	none
»»» appliedCredits	number	false	none	none
»»» startDate	string(date)	false	none	none
»»» endDate	string(date)	false	none	none
»»» billingTiming	string	false	none	none
»»» status	string	false	none	none
»»» taxStatus	string	false	none	none
»»» currencyIsoCode	string	false	none	none
»»» salesAccountId	string	false	none	none
»»» invoiceItemDetailNumber	string	false	none	none
»»» taxRates	string	false	none	none
»»» vatCode	string	false	none	none
»»» vatNumberTypeId	string	false	none	none
»»» avtUserBIN	string	false	none	none
»»» autoNumberFormat	string	false	none	none
»»» autoNumberSequence	integer(int64)	false	none	none
»»» entityId	string	false	none	none
»» taxCode	string	false	none	none
»» taxMode	string	false	none	none
»» taxRates	string	false	none	none
»» taxPercent	number	false	none	none
»» description	string	false	none	none
»» autoNumberFormat	string	false	none	none
»» autoNumberSequence	integer(int64)	false	none	none
»» entityId	string	false	none	none
» paymentMethods	[string]	false	none	none
» poDates	string	false	none	none
» poNumbers	string	false	none	none
» recordType	string	false	none	none
» salesAccountId	string	false	none	none
» shippingAndHandling	number	false	none	none
» source	string	false	none	none
» startDate	string(date)	false	none	none
» status	string	false	none	none
» syncTime	string(date-time)	false	none	none
» targetDate	string(date)	false	none	none
» taxAmount	number	false	none	none
» taxErrorMessage	string	false	none	none
» taxStatus	string	false	none	none
» templateId	string	false	none	none
» tenantId	string(uuid)	false	none	none
» vatMessages	string	false	none	none

Enumerated Values

Property	Value
accountingStatus	NotStarted
accountingStatus	Complete
accountingStatus	Error
accountingStatus	Skipped
einvoicingDocStatus	Submitted
einvoicingDocStatus	Accepted
einvoicingDocStatus	Pending
einvoicingDocStatus	Error
einvoicingDocStatus	Complete
recordType	Invoice
recordType	CreditMemo
assetType	Subscription
assetType	Asset
assetType	Entitlement
billingTiming	InAdvance
billingTiming	InArrears
status	Draft
status	PendingActivation
status	Active
status	Canceled
status	EInvoicing
taxStatus	NotCalculated
taxStatus	Calculated
taxStatus	Error
taxStatus	Committed
detailType	Committed
detailType	Overage
billingTiming	InAdvance
billingTiming	InArrears
status	Draft
status	PendingActivation
status	Active
status	Canceled
status	EInvoicing
taxStatus	NotCalculated
taxStatus	Calculated
taxStatus	Error
taxStatus	Committed
recordType	Invoice
recordType	CreditMemo
source	Billing
source	CreditConversion
source	PaymentOperation
status	Draft
status	PendingActivation
status	Active
status	Canceled
status	EInvoicing
taxStatus	NotCalculated
taxStatus	Calculated
taxStatus	Error
taxStatus	Committed

Create Change Order

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/orders/change-orders \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/orders/change-orders HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = '{
  "options": {
    "activateOrder": true,
    "generateInvoice": true,
    "activateInvoice": true,
    "calculateTax": true
  },
  "assetChanges": [
    {
      "assetNumber": "SUB-000001",
      "changeType": "UpdateQuantity",
      "quantity": 1,
      "startDate": "2023-08-01"
    }
  ],
  "customer": {
    "name": "sf-customer-982270",
    "email": "[email protected]"
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/orders/change-orders',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/orders/change-orders',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/orders/change-orders', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/orders/change-orders', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/orders/change-orders");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/orders/change-orders", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /orders/change-orders

Create Change Order. Create change orders and generate invoices.

Body parameter

Change Order Request Sample

{
  "options": {
    "activateOrder": true,
    "generateInvoice": true,
    "activateInvoice": true,
    "calculateTax": true
  },
  "assetChanges": [
    {
      "assetNumber": "SUB-000001",
      "changeType": "UpdateQuantity",
      "quantity": 1,
      "startDate": "2023-08-01"
    }
  ],
  "customer": {
    "name": "sf-customer-982270",
    "email": "[email protected]"
  }
}

Parameters

Name	In	Type	Required	Description
body	body	ApiDocsChangeOrderRequest	true	The request to create a change order.

Example responses

400 Response

Create Change Order Response

"\"order\":{\"id\":\"1da5c7af-328f-4a5a-b343-aa8e7af6d833\",\"status\":\"Activated\",\"effectiveDate\":\"2023-06-21\",\"customerId\":\"e4d5e620-9cd5-493f-b66a-864e64941a6d\",\"priceBookId\":\"01sDE000008OgdTYAS\",\"listTotal\":118.8,\"subtotal\":118.8,\"totalPrice\":118.8,\"taxAmount\":0,\"totalAmount\":118.8,\"discountAmount\":0,\"discountPercentage\":0,\"systemDiscountAmount\":0,\"systemDiscount\":0},\"orderProducts\":[{\"id\":\"4aa95cd3-bffa-4e68-9267-5c499904e9de\",\"orderId\":\"1da5c7af-328f-4a5a-b343-aa8e7af6d833\",\"description\":null,\"sortOrder\":1,\"lineType\":\"SummaryItem\",\"status\":\"Activated\",\"isChange\":false,\"uomId\":\"a0aDE00000D0TvLYAV\",\"productId\":\"01tDE00000He44PYAR\",\"priceBookEntryId\":\"01uDE00000Jnm1jYAB\",\"customerId\":\"e4d5e620-9cd5-493f-b66a-864e64941a6d\",\"parentId\":null,\"rootId\":null,\"summaryItemId\":null,\"quantity\":2,\"actualQuantity\":2,\"subscriptionTerm\":12,\"subscriptionStartDate\":\"2023-06-22\",\"subscriptionEndDate\":\"2024-06-21\",\"includedUnits\":null,\"listPrice\":9.9,\"listTotalPrice\":237.6,\"totalPrice\":237.6,\"totalAmount\":237.6,\"salesPrice\":null,\"netSalesPrice\":null,\"subtotal\":237.6,\"discount\":0,\"discountAmount\":0,\"systemDiscount\":0,\"systemDiscountAmount\":0,\"taxAmount\":0,\"deltaCMRR\":null,\"deltaARR\":null,\"deltaACV\":null,\"deltaTCV\":null},{\"id\":\"00f494dc-dbae-4f2e-8dd1-8a7cd7828f90\",\"orderId\":\"1da5c7af-328f-4a5a-b343-aa8e7af6d833\",\"description\":null,\"sortOrder\":2,\"lineType\":\"LineItem\",\"status\":\"Activated\",\"isChange\":true,\"uomId\":\"a0aDE00000D0TvLYAV\",\"productId\":\"01tDE00000He44PYAR\",\"priceBookEntryId\":\"01uDE00000Jnm1jYAB\",\"customerId\":\"e4d5e620-9cd5-493f-b66a-864e64941a6d\",\"parentId\":null,\"rootId\":null,\"summaryItemId\":\"4aa95cd3-bffa-4e68-9267-5c499904e9de\",\"quantity\":1,\"actualQuantity\":1,\"subscriptionTerm\":12,\"subscriptionStartDate\":\"2023-06-22\",\"subscriptionEndDate\":\"2024-06-21\",\"includedUnits\":null,\"listPrice\":9.9,\"listTotalPrice\":118.8,\"totalPrice\":118.8,\"totalAmount\":118.8,\"salesPrice\":9.9,\"netSalesPrice\":9.9,\"subtotal\":118.8,\"discount\":0,\"discountAmount\":0,\"systemDiscount\":0,\"systemDiscountAmount\":0,\"taxAmount\":0,\"deltaCMRR\":9.9,\"deltaARR\":118.8,\"deltaACV\":118.8,\"deltaTCV\":118.8}],\"subscriptions\":[{\"id\":\"8d87b8c8-b762-4895-bc8d-43e4224b2247\",\"customerId\":\"e4d5e620-9cd5-493f-b66a-864e64941a6d\",\"subscriptionInternalNumber\":null,\"name\":\"SUB-000276\",\"subscriptionVersion\":2,\"status\":\"Active\",\"currencyIsoCode\":null,\"subscriptionTerm\":12,\"actualSubscriptionTerm\":12,\"uomId\":\"a0aDE00000D0TvLYAV\",\"subscriptionStartDate\":\"2023-06-22\",\"subscriptionEndDate\":\"2024-06-21\",\"autoRenew\":null,\"renewalTerm\":12,\"productId\":\"01tDE00000He44PYAR\",\"priceBookEntryId\":\"01uDE00000Jnm1jYAB\",\"parentId\":null,\"rootId\":\"8d87b8c8-b762-4895-bc8d-43e4224b2247\",\"parentObjectType\":\"Subscription\",\"originalSubscriptionId\":null,\"originalSubscriptionNumber\":null,\"lastVersionedSubscriptionId\":null,\"subscriptionCompositeId\":\"SUB-000276_2\",\"quantity\":2,\"salesPrice\":9.9,\"totalPrice\":237.6,\"totalAmount\":237.6,\"taxAmount\":0,\"orderOnDate\":null,\"todayARR\":null,\"todayCMRR\":null,\"totalTCV\":118.8,\"totalACV\":237.6,\"todaysQuantity\":null,\"orderProductId\":\"4aa95cd3-bffa-4e68-9267-5c499904e9de\",\"priceBookId\":\"01sDE000008OgdTYAS\",\"listPrice\":9.9,\"bundled\":null,\"billingTiming\":null,\"billingPeriod\":null,\"includedUnits\":null,\"tcv\":237.6,\"subscriptionLevel\":1,\"createdById\":null,\"lastModifiedById\":null,\"reconfigureEffectiveDate\":null,\"cancellationDate\":null}],\"assets\":[],\"entitlements\":[],\"previews\":null,\"invoices\":[{\"invoice\":{\"activatedById\":\"f02ae75e-2b9a-49dc-bc72-6dc6a2e67fca\",\"syncTime\":null,\"endDate\":\"2023-06-30\",\"dueDate\":\"2023-07-22\",\"appliedById\":null,\"taxStatus\":\"Calculated\",\"balance\":2.97,\"lastModifiedById\":\"f02ae75e-2b9a-49dc-bc72-6dc6a2e67fca\",\"customerId\":\"e4d5e620-9cd5-493f-b66a-864e64941a6d\",\"id\":\"2a8d2982-d5dc-4d28-8184-4c646d09b75c\",\"billToContactId\":null,\"paymentDetails\":null,\"createdById\":\"f02ae75e-2b9a-49dc-bc72-6dc6a2e67fca\",\"paymentStatus\":\"NotTransferred\",\"amountWithoutTax\":2.97,\"amount\":2.97,\"appliedByObject\":\"Invoice\",\"lastModifiedDate\":\"2023-06-21T19:44:36.702+00:00\",\"recordType\":\"Invoice\",\"targetDate\":\"2023-06-22\",\"invoiceDate\":\"2023-06-22\",\"accountingStatus\":\"Not Started\",\"invoicePdf\":null,\"paymentHostedUrl\":null,\"createdDate\":\"2023-06-21T19:44:34.642+00:00\",\"activatedTime\":\"2023-06-21T19:44:36.702+00:00\",\"name\":\"INV-00032002\",\"tenantId\":\"6464400a-58bb-49cd-baf1-e5b4176a5dd8\",\"externalInvoiceId\":null,\"currencyIsoCode\":null,\"taxAmount\":0,\"isCatchUp\":false,\"startDate\":\"2023-06-22\",\"status\":\"Active\"},\"items\":[{\"transactionQuantity\":1,\"endDate\":\"2023-06-30\",\"productName\":\"Nue Platform\",\"assetNumber\":\"SUB-000276\",\"balance\":2.97,\"lastModifiedById\":\"f02ae75e-2b9a-49dc-bc72-6dc6a2e67fca\",\"appliedByItemId\":null,\"transactionAmount\":2.97,\"invoiceNumber\":\"INV-00032002\",\"id\":\"cf62cc14-8c2a-4c44-96b8-3bbfa480b683\",\"createdById\":\"f02ae75e-2b9a-49dc-bc72-6dc6a2e67fca\",\"appliedByObject\":\"Invoice\",\"productId\":\"01tDE00000He44PYAR\",\"lastModifiedDate\":\"2023-06-21T19:44:36.710+00:00\",\"recordType\":\"Invoice\",\"billingTiming\":\"In Advance\",\"uomId\":\"a0aDE00000D0TvLYAV\",\"transactionDate\":\"2023-06-22\",\"assetType\":\"Subscription\",\"appliedCredits\":0,\"accountId\":\"e4d5e620-9cd5-493f-b66a-864e64941a6d\",\"createdDate\":\"2023-06-21T19:44:34.650+00:00\",\"tenantId\":\"6464400a-58bb-49cd-baf1-e5b4176a5dd8\",\"name\":\"II-00032002\",\"invoiceId\":\"2a8d2982-d5dc-4d28-8184-4c646d09b75c\",\"currencyIsoCode\":null,\"taxAmount\":0,\"isCatchUp\":false,\"ratedCredits\":0,\"startDate\":\"2023-06-22\"}]}]}"

Responses

Status	Meaning	Description	Schema
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline
default	Default	default response	ChangeOrderCreateResponse

Response Schema

Sync Orders Batch Job

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/billing/orders/sync-jobs \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/billing/orders/sync-jobs HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = '{"parameters":"{\"graphqlFilter\":\"{_and: [{customerId: {_in: [\\\\"00103000014yS4NAAU\\\\", \\\\"00103000014yS4XAAU\\\\", \\\\"00103000014yS4SAAU\\\\"]}}]}\"}","batchSize":200,"scheduleId":"SyncOrder01","name":"sync order batch job"}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/billing/orders/sync-jobs',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/billing/orders/sync-jobs',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/billing/orders/sync-jobs', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/billing/orders/sync-jobs', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/billing/orders/sync-jobs");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/billing/orders/sync-jobs", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /billing/orders/sync-jobs

Batch job to sync orders.

Body parameter

Sync Orders Batch Job

"{\"parameters\":\"{\\\"graphqlFilter\\\":\\\"{_and: [{customerId: {_in: [\\\\\\\\\"00103000014yS4NAAU\\\\\\\\\", \\\\\\\\\"00103000014yS4XAAU\\\\\\\\\", \\\\\\\\\"00103000014yS4SAAU\\\\\\\\\"]}}]}\\\"}\",\"batchSize\":200,\"scheduleId\":\"SyncOrder01\",\"name\":\"sync order batch job\"}"

Parameters

Name	In	Type	Required	Description
body	body	SyncJobRequest	true	The request to create a sync orders job.

Example responses

201 Response

Responses

Status	Meaning	Description	Schema
201	Created	Created	Inline
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline

Response Schema

Update Subscription

Code samples

# You can also use wget
curl -X PATCH https://api.nue.io/v1/orders/subscriptions/{subscriptionId} \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

PATCH https://api.nue.io/v1/orders/subscriptions/{subscriptionId} HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = '{
  "requestDisplayId": "string",
  "id": "string",
  "tenantId": "string",
  "objectDisplayName": "string",
  "empty": true,
  "property1": {},
  "property2": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/orders/subscriptions/{subscriptionId}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch 'https://api.nue.io/v1/orders/subscriptions/{subscriptionId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('https://api.nue.io/v1/orders/subscriptions/{subscriptionId}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','https://api.nue.io/v1/orders/subscriptions/{subscriptionId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/orders/subscriptions/{subscriptionId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "https://api.nue.io/v1/orders/subscriptions/{subscriptionId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PATCH /orders/subscriptions/{subscriptionId}

Update subscription. Update a subscription's fields that are updatable.

Body parameter

{
  "requestDisplayId": "string",
  "id": "string",
  "tenantId": "string",
  "objectDisplayName": "string",
  "empty": true,
  "property1": {},
  "property2": {}
}

Parameters

Name	In	Type	Required	Description
subscriptionId	path	string	true	none
body	body	object	true	none
» additionalProperties	body	object	false	none
» requestDisplayId	body	string	false	none
» id	body	string	false	none
» tenantId	body	string	false	none
» objectDisplayName	body	string	false	none
» empty	body	boolean	false	none

Example responses

400 Response

default Response

{
  "data": {},
  "status": "string",
  "errorType": "string",
  "errorCode": "string",
  "warnings": [
    "string"
  ],
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline
default	Default	default response	SelfServiceResponse

Response Schema

quoteList

Code samples

# You can also use wget
curl -X GET https://api.nue.io/v1/orders/quotes \
  -H 'Accept: application/json'

GET https://api.nue.io/v1/orders/quotes HTTP/1.1
Host: api.nue.io
Accept: application/json


const headers = {
  'Accept':'application/json'
};

fetch('https://api.nue.io/v1/orders/quotes',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api.nue.io/v1/orders/quotes',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.nue.io/v1/orders/quotes', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/v1/orders/quotes', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/orders/quotes");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/v1/orders/quotes", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /orders/quotes

Example responses

200 Response

{}

400 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline

Response Schema

quoteMetadata

Code samples

# You can also use wget
curl -X GET https://api.nue.io/v1/orders/quote/metadata/{objectName} \
  -H 'Accept: */*'

GET https://api.nue.io/v1/orders/quote/metadata/{objectName} HTTP/1.1
Host: api.nue.io
Accept: */*


const headers = {
  'Accept':'*/*'
};

fetch('https://api.nue.io/v1/orders/quote/metadata/{objectName}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*'
}

result = RestClient.get 'https://api.nue.io/v1/orders/quote/metadata/{objectName}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*'
}

r = requests.get('https://api.nue.io/v1/orders/quote/metadata/{objectName}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/v1/orders/quote/metadata/{objectName}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/orders/quote/metadata/{objectName}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/v1/orders/quote/metadata/{objectName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /orders/quote/metadata/{objectName}

Parameters

Name	In	Type	Required	Description
objectName	path	string	true	none

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	DescribeRubyObjectResponse
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline

Response Schema

Get Sync Orders Job

Code samples

# You can also use wget
curl -X GET https://api.nue.io/v1/billing/orders/sync-jobs/{jobId} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.nue.io/v1/billing/orders/sync-jobs/{jobId} HTTP/1.1
Host: api.nue.io
Accept: application/json


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/billing/orders/sync-jobs/{jobId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/v1/billing/orders/sync-jobs/{jobId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/v1/billing/orders/sync-jobs/{jobId}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/v1/billing/orders/sync-jobs/{jobId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/billing/orders/sync-jobs/{jobId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/v1/billing/orders/sync-jobs/{jobId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /billing/orders/sync-jobs/{jobId}

Retrieve the status of the sync orders job.

Parameters

Name	In	Type	Required	Description
jobId	path	string	true	The sync job ID.

Example responses

Batch sync orders job response

{
  "data": {
    "id": "14e4dae9-6bb4-4158-9146-216881834b04",
    "name": "",
    "scheduleId": "",
    "type": "Order",
    "parameters": {
      "graphqlFilter": "{_and: [{customerId: {_eq: \"0016s00000cPEgZAAB\"}}]}"
    },
    "status": "Completed",
    "sourceRecords": 1,
    "targetRecords": 0,
    "recordsToSync": 1,
    "recordsProcessed": 1,
    "batchSize": 200,
    "totalBatches": 1,
    "batchesProcessed": 1,
    "errorCode": "",
    "errorMessage": "",
    "executionSeconds": 3,
    "startTime": 1685336050207,
    "endTime": 1685336053646
  }
}

400 Response

Responses

Status	Meaning	Description	Schema
200	OK	Batch sync orders job	OrderSyncJobResponse
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline

Response Schema

Debit Memos

Debit Memos provide a list of APIs to manage the lifecycle of debit memo.

Create Debit Memo

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/billing/debit-memos \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/billing/debit-memos HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = '{
  "debitMemo": {
    "customerId": "001DE0000344tTzYAI",
    "amount": "100",
    "startDate": "2023-02-02",
    "endDate": "2023-08-03",
    "taxAmount": "0",
    "sourceId": "1298c34f-98bc-46bb-8f5d-a757556e9b4b",
    "sourceType": "Invoice",
    "chargeReason": "LateFee",
    "status": "Active",
    "currencyCode": "USD",
    "description": "Late Fee"
  },
  "notifyCrm": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/billing/debit-memos',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/billing/debit-memos',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/billing/debit-memos', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/billing/debit-memos', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/billing/debit-memos");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/billing/debit-memos", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /billing/debit-memos

Create a debit memo.

Body parameter

Sample Debit Memo

{
  "debitMemo": {
    "customerId": "001DE0000344tTzYAI",
    "amount": "100",
    "startDate": "2023-02-02",
    "endDate": "2023-08-03",
    "taxAmount": "0",
    "sourceId": "1298c34f-98bc-46bb-8f5d-a757556e9b4b",
    "sourceType": "Invoice",
    "chargeReason": "LateFee",
    "status": "Active",
    "currencyCode": "USD",
    "description": "Late Fee"
  },
  "notifyCrm": true
}

Parameters

Name	In	Type	Required	Description
body	body	CreateDebitMemosRequest	true	The request to create a debit memo.

Example responses

400 Response

Response

{
  "id": "838e8a7b-2568-49eb-9b12-b536d2ba79b4",
  "customerId": "001DE0000344tTzYAI",
  "amount": "100",
  "startDate": "2023-02-02",
  "endDate": "2023-08-03",
  "taxAmount": "0",
  "sourceId": "1298c34f-98bc-46bb-8f5d-a757556e9b4b",
  "sourceType": "Invoice",
  "chargeReason": "LateFee",
  "status": "Active",
  "currencyCode": "USD",
  "description": "Late Fee"
}

Responses

Status	Meaning	Description	Schema
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline
default	Default	default response	CreateDebitMemoResponse

Response Schema

Update Debit Memo

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/billing/debit-memos:update \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/billing/debit-memos:update HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = '{
  "debitMemo": {
    "id": "8766605d-13bb-4ed7-81a4-aeeb09928997",
    "customerId": "001DE0000344tTzYAI",
    "amount": "100",
    "startDate": "2023-02-02",
    "endDate": "2023-08-03",
    "taxAmount": "0",
    "sourceId": "1298c34f-98bc-46bb-8f5d-a757556e9b4b",
    "sourceType": "Invoice",
    "chargeReason": "LateFee",
    "status": "Active",
    "currencyCode": "USD",
    "description": "Late Fee"
  },
  "notifyCrm": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/billing/debit-memos:update',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/billing/debit-memos:update',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/billing/debit-memos:update', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/billing/debit-memos:update', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/billing/debit-memos:update");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/billing/debit-memos:update", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /billing/debit-memos:update

Update a debit memo.

Body parameter

Sample Debit Memo

{
  "debitMemo": {
    "id": "8766605d-13bb-4ed7-81a4-aeeb09928997",
    "customerId": "001DE0000344tTzYAI",
    "amount": "100",
    "startDate": "2023-02-02",
    "endDate": "2023-08-03",
    "taxAmount": "0",
    "sourceId": "1298c34f-98bc-46bb-8f5d-a757556e9b4b",
    "sourceType": "Invoice",
    "chargeReason": "LateFee",
    "status": "Active",
    "currencyCode": "USD",
    "description": "Late Fee"
  },
  "notifyCrm": true
}

Parameters

Name	In	Type	Required	Description
body	body	UpdateDebitMemosRequest	true	The request to update a debit memo.

Example responses

400 Response

Response

{
  "id": "838e8a7b-2568-49eb-9b12-b536d2ba79b4",
  "customerId": "001DE0000344tTzYAI",
  "amount": "100",
  "startDate": "2023-02-02",
  "endDate": "2023-08-03",
  "taxAmount": "0",
  "sourceId": "1298c34f-98bc-46bb-8f5d-a757556e9b4b",
  "sourceType": "Invoice",
  "chargeReason": "LateFee",
  "status": "Active",
  "currencyCode": "USD",
  "description": "Late Fee"
}

Responses

Status	Meaning	Description	Schema
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline
default	Default	default response	UpdateDebitMemoResponse

Response Schema

Cancel Debit Memos

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/billing/debit-memos/cancel \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/billing/debit-memos/cancel HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = '{
  "debitMemoIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "notifyCrm": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/billing/debit-memos/cancel',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/billing/debit-memos/cancel',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/billing/debit-memos/cancel', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/billing/debit-memos/cancel', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/billing/debit-memos/cancel");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/billing/debit-memos/cancel", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /billing/debit-memos/cancel

Cancel a list of debit memos.

Body parameter

{
  "debitMemoIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "notifyCrm": true
}

Parameters

Name	In	Type	Required	Description
body	body	CancelDebitMemosRequest	true	The request to cancel a list of debit memos.

Example responses

400 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	None
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline

Response Schema

Activate Draft Debit Memos

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/billing/debit-memos:activate \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/billing/debit-memos:activate HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = '{
  "debitMemoIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "notifyCrm": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/billing/debit-memos:activate',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/billing/debit-memos:activate',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/billing/debit-memos:activate', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/billing/debit-memos:activate', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/billing/debit-memos:activate");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/billing/debit-memos:activate", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /billing/debit-memos:activate

Activate a list of draft debit memos.

Body parameter

{
  "debitMemoIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "notifyCrm": true
}

Parameters

Name	In	Type	Required	Description
body	body	ActivateDebitMemosRequest	true	The request to activate a list of debit memos.

Example responses

400 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	None
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline

Response Schema

Data Sync

Sync specified fields of Order and Billing objects from CRM to Nue. Currently the supported objects are: Order, Invoice and CreditMemo.

Create Specific Fields Sync Job

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/orders/fields-sync-jobs \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/orders/fields-sync-jobs HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = '{
  "parameters": {
    "objectApiName": "Order",
    "fieldApiNames": [
      "IsReseller__c",
      "orderACV",
      "paymentMethod",
      "description",
      "poNumber"
    ],
    "graphqlFilter": "{ IsReseller__c: {  _eq  : false } }"
  },
  "batchSize": 0,
  "scheduleId": "string",
  "name": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/orders/fields-sync-jobs',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/orders/fields-sync-jobs',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/orders/fields-sync-jobs', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/orders/fields-sync-jobs', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/orders/fields-sync-jobs");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/orders/fields-sync-jobs", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /orders/fields-sync-jobs

Create a specific fields sync job from CRM (Salesforce) to Nue

Body parameter

{
  "parameters": {
    "objectApiName": "Order",
    "fieldApiNames": [
      "IsReseller__c",
      "orderACV",
      "paymentMethod",
      "description",
      "poNumber"
    ],
    "graphqlFilter": "{ IsReseller__c: {  _eq  : false } }"
  },
  "batchSize": 0,
  "scheduleId": "string",
  "name": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	SyncJobRequestFieldsSyncParam	true	none

Example responses

201 Response

Responses

Status	Meaning	Description	Schema
201	Created	Created	SyncJobFieldsSyncParam
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline

Response Schema

Get Status of Specific Fields Sync Job

Code samples

# You can also use wget
curl -X GET https://api.nue.io/v1/orders/fields-sync-jobs/{jobId} \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.nue.io/v1/orders/fields-sync-jobs/{jobId} HTTP/1.1
Host: api.nue.io
Accept: */*


const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/orders/fields-sync-jobs/{jobId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/v1/orders/fields-sync-jobs/{jobId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/v1/orders/fields-sync-jobs/{jobId}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/v1/orders/fields-sync-jobs/{jobId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/orders/fields-sync-jobs/{jobId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/v1/orders/fields-sync-jobs/{jobId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /orders/fields-sync-jobs/{jobId}

Get Status of the given fields sync job

Parameters

Name	In	Type	Required	Description
jobId	path	string(uuid)	true	The fields sync job ID

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	SyncJobFieldsSyncParam
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline

Response Schema

Credit Memos

Credit Memos provide a list of APIs to manage the lifecycle of credit memos.

A credit memo has the folowing 3 statuses: Draft, Active, Canceled. There are the following supported status transition scenarios:

A Draft credit memo can be changed to Active status via activation;
A Draft credit memo can be changed to Canceled status via cancellation;
A user may only delete credit memos in Canceled status;
Currently, an Active credit memo or a Canceled credit memo cannot be transitioned to other statuses.

Cancel Credit Memos

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/billing/credit-memos:async-cancel \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/billing/credit-memos:async-cancel HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = '{
  "creditMemoIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "notifyCrm": true,
  "notifyDebitMemoChangedToCrm": true,
  "notifyPaymentChangedToCrm": true,
  "creditMemoComment": {
    "comment": "example comment"
  },
  "paymentDetail": "string",
  "graphqlFilter": "{status: {_eq: \"Active\"}}"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/billing/credit-memos:async-cancel',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/billing/credit-memos:async-cancel',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/billing/credit-memos:async-cancel', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/billing/credit-memos:async-cancel', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/billing/credit-memos:async-cancel");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/billing/credit-memos:async-cancel", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /billing/credit-memos:async-cancel

Cancel a list of credit memos.

Body parameter

{
  "creditMemoIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "notifyCrm": true,
  "notifyDebitMemoChangedToCrm": true,
  "notifyPaymentChangedToCrm": true,
  "creditMemoComment": {
    "comment": "example comment"
  },
  "paymentDetail": "string",
  "graphqlFilter": "{status: {_eq: \"Active\"}}"
}

Parameters

Name	In	Type	Required	Description
body	body	CancelCreditMemosRequest	true	The request to cancel a list of credit memos.

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	CreateAsyncJobResponse
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline

Response Schema

Activate Draft Credit Memos

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/billing/credit-memos:activate \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/billing/credit-memos:activate HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = '{
  "creditMemoIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "notifyCrm": true,
  "creditMemoComment": {
    "comment": "example comment"
  },
  "creditMemoDate": "2019-08-24",
  "graphqlFilter": "{status: {_eq: \"Draft\"}}",
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "taxAmount": 0,
      "amount": 0,
      "balance": 0,
      "creditMemoDate": "2019-08-24",
      "creditMemoItems": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "creditMemoId": "8714a2c3-d829-4cd1-aad3-7c28d0d2f48b",
          "taxAmount": 0,
          "balance": 0,
          "transactionAmount": 0
        }
      ]
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/billing/credit-memos:activate',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/billing/credit-memos:activate',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/billing/credit-memos:activate', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/billing/credit-memos:activate', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/billing/credit-memos:activate");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/billing/credit-memos:activate", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /billing/credit-memos:activate

Activate a list of draft credit memos.

Body parameter

{
  "creditMemoIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "notifyCrm": true,
  "creditMemoComment": {
    "comment": "example comment"
  },
  "creditMemoDate": "2019-08-24",
  "graphqlFilter": "{status: {_eq: \"Draft\"}}",
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "taxAmount": 0,
      "amount": 0,
      "balance": 0,
      "creditMemoDate": "2019-08-24",
      "creditMemoItems": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "creditMemoId": "8714a2c3-d829-4cd1-aad3-7c28d0d2f48b",
          "taxAmount": 0,
          "balance": 0,
          "transactionAmount": 0
        }
      ]
    }
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	ActivateCreditMemosRequest	true	The request to activate a list of draft credit memos.

Example responses

400 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	None
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline

Response Schema

Update the Specific Credit Memo Un-monetary Values and Custom Fields.

Code samples

# You can also use wget
curl -X PATCH https://api.nue.io/v1/billing/credit-memos/{creditMemoId} \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

PATCH https://api.nue.io/v1/billing/credit-memos/{creditMemoId} HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = '{
  "creditMemoDate": "2019-08-24",
  "paymentDetails": "string",
  "billToContactId": "string",
  "empty": true,
  "property1": {},
  "property2": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/billing/credit-memos/{creditMemoId}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch 'https://api.nue.io/v1/billing/credit-memos/{creditMemoId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('https://api.nue.io/v1/billing/credit-memos/{creditMemoId}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','https://api.nue.io/v1/billing/credit-memos/{creditMemoId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/billing/credit-memos/{creditMemoId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "https://api.nue.io/v1/billing/credit-memos/{creditMemoId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PATCH /billing/credit-memos/{creditMemoId}

Update the specific credit memo un-monetary values and custom fields when the credit memo status is 'Draft', 'Pending Activation' and 'Active'.

Body parameter

{
  "creditMemoDate": "2019-08-24",
  "paymentDetails": "string",
  "billToContactId": "string",
  "empty": true,
  "property1": {},
  "property2": {}
}

Parameters

Name	In	Type	Required	Description
creditMemoId	path	string(uuid)	true	none
body	body	object	true	none
» additionalProperties	body	object	false	none
» creditMemoDate	body	string(date)	false	Specify credit memo date, example = '2023-01-10'
» paymentDetails	body	string	false	Payment details
» billToContactId	body	string	false	Bill to contact ID
» empty	body	boolean	false	none

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline

Response Schema

Search Invoices By Credit Memos Applied

Code samples

# You can also use wget
curl -X GET https://api.nue.io/v1/billing/credit-memos/{creditMemoId}/invoices \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.nue.io/v1/billing/credit-memos/{creditMemoId}/invoices HTTP/1.1
Host: api.nue.io
Accept: */*


const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/billing/credit-memos/{creditMemoId}/invoices',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/v1/billing/credit-memos/{creditMemoId}/invoices',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/v1/billing/credit-memos/{creditMemoId}/invoices', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/v1/billing/credit-memos/{creditMemoId}/invoices', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/billing/credit-memos/{creditMemoId}/invoices");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/v1/billing/credit-memos/{creditMemoId}/invoices", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /billing/credit-memos/{creditMemoId}/invoices

Search invoices by credit memo applied

Parameters

Name	In	Type	Required	Description
creditMemoId	path	string(uuid)	true	none

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	GetInvoicesByCreditMemoAppliedIdResponse
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline

Response Schema

Search Debit Memos By Credit Memos Applied

Code samples

# You can also use wget
curl -X GET https://api.nue.io/v1/billing/credit-memos/{creditMemoId}/debit-memos \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.nue.io/v1/billing/credit-memos/{creditMemoId}/debit-memos HTTP/1.1
Host: api.nue.io
Accept: */*


const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/billing/credit-memos/{creditMemoId}/debit-memos',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/v1/billing/credit-memos/{creditMemoId}/debit-memos',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/v1/billing/credit-memos/{creditMemoId}/debit-memos', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/v1/billing/credit-memos/{creditMemoId}/debit-memos', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/billing/credit-memos/{creditMemoId}/debit-memos");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/v1/billing/credit-memos/{creditMemoId}/debit-memos", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /billing/credit-memos/{creditMemoId}/debit-memos

Search debit memos by credit memo applied

Parameters

Name	In	Type	Required	Description
creditMemoId	path	string(uuid)	true	none

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	GetDebitMemosByCreditMemoAppliedIdResponse
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline

Response Schema

Delete Canceled Credit Memos

Code samples

# You can also use wget
curl -X DELETE https://api.nue.io/v1/billing/credit-memos:async-delete \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

DELETE https://api.nue.io/v1/billing/credit-memos:async-delete HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = '{
  "creditMemoIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "notifyCrm": true,
  "notifyDebitMemoChangedToCrm": true,
  "notifyPaymentChangedToCrm": true,
  "graphqlFilter": "{status: {_eq: \"Canceled\"}}"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/billing/credit-memos:async-delete',
{
  method: 'DELETE',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete 'https://api.nue.io/v1/billing/credit-memos:async-delete',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('https://api.nue.io/v1/billing/credit-memos:async-delete', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.nue.io/v1/billing/credit-memos:async-delete', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/billing/credit-memos:async-delete");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.nue.io/v1/billing/credit-memos:async-delete", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /billing/credit-memos:async-delete

Delete a list of canceled credit memos.

Body parameter

{
  "creditMemoIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "notifyCrm": true,
  "notifyDebitMemoChangedToCrm": true,
  "notifyPaymentChangedToCrm": true,
  "graphqlFilter": "{status: {_eq: \"Canceled\"}}"
}

Parameters

Name	In	Type	Required	Description
body	body	DeleteCreditMemosRequest	true	The request to delete a list of canceled credit memos.

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	CreateAsyncJobResponse
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline

Response Schema

Invoices Payment

Invoices Payment Nue provides a range of APIs for managing invoice payments.

An invoice can have one of 11 payment statuses: NotTransferred, Transferred, TransferError, Paid, PartialPaid, Canceled, Refunded, PartialRefunded, CreditBack, Applied and PartiallyApplied. When an invoice is initially created, its Payment Status is ‘NotTransferred’.

If the invoice is successfully synced to the payment system, the Payment Status should be updated to ‘Transferred’, and the mirrored invoice ID should be set to the External Invoice Id.
If the sync to the payment system fails, the Payment Status should be updated to ‘TransferError’, and the error message should be added to the Payment Details field. Additionally, users should have the ability to re-sync failed invoices either from the detail page or by bulk syncing from the list page.
The Payment Status field also offers other options such as Paid, PartialPaid, Canceled, Applied, PartialApplied, Refunded, PartialRefunded, and CreditBack. Besides storing error messages for invoices with sync errors, the Payment Details field can also hold additional payment information for the invoices in the payment system, if required.

Write-Off Invoices

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/billing/invoices:write-off \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/billing/invoices:write-off HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: application/json

const inputBody = '{
  "writeOffInvoiceIds": [
    "6876b010-f3fa-4559-8b84-c926443a4d00",
    "4f163819-178d-470c-a246-d6768476a6ec"
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/billing/invoices:write-off',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/billing/invoices:write-off',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/billing/invoices:write-off', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/billing/invoices:write-off', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/billing/invoices:write-off");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/billing/invoices:write-off", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /billing/invoices:write-off

Write-off invoices.

Body parameter

Write-off Invoices Request Sample

{
  "writeOffInvoiceIds": [
    "6876b010-f3fa-4559-8b84-c926443a4d00",
    "4f163819-178d-470c-a246-d6768476a6ec"
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	PayInvoicesRequest	true	The write-off invoices request

Example responses

Invoice written off successfully

{
  "paymentApplications": [
    {
      "id": "6876b010-f3fa-4559-8b84-c926443a4d00",
      "invoiceId": "4f163819-178d-470c-a246-d6768476a6ec",
      "debitMemoId": null,
      "paymentId": "PA-001",
      "paymentMethod": "Electronic",
      "transactionAmount": 230,
      "errorCode": null,
      "errorMessage": null
    }
  ]
}

400 Response

Responses

Status	Meaning	Description	Schema
200	OK	Invoice written off successfully	None
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline

Response Schema

Refund Invoices

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/billing/invoices:refund \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/billing/invoices:refund HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: application/json

const inputBody = '{
  "refundInvoices": [
    {
      "invoiceId": "4f163819-178d-470c-a246-d6768476a6ec",
      "customerId": "001QL000006gT2DYAW",
      "transactionAmount": 230,
      "paymentId": "PA-001",
      "paymentSource": "Stripe",
      "paymentNumber": "PA-000001"
    }
  ],
  "configMap": {
    "triggerFromNue": true
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/billing/invoices:refund',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/billing/invoices:refund',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/billing/invoices:refund', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/billing/invoices:refund', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/billing/invoices:refund");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/billing/invoices:refund", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /billing/invoices:refund

Refund existing invoices.

Body parameter

Refund Invoice Request Sample

{
  "refundInvoices": [
    {
      "invoiceId": "4f163819-178d-470c-a246-d6768476a6ec",
      "customerId": "001QL000006gT2DYAW",
      "transactionAmount": 230,
      "paymentId": "PA-001",
      "paymentSource": "Stripe",
      "paymentNumber": "PA-000001"
    }
  ],
  "configMap": {
    "triggerFromNue": true
  }
}

Parameters

Name	In	Type	Required	Description
body	body	RefundInvoicesRequest	true	The refund invoices request

Example responses

Invoice refunded successfully

{
  "paymentApplications": [
    {
      "id": "6876b010-f3fa-4559-8b84-c926443a4d00",
      "invoiceId": "4f163819-178d-470c-a246-d6768476a6ec",
      "debitMemoId": null,
      "paymentId": "PA-001",
      "paymentMethod": "Electronic",
      "transactionAmount": 230,
      "errorCode": null,
      "errorMessage": null
    }
  ]
}

400 Response

Responses

Status	Meaning	Description	Schema
200	OK	Invoice refunded successfully	None
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline

Response Schema

Pay Invoices

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/billing/invoices:pay \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/billing/invoices:pay HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: application/json

const inputBody = '{
  "payInvoices": [
    {
      "invoiceId": "4f163819-178d-470c-a246-d6768476a6ec",
      "customerId": "001QL000006gT2DYAW",
      "transactionAmount": 230,
      "paymentId": "PA-001",
      "paymentSource": "Stripe",
      "paymentNumber": "PA-000001"
    }
  ],
  "configMap": {
    "triggerFromNue": true
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/billing/invoices:pay',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/billing/invoices:pay',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/billing/invoices:pay', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/billing/invoices:pay', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/billing/invoices:pay");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/billing/invoices:pay", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /billing/invoices:pay

Pay existing active invoices.

Body parameter

Payment Invoice Request Sample

{
  "payInvoices": [
    {
      "invoiceId": "4f163819-178d-470c-a246-d6768476a6ec",
      "customerId": "001QL000006gT2DYAW",
      "transactionAmount": 230,
      "paymentId": "PA-001",
      "paymentSource": "Stripe",
      "paymentNumber": "PA-000001"
    }
  ],
  "configMap": {
    "triggerFromNue": true
  }
}

Parameters

Name	In	Type	Required	Description
body	body	PayInvoicesRequest	true	The payment invoices request

Example responses

Invoice paid successfully

{
  "paymentApplications": [
    {
      "id": "6876b010-f3fa-4559-8b84-c926443a4d00",
      "invoiceId": "4f163819-178d-470c-a246-d6768476a6ec",
      "debitMemoId": null,
      "paymentId": "PA-001",
      "paymentMethod": "Electronic",
      "transactionAmount": 230,
      "errorCode": null,
      "errorMessage": null
    }
  ]
}

400 Response

Responses

Status	Meaning	Description	Schema
200	OK	Invoice paid successfully	None
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline

Response Schema

Cancel Payments

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/billing/invoices:cancel-payments \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/billing/invoices:cancel-payments HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = '{
  "paymentIds": [
    "1d31a831-10c4-4d65-aa82-bbb545ddb9f1",
    "8f232482-55f4-4f8b-ba78-2753d08dd8b1"
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/billing/invoices:cancel-payments',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/billing/invoices:cancel-payments',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/billing/invoices:cancel-payments', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/billing/invoices:cancel-payments', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/billing/invoices:cancel-payments");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/billing/invoices:cancel-payments", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /billing/invoices:cancel-payments

This API allows users to cancel a payment. It reverses the payment status of an invoice, depending on the status at the time of the request.

Body parameter

Cancel payments Request Sample

{
  "paymentIds": [
    "1d31a831-10c4-4d65-aa82-bbb545ddb9f1",
    "8f232482-55f4-4f8b-ba78-2753d08dd8b1"
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	CancelPaymentsRequest	true	The cancel payments request

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	InvoicesPaymentResponse
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline

Response Schema

Unapply Credit Memos

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/billing/credit-memos:unapply \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/billing/credit-memos:unapply HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: application/json

const inputBody = '{
  "unappliedInvoices": [
    {
      "invoiceId": "4f163819-178d-470c-a246-d6768476a6ec",
      "customerId": "001QL000006gT2DYAW",
      "creditMemoId": "e3d2197a-7704-42a3-a77f-717337a00346",
      "transactionAmount": 230,
      "paymentId": "PA-001",
      "paymentSource": "Stripe",
      "paymentNumber": "PA-000001"
    }
  ],
  "configMap": {
    "triggerFromNue": true
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/billing/credit-memos:unapply',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/billing/credit-memos:unapply',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/billing/credit-memos:unapply', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/billing/credit-memos:unapply', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/billing/credit-memos:unapply");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/billing/credit-memos:unapply", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /billing/credit-memos:unapply

Unapply credit memos.

Body parameter

Unapply the credit memo from invoices Request Sample

{
  "unappliedInvoices": [
    {
      "invoiceId": "4f163819-178d-470c-a246-d6768476a6ec",
      "customerId": "001QL000006gT2DYAW",
      "creditMemoId": "e3d2197a-7704-42a3-a77f-717337a00346",
      "transactionAmount": 230,
      "paymentId": "PA-001",
      "paymentSource": "Stripe",
      "paymentNumber": "PA-000001"
    }
  ],
  "configMap": {
    "triggerFromNue": true
  }
}

Parameters

Name	In	Type	Required	Description
body	body	UnapplyCreditMemoToInvoiceRequest	true	The unapplied invoices request

Example responses

Credit memo successfully unapplied from invoices

{
  "paymentApplications": [
    {
      "id": "6876b010-f3fa-4559-8b84-c926443a4d00",
      "invoiceId": "4f163819-178d-470c-a246-d6768476a6ec",
      "debitMemoId": null,
      "paymentId": "PA-001",
      "paymentMethod": "Electronic",
      "transactionAmount": 230,
      "errorCode": null,
      "errorMessage": null
    }
  ]
}

400 Response

Responses

Status	Meaning	Description	Schema
200	OK	Credit memo successfully unapplied from invoices	None
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline

Response Schema

Apply Credit Memos

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/billing/credit-memos:apply \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/billing/credit-memos:apply HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: application/json

const inputBody = '{
  "appliedInvoices": [
    {
      "invoiceId": "4f163819-178d-470c-a246-d6768476a6ec",
      "customerId": "001QL000006gT2DYAW",
      "creditMemoId": "e3d2197a-7704-42a3-a77f-717337a00346",
      "transactionAmount": 230,
      "paymentId": "PA-001",
      "paymentSource": "Stripe",
      "paymentNumber": "PA-000001"
    }
  ],
  "configMap": {
    "triggerFromNue": true
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/billing/credit-memos:apply',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/billing/credit-memos:apply',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/billing/credit-memos:apply', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/billing/credit-memos:apply', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/billing/credit-memos:apply");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/billing/credit-memos:apply", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /billing/credit-memos:apply

Apply credit memos

Body parameter

Credit memo applied to invoices Request Sample

{
  "appliedInvoices": [
    {
      "invoiceId": "4f163819-178d-470c-a246-d6768476a6ec",
      "customerId": "001QL000006gT2DYAW",
      "creditMemoId": "e3d2197a-7704-42a3-a77f-717337a00346",
      "transactionAmount": 230,
      "paymentId": "PA-001",
      "paymentSource": "Stripe",
      "paymentNumber": "PA-000001"
    }
  ],
  "configMap": {
    "triggerFromNue": true
  }
}

Parameters

Name	In	Type	Required	Description
body	body	ApplyCreditMemoToInvoiceRequest	true	The applied invoices request

Example responses

Credit memo successfully applied to invoices

{
  "paymentApplications": [
    {
      "id": "6876b010-f3fa-4559-8b84-c926443a4d00",
      "invoiceId": "4f163819-178d-470c-a246-d6768476a6ec",
      "debitMemoId": null,
      "paymentId": "PA-001",
      "paymentMethod": "Electronic",
      "transactionAmount": 230,
      "errorCode": null,
      "errorMessage": null
    }
  ]
}

400 Response

Responses

Status	Meaning	Description	Schema
200	OK	Credit memo successfully applied to invoices	None
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline

Response Schema

Payment Rules

APIs for managing payment rules.

Create a new Payment Rule

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/billing/payment-rules \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/billing/payment-rules HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = '{
  "name": "string",
  "startDate": "2019-08-24",
  "endDate": "2019-08-24",
  "status": "Draft",
  "conditions": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "action": "string",
      "externalSystemType": "string",
      "externalSystemId": "string",
      "filters": [
        {
          "apiName": "string",
          "name": "string",
          "operand": "string",
          "operator": "string",
          "type": "string",
          "value": "string",
          "nestedApiName": "string",
          "nestedType": "string"
        }
      ]
    }
  ],
  "description": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/billing/payment-rules',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/billing/payment-rules',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/billing/payment-rules', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/billing/payment-rules', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/billing/payment-rules");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/billing/payment-rules", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /billing/payment-rules

Create a new payment rule with the provided details.

Body parameter

{
  "name": "string",
  "startDate": "2019-08-24",
  "endDate": "2019-08-24",
  "status": "Draft",
  "conditions": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "action": "string",
      "externalSystemType": "string",
      "externalSystemId": "string",
      "filters": [
        {
          "apiName": "string",
          "name": "string",
          "operand": "string",
          "operator": "string",
          "type": "string",
          "value": "string",
          "nestedApiName": "string",
          "nestedType": "string"
        }
      ]
    }
  ],
  "description": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	PaymentRuleRequest	true	The request to create a payment rule.

Example responses

201 Response

Responses

Status	Meaning	Description	Schema
201	Created	Created	string
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline

Response Schema

Delete payment rules

Code samples

# You can also use wget
curl -X DELETE https://api.nue.io/v1/billing/payment-rules \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

DELETE https://api.nue.io/v1/billing/payment-rules HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = '{
  "paymentRuleIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/billing/payment-rules',
{
  method: 'DELETE',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete 'https://api.nue.io/v1/billing/payment-rules',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('https://api.nue.io/v1/billing/payment-rules', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.nue.io/v1/billing/payment-rules', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/billing/payment-rules");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.nue.io/v1/billing/payment-rules", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /billing/payment-rules

Delete a list of draft payment rules.

Body parameter

{
  "paymentRuleIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	DeletePaymentRulesRequest	true	The request to delete a list of draft payment rules.

Example responses

400 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	None
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline

Response Schema

Process payment rules

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/billing/payment-rules:process \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/billing/payment-rules:process HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = '{
  "objectName": "Invoice",
  "graphqlFilter": {
    "id": {
      "_in": [
        "cc19dd3b-7c82-4047-b490-012730ec0a15",
        "cc19dd3b-7c82-4047-b490-012730ec0a16"
      ]
    }
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/billing/payment-rules:process',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/billing/payment-rules:process',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/billing/payment-rules:process', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/billing/payment-rules:process', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/billing/payment-rules:process");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/billing/payment-rules:process", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /billing/payment-rules:process

Process active payment rules to assign payment systems to invoices. Note: A maximum of 1000 records can be processed at a time.

Body parameter

Process payment rules example

{
  "objectName": "Invoice",
  "graphqlFilter": {
    "id": {
      "_in": [
        "cc19dd3b-7c82-4047-b490-012730ec0a15",
        "cc19dd3b-7c82-4047-b490-012730ec0a16"
      ]
    }
  }
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	Request payload with the object name and filter conditions for processing payment rules.

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	PaymentRulesProcessResponse
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline

Response Schema

Deactivate payment rules

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/billing/payment-rules:deactivate \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/billing/payment-rules:deactivate HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = '{
  "paymentRuleIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/billing/payment-rules:deactivate',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/billing/payment-rules:deactivate',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/billing/payment-rules:deactivate', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/billing/payment-rules:deactivate', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/billing/payment-rules:deactivate");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/billing/payment-rules:deactivate", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /billing/payment-rules:deactivate

Deactivate a list of payment rules.

Body parameter

{
  "paymentRuleIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	DeactivatePaymentRulesRequest	true	The request to deactivate a list of payment rules.

Example responses

400 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	None
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline

Response Schema

Active payment rules

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/billing/payment-rules:activate \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/billing/payment-rules:activate HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = '{
  "paymentRuleIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/billing/payment-rules:activate',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/billing/payment-rules:activate',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/billing/payment-rules:activate', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/billing/payment-rules:activate', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/billing/payment-rules:activate");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/billing/payment-rules:activate", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /billing/payment-rules:activate

Active a list of payment rules.

Body parameter

{
  "paymentRuleIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	ActivePaymentRulesRequest	true	The request to active a list of payment rules.

Example responses

400 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	None
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline

Response Schema

Replicate payment rule

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/billing/payment-rules/{id}:duplicate \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/billing/payment-rules/{id}:duplicate HTTP/1.1
Host: api.nue.io
Accept: */*


const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/billing/payment-rules/{id}:duplicate',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/billing/payment-rules/{id}:duplicate',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/billing/payment-rules/{id}:duplicate', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/billing/payment-rules/{id}:duplicate', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/billing/payment-rules/{id}:duplicate");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/billing/payment-rules/{id}:duplicate", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /billing/payment-rules/{id}:duplicate

Replicate a payment rule.

Parameters

Name	In	Type	Required	Description
id	path	string(uuid)	true	The payment rule ID

Example responses

201 Response

Responses

Status	Meaning	Description	Schema
201	Created	Created	PaymentRuleResponse
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline

Response Schema

Update an existing Payment Rule

Code samples

# You can also use wget
curl -X PATCH https://api.nue.io/v1/billing/payment-rules/{id} \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

PATCH https://api.nue.io/v1/billing/payment-rules/{id} HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = '{
  "name": "string",
  "startDate": "2019-08-24",
  "endDate": "2019-08-24",
  "status": "Draft",
  "conditions": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "action": "string",
      "externalSystemType": "string",
      "externalSystemId": "string",
      "filters": [
        {
          "apiName": "string",
          "name": "string",
          "operand": "string",
          "operator": "string",
          "type": "string",
          "value": "string",
          "nestedApiName": "string",
          "nestedType": "string"
        }
      ]
    }
  ],
  "description": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/billing/payment-rules/{id}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch 'https://api.nue.io/v1/billing/payment-rules/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('https://api.nue.io/v1/billing/payment-rules/{id}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','https://api.nue.io/v1/billing/payment-rules/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/billing/payment-rules/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "https://api.nue.io/v1/billing/payment-rules/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PATCH /billing/payment-rules/{id}

Update an existing payment rule. Only draft payment rules can be updated.

Body parameter

{
  "name": "string",
  "startDate": "2019-08-24",
  "endDate": "2019-08-24",
  "status": "Draft",
  "conditions": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "action": "string",
      "externalSystemType": "string",
      "externalSystemId": "string",
      "filters": [
        {
          "apiName": "string",
          "name": "string",
          "operand": "string",
          "operator": "string",
          "type": "string",
          "value": "string",
          "nestedApiName": "string",
          "nestedType": "string"
        }
      ]
    }
  ],
  "description": "string"
}

Parameters

Name	In	Type	Required	Description
id	path	string(uuid)	true	none
body	body	PaymentRuleRequest	true	The request to update a payment rule.

Example responses

400 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	None
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline

Response Schema

Usage

Usage service provides APIs to manage usage data.

Bulk Rate Usages

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/orders/usage-rate \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/orders/usage-rate HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = '{
  "usages": [
    {
      "referenceId": "e3c9e8eb-db44-4bce-898c-0f667163fd43",
      "subscriptionNumber": "SUB-00059394",
      "consumedQuantity": 10,
      "deltaQuantity": 10,
      "ratingDate": "2023-12-15"
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/orders/usage-rate',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/orders/usage-rate',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/orders/usage-rate', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/orders/usage-rate', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/orders/usage-rate");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/orders/usage-rate", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /orders/usage-rate

Bulk rate customers' usages.

Body parameter

Price rate based on customer's usage.

{
  "usages": [
    {
      "referenceId": "e3c9e8eb-db44-4bce-898c-0f667163fd43",
      "subscriptionNumber": "SUB-00059394",
      "consumedQuantity": 10,
      "deltaQuantity": 10,
      "ratingDate": "2023-12-15"
    }
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	UsageRateBulkRequest	true	Price rate based on customer's usage.

Example responses

400 Response

Price rate based on customer's usage.

{
  "error": null,
  "results": [
    {
      "referenceId": "e3c9e8eb-db44-4bce-898c-0f667163fd43",
      "subscriptionNumber": "SUB-00059394",
      "lineItemId": "d5294074-89fe-42f6-9a25-0fd5413cad17",
      "quantity": 10,
      "ratedCredit": 20,
      "success": true
    }
  ]
}

Responses

Status	Meaning	Description	Schema
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline
default	Default	default response	UsageRateBulkResponse

Response Schema

Query usage by subscriptions

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/usage/usage \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/usage/usage HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = '{
  "since": "2019-08-24T14:15:22Z",
  "until": "2019-08-24T14:15:22Z",
  "subscriptionIds": [
    "string"
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/usage/usage',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/usage/usage',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/usage/usage', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/usage/usage', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/usage/usage");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/usage/usage", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /usage/usage

Retrieve a list of usage records by subscription IDs in specific time frame

Body parameter

{
  "since": "2019-08-24T14:15:22Z",
  "until": "2019-08-24T14:15:22Z",
  "subscriptionIds": [
    "string"
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	GetUsageInBatchRequest	true	none

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	GetUsageInBatchResponse

Rate usage

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/usage/usage:async-rate \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/usage/usage:async-rate HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = '{
  "usageIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "graphqlFilter": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/usage/usage:async-rate',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/usage/usage:async-rate',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/usage/usage:async-rate', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/usage/usage:async-rate', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/usage/usage:async-rate");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/usage/usage:async-rate", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /usage/usage:async-rate

Rate or re-rate usage records by ID. Billed usage may not be re-rated.

Body parameter

{
  "usageIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "graphqlFilter": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	RateUsagesRequest	true	none

Example responses

201 Response

Responses

Status	Meaning	Description	Schema
201	Created	Created	CreateAsyncJobResponse

Cancel usage

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/usage/cancel-usage \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/usage/cancel-usage HTTP/1.1
Host: api.nue.io
Content-Type: application/json

const inputBody = '{
  "usageIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "graphqlFilter": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/usage/cancel-usage',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/usage/cancel-usage',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/usage/cancel-usage', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/usage/cancel-usage', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/usage/cancel-usage");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/usage/cancel-usage", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /usage/cancel-usage

Cancel usage by IDs. Billed usage may not be cancelled.

Body parameter

{
  "usageIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "graphqlFilter": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	CancelUsagesRequest	true	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	None

Post raw usage

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/usage/raw-usage \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/usage/raw-usage HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = '{
  "transactionId": "string",
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "rawUsageNumber": "string",
      "transactionId": "string",
      "customerId": "string",
      "subscriptionId": "string",
      "subscriptionNumber": "string",
      "timestamp": "2019-08-24T14:15:22Z",
      "quantity": 0,
      "usageId": "c4fb7648-d7a1-48ce-ace8-e36d61a9b1ed",
      "salesAccountId": "string",
      "sortKey": 0,
      "customerName": "string",
      "productSKU": "string",
      "productName": "string",
      "autoNumberFormat": "string",
      "autoNumberSequence": 0,
      "properties": {
        "property1": "string",
        "property2": "string"
      },
      "status": "Active"
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/usage/raw-usage',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/usage/raw-usage',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/usage/raw-usage', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/usage/raw-usage', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/usage/raw-usage");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/usage/raw-usage", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /usage/raw-usage

Post raw usage data.

Body parameter

{
  "transactionId": "string",
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "rawUsageNumber": "string",
      "transactionId": "string",
      "customerId": "string",
      "subscriptionId": "string",
      "subscriptionNumber": "string",
      "timestamp": "2019-08-24T14:15:22Z",
      "quantity": 0,
      "usageId": "c4fb7648-d7a1-48ce-ace8-e36d61a9b1ed",
      "salesAccountId": "string",
      "sortKey": 0,
      "customerName": "string",
      "productSKU": "string",
      "productName": "string",
      "autoNumberFormat": "string",
      "autoNumberSequence": 0,
      "properties": {
        "property1": "string",
        "property2": "string"
      },
      "status": "Active"
    }
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	PostRawUsageRequest	true	none

Example responses

201 Response

Responses

Status	Meaning	Description	Schema
201	Created	Created	PostRawUsageResponse

Upload Rated Usage

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/usage/rated-usage \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/usage/rated-usage HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = '{
  "transactionId": "string",
  "data": [
    {
      "customerId": "string",
      "customerName": "string",
      "subscriptionId": "string",
      "subscriptionNumber": "string",
      "productSKU": "string",
      "productName": "string",
      "timestamp": "2019-08-24T14:15:22Z",
      "quantity": 0,
      "ratedAmount": 0,
      "currencyIsoCode": "string",
      "properties": {
        "property1": "string",
        "property2": "string"
      }
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/usage/rated-usage',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/usage/rated-usage',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/usage/rated-usage', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/usage/rated-usage', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/usage/rated-usage");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/usage/rated-usage", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /usage/rated-usage

Upload rated usage records

Body parameter

{
  "transactionId": "string",
  "data": [
    {
      "customerId": "string",
      "customerName": "string",
      "subscriptionId": "string",
      "subscriptionNumber": "string",
      "productSKU": "string",
      "productName": "string",
      "timestamp": "2019-08-24T14:15:22Z",
      "quantity": 0,
      "ratedAmount": 0,
      "currencyIsoCode": "string",
      "properties": {
        "property1": "string",
        "property2": "string"
      }
    }
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	RatedUsageRequest	true	none

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	RatedUsageResponse

Get usage

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/usage/customers/{customerId}/subscriptions/{subscriptionId}/usage \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/usage/customers/{customerId}/subscriptions/{subscriptionId}/usage HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = '{
  "since": "2019-08-24T14:15:22Z",
  "until": "2019-08-24T14:15:22Z"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/usage/customers/{customerId}/subscriptions/{subscriptionId}/usage',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/usage/customers/{customerId}/subscriptions/{subscriptionId}/usage',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/usage/customers/{customerId}/subscriptions/{subscriptionId}/usage', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/usage/customers/{customerId}/subscriptions/{subscriptionId}/usage', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/usage/customers/{customerId}/subscriptions/{subscriptionId}/usage");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/usage/customers/{customerId}/subscriptions/{subscriptionId}/usage", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /usage/customers/{customerId}/subscriptions/{subscriptionId}/usage

Get usage by customer and subscription

Body parameter

{
  "since": "2019-08-24T14:15:22Z",
  "until": "2019-08-24T14:15:22Z"
}

Parameters

Name	In	Type	Required	Description
customerId	path	string	true	none
subscriptionId	path	string	true	none
body	body	GetUsageRequest	true	none

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	GetUsageResponse

GraphQL Query API on GET

Code samples

# You can also use wget
curl -X GET https://api.nue.io/v1/usage/async/graphql?query=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.nue.io/v1/usage/async/graphql?query=string HTTP/1.1
Host: api.nue.io
Accept: application/json


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/usage/async/graphql?query=string',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/v1/usage/async/graphql',
  params: {
  'query' => 'string'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/v1/usage/async/graphql', params={
  'query': 'string'
}, headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/v1/usage/async/graphql', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/usage/async/graphql?query=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/v1/usage/async/graphql", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /usage/async/graphql

The graghQL query is passed in the URL.

Parameters

Name	In	Type	Required	Description
query	query	string	true	none
operationName	query	string	false	none
variables	query	string	false	none

Example responses

200 Response

{}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

GraphQL Query API on POST

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/usage/async/graphql \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Content-Type: string' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/usage/async/graphql HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: application/json
Content-Type: string

const inputBody = 'string';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Content-Type':'string',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/usage/async/graphql',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Content-Type' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/usage/async/graphql',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Content-Type': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/usage/async/graphql', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Content-Type' => 'string',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/usage/async/graphql', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/usage/async/graphql");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Content-Type": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/usage/async/graphql", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /usage/async/graphql

The graghQL query is passed in the request body.

Body parameter

"string"

Parameters

Name	In	Type	Required	Description
Content-Type	header	string	false	none
query	query	string	false	none
operationName	query	string	false	none
variables	query	string	false	none
body	body	string	false	none

Example responses

200 Response

{}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Get usage settings

Code samples

# You can also use wget
curl -X GET https://api.nue.io/v1/usage/tenants/current \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.nue.io/v1/usage/tenants/current HTTP/1.1
Host: api.nue.io
Accept: */*


const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/usage/tenants/current',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/v1/usage/tenants/current',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/v1/usage/tenants/current', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/v1/usage/tenants/current', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/usage/tenants/current");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/v1/usage/tenants/current", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /usage/tenants/current

Get usage settings at the system level

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	TenantConfigurationResponse

Async Job

APIs for using asynchronous jobs for usage in the Usage Service.

Get Async Job Status

Code samples

# You can also use wget
curl -X GET https://api.nue.io/v1/usage/async-jobs/{jobId} \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.nue.io/v1/usage/async-jobs/{jobId} HTTP/1.1
Host: api.nue.io
Accept: */*


const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/usage/async-jobs/{jobId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/v1/usage/async-jobs/{jobId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/v1/usage/async-jobs/{jobId}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/v1/usage/async-jobs/{jobId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/usage/async-jobs/{jobId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/v1/usage/async-jobs/{jobId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /usage/async-jobs/{jobId}

Retrieve the status of the async job.

Parameters

Name	In	Type	Required	Description
jobId	path	string	true	The async job ID.

Example responses

404 Response

default Response

{
  "status": "string",
  "error": {
    "errorCode": "string",
    "errorMessage": "string"
  }
}

Responses

Status	Meaning	Description	Schema
404	Not Found	Job ID not found	AsyncJobResponse
default	Default	The status of the requested async job	AsyncJobResponse

Invoices

Invoices provide a list of APIs to manage the lifecycle of invoices.

An invoice has the folowing 3 statuses: Draft, Active, Canceled. There are the following supported status transition scenarios:

A Draft invoice can be changed to Active status via activation;
A Draft invoice can be changed to Canceled status via cancellation;
A user may only delete invoices in Canceled status;
Currently, an Active invoice or a Canceled invoice cannot be transitioned to other statuses.

Resync invoices to payment system

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/billing/invoices:transferToPayments \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/billing/invoices:transferToPayments HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = '{
  "whereConditions": {
    "id": {
      "_in": [
        "cc19dd3b-7c82-4047-b490-012730ec0a15",
        "cc19dd3b-7c82-4047-b490-012730ec0a16"
      ]
    }
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/billing/invoices:transferToPayments',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/billing/invoices:transferToPayments',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/billing/invoices:transferToPayments', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/billing/invoices:transferToPayments', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/billing/invoices:transferToPayments");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/billing/invoices:transferToPayments", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /billing/invoices:transferToPayments

Resync invoices to payment system.

Body parameter

Resync invoices to payment system

{
  "whereConditions": {
    "id": {
      "_in": [
        "cc19dd3b-7c82-4047-b490-012730ec0a15",
        "cc19dd3b-7c82-4047-b490-012730ec0a16"
      ]
    }
  }
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	The request to resync invoices to payment system.

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResyncInvoiceToPaymentResponse
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline

Response Schema

Convert payment status

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/billing/invoices:convert-payment-status \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/billing/invoices:convert-payment-status HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = '{
  "convertPaymentStatuses": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "paymentStatus": "NotTransferred",
      "paymentDetails": "string"
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/billing/invoices:convert-payment-status',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/billing/invoices:convert-payment-status',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/billing/invoices:convert-payment-status', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/billing/invoices:convert-payment-status', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/billing/invoices:convert-payment-status");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/billing/invoices:convert-payment-status", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /billing/invoices:convert-payment-status

Convert the payment status of invoices/credit memos

Body parameter

{
  "convertPaymentStatuses": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "paymentStatus": "NotTransferred",
      "paymentDetails": "string"
    }
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	ConvertPaymentStatusRequest	true	none

Example responses

400 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	None
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline

Response Schema

Cancel invoices

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/billing/invoices:async-cancel \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/billing/invoices:async-cancel HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = '{
  "invoiceIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "notifyCrm": true,
  "notifyDebitMemoChangedToCrm": true,
  "notifyPaymentChangedToCrm": true,
  "invoiceComment": {
    "comment": "example comment"
  },
  "paymentDetail": "string",
  "graphqlFilter": "{status: {_eq: \"Active\"}}"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/billing/invoices:async-cancel',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/billing/invoices:async-cancel',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/billing/invoices:async-cancel', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/billing/invoices:async-cancel', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/billing/invoices:async-cancel");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/billing/invoices:async-cancel", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /billing/invoices:async-cancel

Cancel a list of invoices.

Body parameter

{
  "invoiceIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "notifyCrm": true,
  "notifyDebitMemoChangedToCrm": true,
  "notifyPaymentChangedToCrm": true,
  "invoiceComment": {
    "comment": "example comment"
  },
  "paymentDetail": "string",
  "graphqlFilter": "{status: {_eq: \"Active\"}}"
}

Parameters

Name	In	Type	Required	Description
body	body	CancelInvoicesRequest	true	The request to cancel a list of invoices.

Example responses

201 Response

Responses

Status	Meaning	Description	Schema
201	Created	Created	CreateAsyncJobResponse
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline

Response Schema

Activate invoices

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/billing/invoices:activate \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/billing/invoices:activate HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = '{
  "invoiceIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "notifyCrm": true,
  "invoiceComment": {
    "comment": "example comment"
  },
  "invoiceDate": "2019-08-24",
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "taxAmount": 0,
      "amount": 0,
      "balance": 0,
      "invoiceDate": "2019-08-24",
      "invoiceItems": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "invoiceId": "4f163819-178d-470c-a246-d6768476a6ec",
          "taxAmount": 0,
          "balance": 0,
          "transactionAmount": 0
        }
      ]
    }
  ],
  "enabledAppliedCredits": true,
  "graphqlFilter": "{status: {_eq: \"Draft\"}}"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/billing/invoices:activate',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/billing/invoices:activate',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/billing/invoices:activate', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/billing/invoices:activate', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/billing/invoices:activate");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/billing/invoices:activate", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /billing/invoices:activate

Activate a list of Draft/PendingActivation invoices.

Body parameter

{
  "invoiceIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "notifyCrm": true,
  "invoiceComment": {
    "comment": "example comment"
  },
  "invoiceDate": "2019-08-24",
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "taxAmount": 0,
      "amount": 0,
      "balance": 0,
      "invoiceDate": "2019-08-24",
      "invoiceItems": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "invoiceId": "4f163819-178d-470c-a246-d6768476a6ec",
          "taxAmount": 0,
          "balance": 0,
          "transactionAmount": 0
        }
      ]
    }
  ],
  "enabledAppliedCredits": true,
  "graphqlFilter": "{status: {_eq: \"Draft\"}}"
}

Parameters

Name	In	Type	Required	Description
body	body	ActivateInvoicesRequest	true	The request to activate a list of Draft/PendingActivation invoices.

Example responses

400 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	None
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline

Response Schema

Create job to sync invoices to Salesforce

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/billing/invoices/sync-jobs \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/billing/invoices/sync-jobs HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = '{
  "parameters": {
    "graphqlFilter": "string"
  },
  "batchSize": 0,
  "scheduleId": "string",
  "name": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/billing/invoices/sync-jobs',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/billing/invoices/sync-jobs',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/billing/invoices/sync-jobs', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/billing/invoices/sync-jobs', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/billing/invoices/sync-jobs");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/billing/invoices/sync-jobs", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /billing/invoices/sync-jobs

Create Batch sync job to sync invoices/credit memos to Salesforce by params

Body parameter

{
  "parameters": {
    "graphqlFilter": "string"
  },
  "batchSize": 0,
  "scheduleId": "string",
  "name": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	SyncJobRequestSyncJobParams	true	none

Example responses

201 Response

Responses

Status	Meaning	Description	Schema
201	Created	Created	SyncJobSyncJobParams
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline

Response Schema

Replay failed invoices

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/billing/invoices/failed-seq-tasks:replay \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/billing/invoices/failed-seq-tasks:replay HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = '{
  "invoiceIds": [
    "53d27b9b-fb60-4eb3-831e-4b8b2ba5a381",
    "9cd40a9b-98fb-4c6c-9b2b-f89873232dc1",
    "fbdf6f2e-69ee-4f03-b7a2-7f99f6965ce9"
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/billing/invoices/failed-seq-tasks:replay',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/billing/invoices/failed-seq-tasks:replay',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/billing/invoices/failed-seq-tasks:replay', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/billing/invoices/failed-seq-tasks:replay', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/billing/invoices/failed-seq-tasks:replay");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/billing/invoices/failed-seq-tasks:replay", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /billing/invoices/failed-seq-tasks:replay

Replay failed invoice sequential tasks (e.g. sync to Salesforce). Please notice that this API may take long time because it will replay all the failed tasks for the given invoices (including callouts) one by one to keep their execution in order. We'd better consider not to put many invoice IDs in one call.

Body parameter

{
  "invoiceIds": [
    "53d27b9b-fb60-4eb3-831e-4b8b2ba5a381",
    "9cd40a9b-98fb-4c6c-9b2b-f89873232dc1",
    "fbdf6f2e-69ee-4f03-b7a2-7f99f6965ce9"
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	ReplayFailedInvoiceSeqTasksRequest	true	The request to replay the failed invoice related sequential tasks.

Example responses

400 Response

default Response

{
  "results": {
    "53d27b9b-fb60-4eb3-831e-4b8b2ba5a381": "Succeeded",
    "9cd40a9b-98fb-4c6c-9b2b-f89873232dc1": "Failed",
    "fbdf6f2e-69ee-4f03-b7a2-7f99f6965ce9": "PartiallySucceeded"
  }
}

Responses

Status	Meaning	Description	Schema
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline
default	Default	default response	ReplayFailedInvoiceSeqTasksResponse

Response Schema

Resync invoice to Salesforce

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/billing/invoice:transfer-to-crm/{invoice-id} \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/billing/invoice:transfer-to-crm/{invoice-id} HTTP/1.1
Host: api.nue.io
Accept: */*


const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/billing/invoice:transfer-to-crm/{invoice-id}',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/billing/invoice:transfer-to-crm/{invoice-id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/billing/invoice:transfer-to-crm/{invoice-id}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/billing/invoice:transfer-to-crm/{invoice-id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/billing/invoice:transfer-to-crm/{invoice-id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/billing/invoice:transfer-to-crm/{invoice-id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /billing/invoice:transfer-to-crm/{invoice-id}

Resync invoice to Salesforce

Parameters

Name	In	Type	Required	Description
invoice-id	path	string(uuid)	true	none

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResyncInvoiceToCrmResponse
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline

Response Schema

Convert Credits

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/billing/credits:convert \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/billing/credits:convert HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = '{
  "credits": [
    {
      "creditId": "4b1b8cde-bd8e-408a-9744-0b64d37593ce",
      "creditNumber": "CRE-000000000001",
      "amount": 50
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/billing/credits:convert',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/billing/credits:convert',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/billing/credits:convert', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/billing/credits:convert', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/billing/credits:convert");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/billing/credits:convert", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /billing/credits:convert

Convert credits to credit memos or negative invoices

Body parameter

Convert credits request sample

{
  "credits": [
    {
      "creditId": "4b1b8cde-bd8e-408a-9744-0b64d37593ce",
      "creditNumber": "CRE-000000000001",
      "amount": 50
    }
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	CreditConvertRequest	true	Convert credits request

Example responses

400 Response

Convert credits Response

{
  "invoices": [
    {
      "id": "d15d8c1a-6871-48c6-8179-bba64d63f885",
      "tenantId": "8308ffcf-d286-4eaf-93ed-67605c02de2f",
      "creditMemoNumber": "CM-00001280",
      "creditMemoDate": "2024-05-07",
      "accountId": "001RK00000EpbwnYAB",
      "status": "Active",
      "amount": 50,
      "amountWithoutTax": 50,
      "taxAmount": 0,
      "balance": 50,
      "dueDate": "2024-06-06",
      "startDate": "2024-05-06",
      "endDate": "2024-05-06",
      "targetDate": "2024-05-07",
      "salesAccountId": "001RK00000EpbwnYAB",
      "items": [
        {
          "id": "0ab92ee4-d06b-4f22-bb21-180a75f7faa8",
          "creditMemoItemNumber": "CMI-00001280",
          "creditMemoId": "d15d8c1a-6871-48c6-8179-bba64d63f885",
          "creditMemoNumber": "CM-00001280",
          "tenantId": "8308ffcf-d286-4eaf-93ed-67605c02de2f",
          "accountId": "001RK00000EpbwnYAB",
          "productId": "01tRK000004dlkkYAA",
          "productName": "Test-OneTimeCredit-Cash-Asset01",
          "assetId": "02iRK000000Wy97YAC",
          "assetNumber": "02iRK000000Wy97YAC",
          "assetType": "Asset",
          "uomId": "a0kRK000001piJQYAY",
          "transactionDate": "2024-05-07",
          "transactionAmount": 50,
          "transactionAmountWithoutTax": 50,
          "transactionQuantity": 25,
          "taxAmount": 0,
          "balance": 50,
          "startDate": "2024-05-06",
          "endDate": "2024-05-06",
          "status": "Active",
          "salesAccountId": "001RK00000EpbwnYAB",
          "details": [
            {
              "id": "97e84005-8c65-45eb-bc6f-e9786af257b9",
              "creditMemoItemDetailNumber": "CMID-0000001280",
              "creditMemoItemId": "0ab92ee4-d06b-4f22-bb21-180a75f7faa8",
              "creditMemoId": "d15d8c1a-6871-48c6-8179-bba64d63f885",
              "tenantId": "8308ffcf-d286-4eaf-93ed-67605c02de2f",
              "accountId": "001RK00000EpbwnYAB",
              "orderProductId": "802RK000008DH1vYAG",
              "transactionAmountWithoutTax": 50,
              "transactionQuantity": 25,
              "taxAmount": 0,
              "startDate": "2024-05-06",
              "endDate": "2024-05-06",
              "billingTiming": "InAdvance",
              "status": "Active",
              "salesAccountId": "001RK00000EpbwnYAB"
            }
          ]
        }
      ]
    }
  ]
}

Responses

Status	Meaning	Description	Schema
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline
default	Default	default response	CreditConvertResponse

Response Schema

Resync credit memos to payment system

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/billing/credit-memos:transferToPayments \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/billing/credit-memos:transferToPayments HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = '{}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/billing/credit-memos:transferToPayments',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/billing/credit-memos:transferToPayments',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/billing/credit-memos:transferToPayments', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/billing/credit-memos:transferToPayments', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/billing/credit-memos:transferToPayments");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/billing/credit-memos:transferToPayments", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /billing/credit-memos:transferToPayments

Resync credit memos to payment system.

Body parameter

{}

Parameters

Name	In	Type	Required	Description
body	body	object	true	none

Example responses

400 Response

Resync credit memos to payment system

{
  "whereConditions": {
    "id": {
      "_in": [
        "f47ac10b-58cc-4372-a567-0e02b2c3d479",
        "f47ac10b-58cc-4372-a567-0e02b2c3d471"
      ]
    }
  }
}

Responses

Status	Meaning	Description	Schema
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline
default	Default	default response	Inline

Response Schema

Resync credit memo to Salesforce

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/billing/credit-memo:transfer-to-crm/{credit-memo-id} \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/billing/credit-memo:transfer-to-crm/{credit-memo-id} HTTP/1.1
Host: api.nue.io
Accept: */*


const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/billing/credit-memo:transfer-to-crm/{credit-memo-id}',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/billing/credit-memo:transfer-to-crm/{credit-memo-id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/billing/credit-memo:transfer-to-crm/{credit-memo-id}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/billing/credit-memo:transfer-to-crm/{credit-memo-id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/billing/credit-memo:transfer-to-crm/{credit-memo-id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/billing/credit-memo:transfer-to-crm/{credit-memo-id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /billing/credit-memo:transfer-to-crm/{credit-memo-id}

Resync credit memo to CRM.

Parameters

Name	In	Type	Required	Description
credit-memo-id	path	string(uuid)	true	none

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResyncCreditMemoToCrmResponse
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline

Response Schema

Update the Specific Invoice Un-monetary Values and Custom Fields.

Code samples

# You can also use wget
curl -X PATCH https://api.nue.io/v1/billing/invoices/{invoiceId} \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

PATCH https://api.nue.io/v1/billing/invoices/{invoiceId} HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = '{
  "invoiceDate": "2019-08-24",
  "dueDate": "2019-08-24",
  "paymentDetails": "string",
  "billToContactId": "string",
  "empty": true,
  "property1": {},
  "property2": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/billing/invoices/{invoiceId}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch 'https://api.nue.io/v1/billing/invoices/{invoiceId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('https://api.nue.io/v1/billing/invoices/{invoiceId}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','https://api.nue.io/v1/billing/invoices/{invoiceId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/billing/invoices/{invoiceId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "https://api.nue.io/v1/billing/invoices/{invoiceId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PATCH /billing/invoices/{invoiceId}

Update the specific invoice un-monetary values and custom fields when the invoice status is 'Draft', 'Pending Activation' and 'Active'.

Body parameter

{
  "invoiceDate": "2019-08-24",
  "dueDate": "2019-08-24",
  "paymentDetails": "string",
  "billToContactId": "string",
  "empty": true,
  "property1": {},
  "property2": {}
}

Parameters

Name	In	Type	Required	Description
invoiceId	path	string(uuid)	true	none
body	body	object	true	none
» additionalProperties	body	object	false	none
» invoiceDate	body	string(date)	false	Specify invoice date, example = '2023-01-10'
» dueDate	body	string(date)	false	The Invoice Due Date, which is defaulted to the Invoice Date plus the number of days specified in the payment term of the order or account.
» paymentDetails	body	string	false	Payment details
» billToContactId	body	string	false	Bill to contact ID
» empty	body	boolean	false	none

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline

Response Schema

Search Credit Memos By Applied Invoice Id

Code samples

# You can also use wget
curl -X GET https://api.nue.io/v1/billing/invoices/{invoiceId}/credit-memos \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.nue.io/v1/billing/invoices/{invoiceId}/credit-memos HTTP/1.1
Host: api.nue.io
Accept: */*


const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/billing/invoices/{invoiceId}/credit-memos',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/v1/billing/invoices/{invoiceId}/credit-memos',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/v1/billing/invoices/{invoiceId}/credit-memos', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/v1/billing/invoices/{invoiceId}/credit-memos', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/billing/invoices/{invoiceId}/credit-memos");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/v1/billing/invoices/{invoiceId}/credit-memos", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /billing/invoices/{invoiceId}/credit-memos

Search credit memos by applied invoice Id

Parameters

Name	In	Type	Required	Description
invoiceId	path	string(uuid)	true	none

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	GetCreditMemoByInvoiceIdResponse
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline

Response Schema

Generate invoice PDF

Code samples

# You can also use wget
curl -X GET https://api.nue.io/v1/billing/invoices/{id}/pdf:generate \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.nue.io/v1/billing/invoices/{id}/pdf:generate HTTP/1.1
Host: api.nue.io
Accept: */*


const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/billing/invoices/{id}/pdf:generate',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/v1/billing/invoices/{id}/pdf:generate',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/v1/billing/invoices/{id}/pdf:generate', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/v1/billing/invoices/{id}/pdf:generate', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/billing/invoices/{id}/pdf:generate");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/v1/billing/invoices/{id}/pdf:generate", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /billing/invoices/{id}/pdf:generate

Generate an invoice PDF using the specified template ID.

Parameters

Name	In	Type	Required	Description
id	path	string(uuid)	true	The invoice ID. The invoice cannot be in Draft or Canceled statuses.
templateId	query	string	false	The invoice template ID used to generate the invoice PDF. If not provided, the default invoice template will be used.

Example responses

400 Response

Responses

Status	Meaning	Description	Schema
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline
default	Default	default response	string

Response Schema

Get sync job status

Code samples

# You can also use wget
curl -X GET https://api.nue.io/v1/billing/invoices/sync-jobs/{jobId} \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.nue.io/v1/billing/invoices/sync-jobs/{jobId} HTTP/1.1
Host: api.nue.io
Accept: */*


const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/billing/invoices/sync-jobs/{jobId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/v1/billing/invoices/sync-jobs/{jobId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/v1/billing/invoices/sync-jobs/{jobId}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/v1/billing/invoices/sync-jobs/{jobId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/billing/invoices/sync-jobs/{jobId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/v1/billing/invoices/sync-jobs/{jobId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /billing/invoices/sync-jobs/{jobId}

Get Status of Batch Sync Job to Sync Invoices/Credit Memos to Salesforce

Parameters

Name	In	Type	Required	Description
jobId	path	string(uuid)	true	The batch sync job ID.

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	SyncJobSyncJobParams
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline

Response Schema

Delete invoices

Code samples

# You can also use wget
curl -X DELETE https://api.nue.io/v1/billing/invoices:async-delete \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

DELETE https://api.nue.io/v1/billing/invoices:async-delete HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = '{
  "invoiceIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "notifyCrm": true,
  "notifyDebitMemoChangedToCrm": true,
  "notifyPaymentChangedToCrm": true,
  "graphqlFilter": "{status: {_eq: \"Canceled\"}}"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/billing/invoices:async-delete',
{
  method: 'DELETE',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete 'https://api.nue.io/v1/billing/invoices:async-delete',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('https://api.nue.io/v1/billing/invoices:async-delete', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.nue.io/v1/billing/invoices:async-delete', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/billing/invoices:async-delete");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.nue.io/v1/billing/invoices:async-delete", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /billing/invoices:async-delete

Delete a list of canceled invoices.

Body parameter

{
  "invoiceIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "notifyCrm": true,
  "notifyDebitMemoChangedToCrm": true,
  "notifyPaymentChangedToCrm": true,
  "graphqlFilter": "{status: {_eq: \"Canceled\"}}"
}

Parameters

Name	In	Type	Required	Description
body	body	DeleteInvoicesRequest	true	The request to delete a list of canceled invoices.

Example responses

201 Response

Responses

Status	Meaning	Description	Schema
201	Created	Created	CreateAsyncJobResponse
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline

Response Schema

Webhook Endpoints

Webhooks are a way for different applications or services to communicate with each other in real-time. In simple terms, a webhook is a method of sending automated notifications or data from one application to another whenever a specific event or trigger occurs. Webhooks are commonly used to enable integrations between different systems, allowing them to exchange data in a timely manner. They are often employed in scenarios such as real-time notifications, data synchronization, triggering actions or workflows, and updating information across multiple platforms. Compared to traditional polling or manual data retrieval methods, webhooks offer a more efficient and proactive way of transmitting information between applications. They eliminate the need for constant polling by the receiving application and enable instant communication when events occur, facilitating streamlined and automated processes in various software ecosystems.

List webhook endpoints

Code samples

# You can also use wget
curl -X GET https://api.nue.io/v1/webhook-endpoints \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.nue.io/v1/webhook-endpoints HTTP/1.1
Host: api.nue.io
Accept: application/json


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/webhook-endpoints',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/v1/webhook-endpoints',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/v1/webhook-endpoints', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/v1/webhook-endpoints', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/webhook-endpoints");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/v1/webhook-endpoints", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /webhook-endpoints

You have the ability to access information about all webhook endpoints that have been registered for your tenant.

Example responses

You will receive a response with the details for all webhooks

{
  "webhooks": [
    {
      "id": "e4db815d-f8cb-4d51-b729-6417fb1296ee",
      "name": "first webhook",
      "eventTypes": [
        "invoice.activated",
        "invoice.canceled",
        "credit_memo.activated",
        "credit_memo.canceled"
      ],
      "actionType": "Webhook",
      "endpoint": "https://mywebsite.com/endpoint1",
      "description": "about the first webhook"
    },
    {
      "id": "e4db815d-f8cb-4d51-b729-6417fb1296ee",
      "name": "second webhook",
      "eventTypes": [
        "invoice.activated",
        "invoice.canceled",
        "credit_memo.activated",
        "credit_memo.canceled"
      ],
      "actionType": "Webhook",
      "endpoint": "https://mywebsite.com/endpoint2",
      "description": "about the second webhook"
    }
  ]
}

400 Response

Responses

Status	Meaning	Description	Schema
200	OK	Retrieves a list of webhook endpoints	CreateEventTypeRegistrationResponse
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline

Response Schema

Register webhook endpoint

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/webhook-endpoints \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/webhook-endpoints HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: application/json

const inputBody = '{
  "name": "string",
  "eventTypes": [
    "string"
  ],
  "endpoint": "string",
  "actionType": "string",
  "description": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/webhook-endpoints',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/webhook-endpoints',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/webhook-endpoints', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/webhook-endpoints', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/webhook-endpoints");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/webhook-endpoints", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /webhook-endpoints

You have the option to utilize the API for registering webhook endpoints, allowing you to be notified regarding events occurring in your workspace.

Body parameter

{
  "name": "string",
  "eventTypes": [
    "string"
  ],
  "endpoint": "string",
  "actionType": "string",
  "description": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	CreateEventTypeRegistrationRequest	true	none

Example responses

register a webhook endpoint response

{
  "id": "e4db815d-f8cb-4d51-b729-6417fb1296ee",
  "name": "first webhook",
  "object": "webhook_endpoint",
  "createdDate": "2023-09-20T17:23:16.592+08:00",
  "createdBy": "ca9d3479-79c8-4d5b-bee0-4d1100984830",
  "lastModifiedDate": "2023-09-20T17:23:16.592+08:00",
  "lastModifiedBy": "ca9d3479-79c8-4d5b-bee0-4d1100984830",
  "description": "the description",
  "status": "enabled",
  "events": [
    "invoice.activated",
    "invoice.canceled",
    "credit_memo.activated",
    "credit_memo.canceled"
  ],
  "endpoint": "https://mywebsite.com/endpoint"
}

400 Response

webhook endpoint url invalid

{
  "title": "BAD_REQUEST",
  "message": "A valid url is required for webhook: {{request:endpoint}}",
  "errorCode": "INVALID_WEBHOOK_ENDPOINT_URL"
}

Responses

Status	Meaning	Description	Schema
200	OK	Register a webhook endpoint	CreateEventTypeRegistrationResponse
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline
500	Internal Server Error	webhook endpoint url invalid	None

Response Schema

Enable webhook endpoint

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/webhook-endpoints/{id}:enable \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/webhook-endpoints/{id}:enable HTTP/1.1
Host: api.nue.io
Accept: application/json


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/webhook-endpoints/{id}:enable',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/webhook-endpoints/{id}:enable',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/webhook-endpoints/{id}:enable', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/webhook-endpoints/{id}:enable', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/webhook-endpoints/{id}:enable");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/webhook-endpoints/{id}:enable", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /webhook-endpoints/{id}:enable

Update integration status to Enabled

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Example responses

response after enable a webhook-endpoint

"webhook enabled"

400 Response

webhook endpoint not found

{
  "title": "BAD_REQUEST",
  "message": "Cannot find webhook endpoint with ID {{webhookId}}}",
  "errorCode": "WEBHOOK_ENDPOINT_NOT_FOUND"
}

Responses

Status	Meaning	Description	Schema
200	OK	enable an webhook endpoint success	None
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline
500	Internal Server Error	webhook endpoint not found	None

Response Schema

Disable webhook endpoint

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/webhook-endpoints/{id}:disable \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/webhook-endpoints/{id}:disable HTTP/1.1
Host: api.nue.io
Accept: application/json


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/webhook-endpoints/{id}:disable',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/webhook-endpoints/{id}:disable',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/webhook-endpoints/{id}:disable', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/webhook-endpoints/{id}:disable', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/webhook-endpoints/{id}:disable");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/webhook-endpoints/{id}:disable", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /webhook-endpoints/{id}:disable

Update integration status to disabled

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Example responses

response after disable a webhook-endpoint

"webhook disabled"

400 Response

webhook endpoint not found

{
  "title": "BAD_REQUEST",
  "message": "Cannot find webhook endpoint with ID {{webhookId}}}",
  "errorCode": "WEBHOOK_ENDPOINT_NOT_FOUND"
}

Responses

Status	Meaning	Description	Schema
200	OK	disable an webhook endpoint success	None
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline
500	Internal Server Error	webhook endpoint not found	None

Response Schema

Delete webhook endpoint

Code samples

# You can also use wget
curl -X DELETE https://api.nue.io/v1/webhook-endpoints/{id} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

DELETE https://api.nue.io/v1/webhook-endpoints/{id} HTTP/1.1
Host: api.nue.io
Accept: application/json


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/webhook-endpoints/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete 'https://api.nue.io/v1/webhook-endpoints/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('https://api.nue.io/v1/webhook-endpoints/{id}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.nue.io/v1/webhook-endpoints/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/webhook-endpoints/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.nue.io/v1/webhook-endpoints/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /webhook-endpoints/{id}

Delete a webhook endpoint given the id.

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Example responses

response after delete an webhook endpoint

"delete success"

400 Response

webhook endpoint not found

{
  "title": "BAD_REQUEST",
  "message": "Cannot find webhook endpoint with ID {{webhookId}}}",
  "errorCode": "WEBHOOK_ENDPOINT_NOT_FOUND"
}

Responses

Status	Meaning	Description	Schema
200	OK	Delete an webhook endpoint success	None
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline
500	Internal Server Error	webhook endpoint not found	None

Response Schema

Update webhook endpoint

Code samples

# You can also use wget
curl -X PATCH https://api.nue.io/v1/webhook-endpoints/{id} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

PATCH https://api.nue.io/v1/webhook-endpoints/{id} HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: application/json

const inputBody = '{
  "name": "string",
  "eventTypes": [
    "string"
  ],
  "actionType": "Webhook",
  "endpoint": "string",
  "description": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/webhook-endpoints/{id}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch 'https://api.nue.io/v1/webhook-endpoints/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('https://api.nue.io/v1/webhook-endpoints/{id}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','https://api.nue.io/v1/webhook-endpoints/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/webhook-endpoints/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "https://api.nue.io/v1/webhook-endpoints/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PATCH /webhook-endpoints/{id}

You can patch webhook endpoints via this API by webhook endpoint's id.

Body parameter

{
  "name": "string",
  "eventTypes": [
    "string"
  ],
  "actionType": "Webhook",
  "endpoint": "string",
  "description": "string"
}

Parameters

Name	In	Type	Required	Description
id	path	string	true	none
body	body	UpdateEventTypeRegistrationRequest	true	none

Example responses

update a webhook endpoint response

{
  "id": "e4db815d-f8cb-4d51-b729-6417fb1296ee",
  "name": "first webhook",
  "object": "webhook_endpoint",
  "createdDate": "2023-09-20T17:23:16.592+08:00",
  "createdBy": "ca9d3479-79c8-4d5b-bee0-4d1100984830",
  "lastModifiedDate": "2023-09-20T17:23:16.592+08:00",
  "lastModifiedBy": "ca9d3479-79c8-4d5b-bee0-4d1100984830",
  "description": "the description",
  "status": "enabled",
  "events": [
    "invoice.activated",
    "invoice.canceled",
    "credit_memo.activated",
    "credit_memo.canceled"
  ],
  "endpoint": "https://mywebsite.com/endpoint"
}

400 Response

webhook endpoint url invalid

{
  "title": "BAD_REQUEST",
  "message": "A valid url is required for webhook: {{request:endpoint}}",
  "errorCode": "INVALID_WEBHOOK_ENDPOINT_URL"
}

Responses

Status	Meaning	Description	Schema
200	OK	update a webhook endpoint	CreateEventTypeRegistrationResponse
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline
500	Internal Server Error	webhook endpoint url invalid	None

Response Schema

Customers

Create Customer

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/orders/customers \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/orders/customers HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = '[
  {
    "contacts": [
      {
        "customerId": "string",
        "requestDisplayId": "string",
        "id": "string",
        "tenantId": "string",
        "objectDisplayName": "string",
        "empty": true,
        "property1": {},
        "property2": {}
      }
    ],
    "shippingCity": "string",
    "shippingPostalCode": "string",
    "shippingState": "string",
    "shippingStreet": "string",
    "requestDisplayId": "string",
    "id": "string",
    "tenantId": "string",
    "objectDisplayName": "string",
    "empty": true,
    "property1": {},
    "property2": {}
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/orders/customers',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/orders/customers',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/orders/customers', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/orders/customers', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/orders/customers");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/orders/customers", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /orders/customers

Create customer. Create up to 200 customers in a synchronous batch, with each customer containing up to 50 contacts. A contact is also seen as a self-service user.

Body parameter

[
  {
    "contacts": [
      {
        "customerId": "string",
        "requestDisplayId": "string",
        "id": "string",
        "tenantId": "string",
        "objectDisplayName": "string",
        "empty": true,
        "property1": {},
        "property2": {}
      }
    ],
    "shippingCity": "string",
    "shippingPostalCode": "string",
    "shippingState": "string",
    "shippingStreet": "string",
    "requestDisplayId": "string",
    "id": "string",
    "tenantId": "string",
    "objectDisplayName": "string",
    "empty": true,
    "property1": {},
    "property2": {}
  }
]

Parameters

Name	In	Type	Required	Description
body	body	CustomerRequestMap	true	none

Example responses

400 Response

default Response

[
  {
    "id": "string",
    "name": "string",
    "description": "string",
    "accountNumber": "string",
    "email": "string",
    "phone": "string",
    "fax": "string",
    "industry": "string",
    "parentCustomerId": "string",
    "recordType": "string",
    "autoRenew": "string",
    "shippingStreet": "string",
    "shippingCity": "string",
    "shippingState": "string",
    "shippingCountry": "string",
    "shippingPostalCode": "string",
    "billingStreet": "string",
    "billingCity": "string",
    "billingState": "string",
    "billingCountry": "string",
    "billingPostalCode": "string",
    "invoiceBalance": 0,
    "latestOrderDate": "string",
    "todayARR": 0,
    "todayCMRR": 0,
    "totalTCV": 0,
    "contacts": [
      {
        "id": "string",
        "name": "string",
        "firstName": "string",
        "lastName": "string",
        "middleName": "string",
        "suffix": "string",
        "title": "string",
        "birthday": "2019-08-24",
        "email": "string",
        "mobilePhone": "string",
        "phone": "string",
        "shippingStreet": "string",
        "shippingCity": "string",
        "shippingState": "string",
        "shippingCountry": "string",
        "shippingPostalCode": "string",
        "billingStreet": "string",
        "billingCity": "string",
        "billingState": "string",
        "billingCountry": "string",
        "billingPostalCode": "string",
        "createdBy": "string",
        "createdDate": "2019-08-24T14:15:22Z",
        "lastModifiedBy": "string",
        "lastModifiedDate": "2019-08-24T14:15:22Z"
      }
    ]
  }
]

Responses

Status	Meaning	Description	Schema
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[CustomerReturnResponse]	false	none	none
» id	string	false	none	Id of customer.
» name	string	false	none	Name of customer.
» description	string	false	none	Description of customer.
» accountNumber	string	false	none	Account number of customer.
» email	string	false	none	Email address of customer.
» phone	string	false	none	Phone number of customer.
» fax	string	false	none	Fax number of customer.
» industry	string	false	none	Industry of customer.
» parentCustomerId	string	false	none	Parent of customer.
» recordType	string	false	none	Type of customer.
» autoRenew	string	false	none	Auto renew. Indicates if customer should be auto renewed or default to subscription configuration.
» shippingStreet	string	false	none	Street of shipping address
» shippingCity	string	false	none	City of shipping address
» shippingState	string	false	none	State of shipping address
» shippingCountry	string	false	none	Country of shipping address
» shippingPostalCode	string	false	none	Postal code of shipping address
» billingStreet	string	false	none	Street of billing address
» billingCity	string	false	none	City of billing address
» billingState	string	false	none	State of billing address
» billingCountry	string	false	none	Country of billing address
» billingPostalCode	string	false	none	Postal code of billing address
» invoiceBalance	number	false	none	Invoice balance of customer
» latestOrderDate	string	false	none	Latest order date
» todayARR	number	false	none	Today's ARR
» todayCMRR	number	false	none	Today's CMRR
» totalTCV	number	false	none	Total TCV
» contacts	[ContactReturnResponse]	false	none	Contacts of customer.
»» id	string	false	none	Id of contact.
»» name	string	false	none	Name of contact.
»» firstName	string	false	none	First name of contact.
»» lastName	string	false	none	Last name of contact.
»» middleName	string	false	none	Middle name of contact.
»» suffix	string	false	none	Suffix of contact.
»» title	string	false	none	Title of contact.
»» birthday	string(date)	false	none	Birthdate of contact.
»» email	string	false	none	Email address of contact.
»» mobilePhone	string	false	none	Mobile phone number of contact.
»» phone	string	false	none	Phone number of contact.
»» shippingStreet	string	false	none	Street of shipping address.
»» shippingCity	string	false	none	City of shipping address.
»» shippingState	string	false	none	State of shipping address.
»» shippingCountry	string	false	none	Country of shipping address.
»» shippingPostalCode	string	false	none	Postal code of shipping address.
»» billingStreet	string	false	none	Street of billing address.
»» billingCity	string	false	none	City of billing address.
»» billingState	string	false	none	State of billing address.
»» billingCountry	string	false	none	Country of billing address.
»» billingPostalCode	string	false	none	Postal code of billing address.
»» createdBy	string	false	none	The user who created the record.
»» createdDate	string(date-time)	false	none	The date when the record was created.
»» lastModifiedBy	string	false	none	The user who last updated the record.
»» lastModifiedDate	string(date-time)	false	none	The date when the record was last updated.

Create Contact

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/orders/customers/{customerId}/contacts \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/orders/customers/{customerId}/contacts HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = '[
  {
    "customerId": "string",
    "requestDisplayId": "string",
    "id": "string",
    "tenantId": "string",
    "objectDisplayName": "string",
    "empty": true,
    "property1": {},
    "property2": {}
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/orders/customers/{customerId}/contacts',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/orders/customers/{customerId}/contacts',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/orders/customers/{customerId}/contacts', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/orders/customers/{customerId}/contacts', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/orders/customers/{customerId}/contacts");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/orders/customers/{customerId}/contacts", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /orders/customers/{customerId}/contacts

Create contact. Create up to 50 contacts in a synchronous batch. A contact is also seen as a self-service user.

Body parameter

[
  {
    "customerId": "string",
    "requestDisplayId": "string",
    "id": "string",
    "tenantId": "string",
    "objectDisplayName": "string",
    "empty": true,
    "property1": {},
    "property2": {}
  }
]

Parameters

Name	In	Type	Required	Description
customerId	path	string	true	none
body	body	ContactRequestMap	true	none

Example responses

400 Response

default Response

[
  {
    "id": "string",
    "name": "string",
    "firstName": "string",
    "lastName": "string",
    "middleName": "string",
    "suffix": "string",
    "title": "string",
    "birthday": "2019-08-24",
    "email": "string",
    "mobilePhone": "string",
    "phone": "string",
    "shippingStreet": "string",
    "shippingCity": "string",
    "shippingState": "string",
    "shippingCountry": "string",
    "shippingPostalCode": "string",
    "billingStreet": "string",
    "billingCity": "string",
    "billingState": "string",
    "billingCountry": "string",
    "billingPostalCode": "string",
    "createdBy": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "lastModifiedBy": "string",
    "lastModifiedDate": "2019-08-24T14:15:22Z"
  }
]

Responses

Status	Meaning	Description	Schema
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[ContactReturnResponse]	false	none	none
» id	string	false	none	Id of contact.
» name	string	false	none	Name of contact.
» firstName	string	false	none	First name of contact.
» lastName	string	false	none	Last name of contact.
» middleName	string	false	none	Middle name of contact.
» suffix	string	false	none	Suffix of contact.
» title	string	false	none	Title of contact.
» birthday	string(date)	false	none	Birthdate of contact.
» email	string	false	none	Email address of contact.
» mobilePhone	string	false	none	Mobile phone number of contact.
» phone	string	false	none	Phone number of contact.
» shippingStreet	string	false	none	Street of shipping address.
» shippingCity	string	false	none	City of shipping address.
» shippingState	string	false	none	State of shipping address.
» shippingCountry	string	false	none	Country of shipping address.
» shippingPostalCode	string	false	none	Postal code of shipping address.
» billingStreet	string	false	none	Street of billing address.
» billingCity	string	false	none	City of billing address.
» billingState	string	false	none	State of billing address.
» billingCountry	string	false	none	Country of billing address.
» billingPostalCode	string	false	none	Postal code of billing address.
» createdBy	string	false	none	The user who created the record.
» createdDate	string(date-time)	false	none	The date when the record was created.
» lastModifiedBy	string	false	none	The user who last updated the record.
» lastModifiedDate	string(date-time)	false	none	The date when the record was last updated.

Get Customer

Code samples

# You can also use wget
curl -X GET https://api.nue.io/v1/orders/customers/{customerId} \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.nue.io/v1/orders/customers/{customerId} HTTP/1.1
Host: api.nue.io
Accept: */*


const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/orders/customers/{customerId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/v1/orders/customers/{customerId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/v1/orders/customers/{customerId}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/v1/orders/customers/{customerId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/orders/customers/{customerId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/v1/orders/customers/{customerId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /orders/customers/{customerId}

Get customer by Id.

Parameters

Name	In	Type	Required	Description
customerId	path	string	true	none

Example responses

400 Response

default Response

{
  "id": "string",
  "name": "string",
  "description": "string",
  "accountNumber": "string",
  "email": "string",
  "phone": "string",
  "fax": "string",
  "industry": "string",
  "parentCustomerId": "string",
  "recordType": "string",
  "autoRenew": "string",
  "shippingStreet": "string",
  "shippingCity": "string",
  "shippingState": "string",
  "shippingCountry": "string",
  "shippingPostalCode": "string",
  "billingStreet": "string",
  "billingCity": "string",
  "billingState": "string",
  "billingCountry": "string",
  "billingPostalCode": "string",
  "invoiceBalance": 0,
  "latestOrderDate": "string",
  "todayARR": 0,
  "todayCMRR": 0,
  "totalTCV": 0,
  "contacts": [
    {
      "id": "string",
      "name": "string",
      "firstName": "string",
      "lastName": "string",
      "middleName": "string",
      "suffix": "string",
      "title": "string",
      "birthday": "2019-08-24",
      "email": "string",
      "mobilePhone": "string",
      "phone": "string",
      "shippingStreet": "string",
      "shippingCity": "string",
      "shippingState": "string",
      "shippingCountry": "string",
      "shippingPostalCode": "string",
      "billingStreet": "string",
      "billingCity": "string",
      "billingState": "string",
      "billingCountry": "string",
      "billingPostalCode": "string",
      "createdBy": "string",
      "createdDate": "2019-08-24T14:15:22Z",
      "lastModifiedBy": "string",
      "lastModifiedDate": "2019-08-24T14:15:22Z"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline
default	Default	default response	CustomerReturnResponse

Response Schema

Update Customer

Code samples

# You can also use wget
curl -X PATCH https://api.nue.io/v1/orders/customers/{customerId} \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

PATCH https://api.nue.io/v1/orders/customers/{customerId} HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = '{
  "contacts": [
    {
      "customerId": "string",
      "requestDisplayId": "string",
      "id": "string",
      "tenantId": "string",
      "objectDisplayName": "string",
      "empty": true,
      "property1": {},
      "property2": {}
    }
  ],
  "shippingCity": "string",
  "shippingPostalCode": "string",
  "shippingState": "string",
  "shippingStreet": "string",
  "requestDisplayId": "string",
  "id": "string",
  "tenantId": "string",
  "objectDisplayName": "string",
  "empty": true,
  "property1": {},
  "property2": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/orders/customers/{customerId}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch 'https://api.nue.io/v1/orders/customers/{customerId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('https://api.nue.io/v1/orders/customers/{customerId}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','https://api.nue.io/v1/orders/customers/{customerId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/orders/customers/{customerId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "https://api.nue.io/v1/orders/customers/{customerId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PATCH /orders/customers/{customerId}

Update customer. Update a customer’s fields that are updateable.

Body parameter

{
  "contacts": [
    {
      "customerId": "string",
      "requestDisplayId": "string",
      "id": "string",
      "tenantId": "string",
      "objectDisplayName": "string",
      "empty": true,
      "property1": {},
      "property2": {}
    }
  ],
  "shippingCity": "string",
  "shippingPostalCode": "string",
  "shippingState": "string",
  "shippingStreet": "string",
  "requestDisplayId": "string",
  "id": "string",
  "tenantId": "string",
  "objectDisplayName": "string",
  "empty": true,
  "property1": {},
  "property2": {}
}

Parameters

Name	In	Type	Required	Description
customerId	path	string	true	none
body	body	object	true	none
» additionalProperties	body	object	false	none
» contacts	body	[ContactRequestMap]	false	none
»» additionalProperties	body	object	false	none
»» customerId	body	string	false	none
»» requestDisplayId	body	string	false	none
»» id	body	string	false	none
»» tenantId	body	string	false	none
»» objectDisplayName	body	string	false	none
»» empty	body	boolean	false	none
» shippingCity	body	string	false	none
» shippingPostalCode	body	string	false	none
» shippingState	body	string	false	none
» shippingStreet	body	string	false	none
» requestDisplayId	body	string	false	none
» id	body	string	false	none
» tenantId	body	string	false	none
» objectDisplayName	body	string	false	none
» empty	body	boolean	false	none

Example responses

400 Response

default Response

{
  "id": "string",
  "name": "string",
  "description": "string",
  "accountNumber": "string",
  "email": "string",
  "phone": "string",
  "fax": "string",
  "industry": "string",
  "parentCustomerId": "string",
  "recordType": "string",
  "autoRenew": "string",
  "shippingStreet": "string",
  "shippingCity": "string",
  "shippingState": "string",
  "shippingCountry": "string",
  "shippingPostalCode": "string",
  "billingStreet": "string",
  "billingCity": "string",
  "billingState": "string",
  "billingCountry": "string",
  "billingPostalCode": "string",
  "invoiceBalance": 0,
  "latestOrderDate": "string",
  "todayARR": 0,
  "todayCMRR": 0,
  "totalTCV": 0,
  "contacts": [
    {
      "id": "string",
      "name": "string",
      "firstName": "string",
      "lastName": "string",
      "middleName": "string",
      "suffix": "string",
      "title": "string",
      "birthday": "2019-08-24",
      "email": "string",
      "mobilePhone": "string",
      "phone": "string",
      "shippingStreet": "string",
      "shippingCity": "string",
      "shippingState": "string",
      "shippingCountry": "string",
      "shippingPostalCode": "string",
      "billingStreet": "string",
      "billingCity": "string",
      "billingState": "string",
      "billingCountry": "string",
      "billingPostalCode": "string",
      "createdBy": "string",
      "createdDate": "2019-08-24T14:15:22Z",
      "lastModifiedBy": "string",
      "lastModifiedDate": "2019-08-24T14:15:22Z"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline
default	Default	default response	CustomerReturnResponse

Response Schema

Get Contact

Code samples

# You can also use wget
curl -X GET https://api.nue.io/v1/orders/contacts/{contactId} \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.nue.io/v1/orders/contacts/{contactId} HTTP/1.1
Host: api.nue.io
Accept: */*


const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/orders/contacts/{contactId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/v1/orders/contacts/{contactId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/v1/orders/contacts/{contactId}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/v1/orders/contacts/{contactId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/orders/contacts/{contactId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/v1/orders/contacts/{contactId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /orders/contacts/{contactId}

Get contact by Id.

Parameters

Name	In	Type	Required	Description
contactId	path	string	true	none

Example responses

400 Response

default Response

{
  "id": "string",
  "name": "string",
  "firstName": "string",
  "lastName": "string",
  "middleName": "string",
  "suffix": "string",
  "title": "string",
  "birthday": "2019-08-24",
  "email": "string",
  "mobilePhone": "string",
  "phone": "string",
  "shippingStreet": "string",
  "shippingCity": "string",
  "shippingState": "string",
  "shippingCountry": "string",
  "shippingPostalCode": "string",
  "billingStreet": "string",
  "billingCity": "string",
  "billingState": "string",
  "billingCountry": "string",
  "billingPostalCode": "string",
  "createdBy": "string",
  "createdDate": "2019-08-24T14:15:22Z",
  "lastModifiedBy": "string",
  "lastModifiedDate": "2019-08-24T14:15:22Z"
}

Responses

Status	Meaning	Description	Schema
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline
default	Default	default response	ContactReturnResponse

Response Schema

Update Contact

Code samples

# You can also use wget
curl -X PATCH https://api.nue.io/v1/orders/contacts/{contactId} \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

PATCH https://api.nue.io/v1/orders/contacts/{contactId} HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = '{
  "customerId": "string",
  "requestDisplayId": "string",
  "id": "string",
  "tenantId": "string",
  "objectDisplayName": "string",
  "empty": true,
  "property1": {},
  "property2": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/orders/contacts/{contactId}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch 'https://api.nue.io/v1/orders/contacts/{contactId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('https://api.nue.io/v1/orders/contacts/{contactId}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','https://api.nue.io/v1/orders/contacts/{contactId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/orders/contacts/{contactId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "https://api.nue.io/v1/orders/contacts/{contactId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PATCH /orders/contacts/{contactId}

Update contact. Update a contact’s fields that are updateable.

Body parameter

{
  "customerId": "string",
  "requestDisplayId": "string",
  "id": "string",
  "tenantId": "string",
  "objectDisplayName": "string",
  "empty": true,
  "property1": {},
  "property2": {}
}

Parameters

Name	In	Type	Required	Description
contactId	path	string	true	none
body	body	object	true	none
» additionalProperties	body	object	false	none
» customerId	body	string	false	none
» requestDisplayId	body	string	false	none
» id	body	string	false	none
» tenantId	body	string	false	none
» objectDisplayName	body	string	false	none
» empty	body	boolean	false	none

Example responses

400 Response

default Response

{
  "id": "string",
  "name": "string",
  "firstName": "string",
  "lastName": "string",
  "middleName": "string",
  "suffix": "string",
  "title": "string",
  "birthday": "2019-08-24",
  "email": "string",
  "mobilePhone": "string",
  "phone": "string",
  "shippingStreet": "string",
  "shippingCity": "string",
  "shippingState": "string",
  "shippingCountry": "string",
  "shippingPostalCode": "string",
  "billingStreet": "string",
  "billingCity": "string",
  "billingState": "string",
  "billingCountry": "string",
  "billingPostalCode": "string",
  "createdBy": "string",
  "createdDate": "2019-08-24T14:15:22Z",
  "lastModifiedBy": "string",
  "lastModifiedDate": "2019-08-24T14:15:22Z"
}

Responses

Status	Meaning	Description	Schema
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline
default	Default	default response	ContactReturnResponse

Response Schema

Transaction Hub

Transaction Hub provide a list of APIs to manage the transaction hubs.

A transaction hub is an ID mapping between a Nue transaction and an external system transaction, including its latest sync status. A transaction hub has the folowing 3 statuses: NotTransferred, Transferred, Failed.

A NotTransferred transaction hub means the transaction data has not been synchronized to the external system yet.
A Transferred transaction hub means the transaction data has already been synchronized to the external system.
A Failed transaction hub means the transaction data failed to be synchronized to the external system, we can check the error code and error message for details.

Get Upload Transaction Hub Status

Code samples

# You can also use wget
curl -X GET https://api.nue.io/v1/revenue/transaction-hub/async-job/{jobId} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.nue.io/v1/revenue/transaction-hub/async-job/{jobId} HTTP/1.1
Host: api.nue.io
Accept: application/json


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/revenue/transaction-hub/async-job/{jobId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/v1/revenue/transaction-hub/async-job/{jobId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/v1/revenue/transaction-hub/async-job/{jobId}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/v1/revenue/transaction-hub/async-job/{jobId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/revenue/transaction-hub/async-job/{jobId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/v1/revenue/transaction-hub/async-job/{jobId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /revenue/transaction-hub/async-job/{jobId}

Retrieve the status of uploading transaction hub job

Parameters

Name	In	Type	Required	Description
jobId	path	string(uuid)	true	none

Example responses

default Response

{
  "status": "Queued",
  "result": {
    "successCount": 0,
    "skipCount": 0,
    "failureCount": 0,
    "errors": [
      {
        "transactionType": "Customer",
        "nueId": "string",
        "externalSystem": "string",
        "externalSystemId": "string",
        "externalId": "string",
        "direction": "Inbound",
        "description": "string",
        "errorMessage": "string"
      }
    ]
  },
  "errorCode": "string",
  "errorMessage": "string"
}

Responses

Status	Meaning	Description	Schema
default	Default	default response	TransactionHubUploadResponse

Create Async Job for Transaction Hub Uploads

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/revenue/transaction-hub:upload \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/revenue/transaction-hub:upload HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = '{
  "data": [
    {
      "transactionType": "Customer",
      "nueId": "string",
      "externalSystem": "string",
      "externalSystemId": "string",
      "externalId": "string",
      "direction": "Inbound",
      "description": "string"
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/revenue/transaction-hub:upload',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/revenue/transaction-hub:upload',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/revenue/transaction-hub:upload', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/revenue/transaction-hub:upload', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/revenue/transaction-hub:upload");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/revenue/transaction-hub:upload", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /revenue/transaction-hub:upload

Create an asynchronous job for uploading transaction hub records.

Body parameter

{
  "data": [
    {
      "transactionType": "Customer",
      "nueId": "string",
      "externalSystem": "string",
      "externalSystemId": "string",
      "externalId": "string",
      "direction": "Inbound",
      "description": "string"
    }
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	UploadTransactionHubRequest	true	The request of the upload transaction hub API.

Example responses

202 Response

Responses

Status	Meaning	Description	Schema
202	Accepted	default response	CreateUploadTransactionHubJobResponse

Save Transaction Hub

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/revenue/transaction-hub \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/revenue/transaction-hub HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: application/json

const inputBody = '{
  "transactionHubs": [
    {
      "transactionType": "Invoice",
      "nueId": "6d16dd92-9378-46b1-93cc-7db2cc45e791",
      "externalSystem": "Salesforce",
      "externalSystemId": "EXT-01",
      "externalId": "INV-0001",
      "status": "Failed",
      "direction": "Outbound",
      "errorCode": "CONN-TIMEOUT",
      "errorMessage": "Failed to connect to Salesforce in 60 seconds."
    },
    {
      "transactionType": "Invoice",
      "nueId": "1bb4414b-d159-475e-9f09-ff19a1750b0a",
      "externalSystem": "Salesforce",
      "externalSystemId": "EXT-01",
      "externalId": "INV-0002",
      "status": "Transferred",
      "direction": "Outbound"
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/revenue/transaction-hub',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/revenue/transaction-hub',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/revenue/transaction-hub', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/revenue/transaction-hub', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/revenue/transaction-hub");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/revenue/transaction-hub", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /revenue/transaction-hub

Save a list of transaction hub, it is a save operation.

Body parameter

{
  "transactionHubs": [
    {
      "transactionType": "Invoice",
      "nueId": "6d16dd92-9378-46b1-93cc-7db2cc45e791",
      "externalSystem": "Salesforce",
      "externalSystemId": "EXT-01",
      "externalId": "INV-0001",
      "status": "Failed",
      "direction": "Outbound",
      "errorCode": "CONN-TIMEOUT",
      "errorMessage": "Failed to connect to Salesforce in 60 seconds."
    },
    {
      "transactionType": "Invoice",
      "nueId": "1bb4414b-d159-475e-9f09-ff19a1750b0a",
      "externalSystem": "Salesforce",
      "externalSystemId": "EXT-01",
      "externalId": "INV-0002",
      "status": "Transferred",
      "direction": "Outbound"
    }
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	UpsertTransactionHubRequest	true	The request of the save transaction hub API.

Example responses

default Response

{
  "transactionHubs": [
    {
      "transactionType": "Invoice",
      "nueId": "6d16dd92-9378-46b1-93cc-7db2cc45e791",
      "externalSystem": "Salesforce",
      "externalSystemId": "EXT-01",
      "id": "485f496c-8603-4214-af0e-a8fc217a9879",
      "externalId": "INV-0001",
      "status": "Failed",
      "errorCode": "CONN-TIMEOUT",
      "errorMessage": "Failed to connect to Salesforce in 60 seconds.",
      "createdTime": 1686903670975,
      "lastModifiedTime": 1686903670651
    },
    {
      "transactionType": "Invoice",
      "nueId": "1bb4414b-d159-475e-9f09-ff19a1750b0a",
      "externalSystem": "Salesforce",
      "externalSystemId": "EXT-01",
      "id": "c71f07b5-7d52-43f1-af50-24d427aa71d7",
      "externalId": "INV-0002",
      "status": "Transferred",
      "createdTime": 1686731713294,
      "lastModifiedTime": 1686903670651
    }
  ],
  "errorMessage": "string"
}

Responses

Status	Meaning	Description	Schema
default	Default	default response	UpsertTransactionHubResponse

Remove Transaction Hub

Code samples

# You can also use wget
curl -X DELETE https://api.nue.io/v1/revenue/transaction-hub \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

DELETE https://api.nue.io/v1/revenue/transaction-hub HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: application/json

const inputBody = '{
  "transactionHubs": [
    {
      "transactionType": "Invoice",
      "nueId": "6d16dd92-9378-46b1-93cc-7db2cc45e791",
      "externalSystem": "Salesforce"
    },
    {
      "transactionType": "Invoice",
      "nueId": "1bb4414b-d159-475e-9f09-ff19a1750b0b",
      "externalSystem": "Salesforce"
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/revenue/transaction-hub',
{
  method: 'DELETE',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete 'https://api.nue.io/v1/revenue/transaction-hub',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('https://api.nue.io/v1/revenue/transaction-hub', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.nue.io/v1/revenue/transaction-hub', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/revenue/transaction-hub");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.nue.io/v1/revenue/transaction-hub", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /revenue/transaction-hub

Remove a list of transaction hub by the given transaction hub keys.

Body parameter

{
  "transactionHubs": [
    {
      "transactionType": "Invoice",
      "nueId": "6d16dd92-9378-46b1-93cc-7db2cc45e791",
      "externalSystem": "Salesforce"
    },
    {
      "transactionType": "Invoice",
      "nueId": "1bb4414b-d159-475e-9f09-ff19a1750b0b",
      "externalSystem": "Salesforce"
    }
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	RemoveTransactionHubRequest	true	The request of the remove transaction hub API.

Example responses

default Response

{
  "removed": 2
}

Responses

Status	Meaning	Description	Schema
default	Default	default response	RemoveTransactionHubResponse

Update Transaction Hub

Code samples

# You can also use wget
curl -X PATCH https://api.nue.io/v1/revenue/transaction-hub \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

PATCH https://api.nue.io/v1/revenue/transaction-hub HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: application/json

const inputBody = '{
  "transactionHubs": [
    {
      "transactionType": "Invoice",
      "nueId": "6d16dd92-9378-46b1-93cc-7db2cc45e791",
      "externalSystem": "Salesforce",
      "externalSystemId": "EXT-01",
      "externalId": "INV-0001",
      "status": "Failed",
      "direction": "Outbound",
      "errorCode": "CONN-TIMEOUT",
      "errorMessage": "Failed to connect to Salesforce in 60 seconds."
    },
    {
      "transactionType": "Invoice",
      "nueId": "1bb4414b-d159-475e-9f09-ff19a1750b0a",
      "externalSystem": "Salesforce",
      "externalSystemId": "EXT-01",
      "externalId": "INV-0002",
      "status": "Transferred",
      "direction": "Outbound"
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/revenue/transaction-hub',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch 'https://api.nue.io/v1/revenue/transaction-hub',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('https://api.nue.io/v1/revenue/transaction-hub', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','https://api.nue.io/v1/revenue/transaction-hub', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/revenue/transaction-hub");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "https://api.nue.io/v1/revenue/transaction-hub", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PATCH /revenue/transaction-hub

Update a list of transaction hub, it is a update operation.

Body parameter

{
  "transactionHubs": [
    {
      "transactionType": "Invoice",
      "nueId": "6d16dd92-9378-46b1-93cc-7db2cc45e791",
      "externalSystem": "Salesforce",
      "externalSystemId": "EXT-01",
      "externalId": "INV-0001",
      "status": "Failed",
      "direction": "Outbound",
      "errorCode": "CONN-TIMEOUT",
      "errorMessage": "Failed to connect to Salesforce in 60 seconds."
    },
    {
      "transactionType": "Invoice",
      "nueId": "1bb4414b-d159-475e-9f09-ff19a1750b0a",
      "externalSystem": "Salesforce",
      "externalSystemId": "EXT-01",
      "externalId": "INV-0002",
      "status": "Transferred",
      "direction": "Outbound"
    }
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	UpsertTransactionHubRequest	true	The request of the update transaction hub API.

Example responses

default Response

{
  "transactionHubs": [
    {
      "transactionType": "Invoice",
      "nueId": "6d16dd92-9378-46b1-93cc-7db2cc45e791",
      "externalSystem": "Salesforce",
      "externalSystemId": "EXT-01",
      "id": "485f496c-8603-4214-af0e-a8fc217a9879",
      "externalId": "INV-0001",
      "status": "Failed",
      "errorCode": "CONN-TIMEOUT",
      "errorMessage": "Failed to connect to Salesforce in 60 seconds.",
      "createdTime": 1686903670975,
      "lastModifiedTime": 1686903670651
    },
    {
      "transactionType": "Invoice",
      "nueId": "1bb4414b-d159-475e-9f09-ff19a1750b0a",
      "externalSystem": "Salesforce",
      "externalSystemId": "EXT-01",
      "id": "c71f07b5-7d52-43f1-af50-24d427aa71d7",
      "externalId": "INV-0002",
      "status": "Transferred",
      "createdTime": 1686731713294,
      "lastModifiedTime": 1686903670651
    }
  ],
  "errorMessage": "string"
}

Responses

Status	Meaning	Description	Schema
default	Default	default response	UpsertTransactionHubResponse

Revenue Integration Settings

Revenue settings including setting up custom mapping of fields to sync to RightRev

Get Revenue Field Mappings for Orders

Code samples

# You can also use wget
curl -X GET https://api.nue.io/v1/revenue/settings/revenue-fields/orders \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.nue.io/v1/revenue/settings/revenue-fields/orders HTTP/1.1
Host: api.nue.io
Accept: application/json


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/revenue/settings/revenue-fields/orders',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/v1/revenue/settings/revenue-fields/orders',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/v1/revenue/settings/revenue-fields/orders', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/v1/revenue/settings/revenue-fields/orders', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/revenue/settings/revenue-fields/orders");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/v1/revenue/settings/revenue-fields/orders", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /revenue/settings/revenue-fields/orders

Returns all custom field mappings for orders sync

Example responses

Get Revenue Field Mappings Response

{
  "id": "9d00cdf6-fbe7-4614-b0bc-74ca04f468ce",
  "nueFieldName": "entityUseCode",
  "externalFieldName": "entity_use_code",
  "label": "Entity Use Code",
  "dataType": "string"
}

Responses

Status	Meaning	Description	Schema
default	Default	default response	RevenueFieldMappingResponse

Create Revenue Field Mapping for Orders

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/revenue/settings/revenue-fields/orders \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/revenue/settings/revenue-fields/orders HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = '{
  "nueFieldName": "entityUseCode",
  "externalFieldName": "entity_use_code",
  "label": "Entity Use Code",
  "dataType": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/revenue/settings/revenue-fields/orders',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/revenue/settings/revenue-fields/orders',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/revenue/settings/revenue-fields/orders', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/revenue/settings/revenue-fields/orders', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/revenue/settings/revenue-fields/orders");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/revenue/settings/revenue-fields/orders", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /revenue/settings/revenue-fields/orders

Create a new field mapping for the rev rec orders integration

Body parameter

Create Revenue Field Mapping for Orders Request Example

{
  "nueFieldName": "entityUseCode",
  "externalFieldName": "entity_use_code",
  "label": "Entity Use Code",
  "dataType": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	RevenueFieldRequest	true	The request to create a revenue field mapping.

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	default response	string

Update Revenue Field Mappings for Orders

Code samples

# You can also use wget
curl -X PATCH https://api.nue.io/v1/revenue/settings/revenue-fields/orders \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

PATCH https://api.nue.io/v1/revenue/settings/revenue-fields/orders HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = '{
  "id": "9d00cdf6-fbe7-4614-b0bc-74ca04f468ce",
  "nueFieldName": "entityUseCode",
  "label": "Entity Use Code",
  "dataType": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/revenue/settings/revenue-fields/orders',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch 'https://api.nue.io/v1/revenue/settings/revenue-fields/orders',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('https://api.nue.io/v1/revenue/settings/revenue-fields/orders', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','https://api.nue.io/v1/revenue/settings/revenue-fields/orders', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/revenue/settings/revenue-fields/orders");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "https://api.nue.io/v1/revenue/settings/revenue-fields/orders", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PATCH /revenue/settings/revenue-fields/orders

Update a field mapping for the rev rec orders integration

Body parameter

Update Revenue Field Mapping for Orders Request Example

{
  "id": "9d00cdf6-fbe7-4614-b0bc-74ca04f468ce",
  "nueFieldName": "entityUseCode",
  "label": "Entity Use Code",
  "dataType": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	UpdateRevenueFieldRequest	true	The request to update a revenue field mapping.

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	default response	string

Delete Revenue Field Mappings for Orders

Code samples

# You can also use wget
curl -X DELETE https://api.nue.io/v1/revenue/settings/revenue-fields/orders/{fieldId} \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access-token}'

DELETE https://api.nue.io/v1/revenue/settings/revenue-fields/orders/{fieldId} HTTP/1.1
Host: api.nue.io
Accept: */*


const headers = {
  'Accept':'*/*',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/revenue/settings/revenue-fields/orders/{fieldId}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete 'https://api.nue.io/v1/revenue/settings/revenue-fields/orders/{fieldId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('https://api.nue.io/v1/revenue/settings/revenue-fields/orders/{fieldId}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://api.nue.io/v1/revenue/settings/revenue-fields/orders/{fieldId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/revenue/settings/revenue-fields/orders/{fieldId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.nue.io/v1/revenue/settings/revenue-fields/orders/{fieldId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /revenue/settings/revenue-fields/orders/{fieldId}

Delete a field mapping for the rev rec orders integration

Parameters

Name	In	Type	Required	Description
fieldId	path	string(uuid)	true	The UUID of the field mapping to be deleted

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	default response	string

Revenue GraphQL

Support graphql query for entity: Transaction Hub.

GraphQL Query API on GET

Code samples

# You can also use wget
curl -X GET https://api.nue.io/v1/revenue/async/graphql?query=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.nue.io/v1/revenue/async/graphql?query=string HTTP/1.1
Host: api.nue.io
Accept: application/json


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/revenue/async/graphql?query=string',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.nue.io/v1/revenue/async/graphql',
  params: {
  'query' => 'string'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.nue.io/v1/revenue/async/graphql', params={
  'query': 'string'
}, headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/v1/revenue/async/graphql', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/revenue/async/graphql?query=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/v1/revenue/async/graphql", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /revenue/async/graphql

The graghQL query is passed in the URL.

Parameters

Name	In	Type	Required	Description
query	query	string	true	none
operationName	query	string	false	none
variables	query	string	false	none

Example responses

200 Response

{}

Responses

Status	Meaning	Description	Schema
200	OK	default response	Inline

Response Schema

GraphQL Query API on POST

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/revenue/async/graphql \
  -H 'Content-Type: */*' \
  -H 'Accept: application/json' \
  -H 'Content-Type: string' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.nue.io/v1/revenue/async/graphql HTTP/1.1
Host: api.nue.io
Content-Type: */*
Accept: application/json
Content-Type: string

const inputBody = 'string';
const headers = {
  'Content-Type':'*/*',
  'Accept':'application/json',
  'Content-Type':'string',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.nue.io/v1/revenue/async/graphql',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => '*/*',
  'Accept' => 'application/json',
  'Content-Type' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.nue.io/v1/revenue/async/graphql',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': '*/*',
  'Accept': 'application/json',
  'Content-Type': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.nue.io/v1/revenue/async/graphql', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => '*/*',
    'Accept' => 'application/json',
    'Content-Type' => 'string',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/revenue/async/graphql', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/revenue/async/graphql");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"*/*"},
        "Accept": []string{"application/json"},
        "Content-Type": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/revenue/async/graphql", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /revenue/async/graphql

The graghQL query is passed in the request body.

Body parameter

Parameters

Name	In	Type	Required	Description
Content-Type	header	string	false	none
query	query	string	false	none
operationName	query	string	false	none
variables	query	string	false	none
body	body	string	false	none

Example responses

200 Response

{}

Responses

Status	Meaning	Description	Schema
200	OK	default response	Inline

Response Schema

event-controller

postEvent

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/events \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

POST https://api.nue.io/v1/events HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: application/json

const inputBody = '{
  "eventType": "string",
  "content": {
    "property1": {},
    "property2": {}
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.nue.io/v1/events',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'https://api.nue.io/v1/events',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.nue.io/v1/events', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/events', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/events");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/events", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /events

Body parameter

{
  "eventType": "string",
  "content": {
    "property1": {},
    "property2": {}
  }
}

Parameters

Name	In	Type	Required	Description
body	body	CreateEventRequest	true	none

Example responses

202 Response

{
  "id": "string"
}

400 Response

Responses

Status	Meaning	Description	Schema
202	Accepted	Accepted	ObjectResponse
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline

Response Schema

testEvent

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/events:test \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*'

POST https://api.nue.io/v1/events:test HTTP/1.1
Host: api.nue.io
Content-Type: application/json
Accept: */*

const inputBody = '{
  "eventType": "string",
  "actionType": "Webhook",
  "target": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*'
};

fetch('https://api.nue.io/v1/events:test',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*'
}

result = RestClient.post 'https://api.nue.io/v1/events:test',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*'
}

r = requests.post('https://api.nue.io/v1/events:test', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '*/*',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/events:test', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/events:test");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/events:test", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /events:test

Body parameter

{
  "eventType": "string",
  "actionType": "Webhook",
  "target": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	TestEvent	true	none

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	EventDispatchResponse
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline

Response Schema

retryEvent

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/events/{id}:retry \
  -H 'Accept: */*'

POST https://api.nue.io/v1/events/{id}:retry HTTP/1.1
Host: api.nue.io
Accept: */*


const headers = {
  'Accept':'*/*'
};

fetch('https://api.nue.io/v1/events/{id}:retry',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*'
}

result = RestClient.post 'https://api.nue.io/v1/events/{id}:retry',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*'
}

r = requests.post('https://api.nue.io/v1/events/{id}:retry', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/events/{id}:retry', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/events/{id}:retry");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/events/{id}:retry", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /events/{id}:retry

Parameters

Name	In	Type	Required	Description
id	path	string	true	none
eventTypeRegistryId	query	string	false	none

Example responses

400 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	None
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline

Response Schema

findEventById

Code samples

# You can also use wget
curl -X GET https://api.nue.io/v1/events/{id} \
  -H 'Accept: */*'

GET https://api.nue.io/v1/events/{id} HTTP/1.1
Host: api.nue.io
Accept: */*


const headers = {
  'Accept':'*/*'
};

fetch('https://api.nue.io/v1/events/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*'
}

result = RestClient.get 'https://api.nue.io/v1/events/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*'
}

r = requests.get('https://api.nue.io/v1/events/{id}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/v1/events/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/events/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/v1/events/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /events/{id}

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	GetEventResponse
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline

Response Schema

event-post-controller

reSend

Code samples

# You can also use wget
curl -X POST https://api.nue.io/v1/eventPosts/{id}:reSend \
  -H 'Accept: */*'

POST https://api.nue.io/v1/eventPosts/{id}:reSend HTTP/1.1
Host: api.nue.io
Accept: */*


const headers = {
  'Accept':'*/*'
};

fetch('https://api.nue.io/v1/eventPosts/{id}:reSend',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*'
}

result = RestClient.post 'https://api.nue.io/v1/eventPosts/{id}:reSend',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*'
}

r = requests.post('https://api.nue.io/v1/eventPosts/{id}:reSend', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.nue.io/v1/eventPosts/{id}:reSend', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/eventPosts/{id}:reSend");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.nue.io/v1/eventPosts/{id}:reSend", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /eventPosts/{id}:reSend

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	EventDispatchResponse
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline

Response Schema

findEventPostById

Code samples

# You can also use wget
curl -X GET https://api.nue.io/v1/eventPosts/{id} \
  -H 'Accept: */*'

GET https://api.nue.io/v1/eventPosts/{id} HTTP/1.1
Host: api.nue.io
Accept: */*


const headers = {
  'Accept':'*/*'
};

fetch('https://api.nue.io/v1/eventPosts/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*'
}

result = RestClient.get 'https://api.nue.io/v1/eventPosts/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*'
}

r = requests.get('https://api.nue.io/v1/eventPosts/{id}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/v1/eventPosts/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/eventPosts/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/v1/eventPosts/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /eventPosts/{id}

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	GetEventPostResponse
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline

Response Schema

listEventProcessLogs

Code samples

# You can also use wget
curl -X GET https://api.nue.io/v1/eventPosts/{id}/logs \
  -H 'Accept: */*'

GET https://api.nue.io/v1/eventPosts/{id}/logs HTTP/1.1
Host: api.nue.io
Accept: */*


const headers = {
  'Accept':'*/*'
};

fetch('https://api.nue.io/v1/eventPosts/{id}/logs',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*'
}

result = RestClient.get 'https://api.nue.io/v1/eventPosts/{id}/logs',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*'
}

r = requests.get('https://api.nue.io/v1/eventPosts/{id}/logs', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => '*/*',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.nue.io/v1/eventPosts/{id}/logs', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.nue.io/v1/eventPosts/{id}/logs");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.nue.io/v1/eventPosts/{id}/logs", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /eventPosts/{id}/logs

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	GetEventProcessLogsResponse
400	Bad Request	Bad Request	ErrorMessage
404	Not Found	Not Found	Inline

Response Schema

Schemas

ErrorMessage

{
  "title": "string",
  "message": "string",
  "errorCode": "string",
  "errorType": "string"
}

Properties

Name	Type	Required	Restrictions	Description
title	string	false	none	none
message	string	false	none	none
errorCode	string	false	none	none
errorType	string	false	none	none

CreateEventTypeRegistrationResponse

{
  "id": "string",
  "name": "string",
  "object": "string",
  "createdDate": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "lastModifiedDate": "2019-08-24T14:15:22Z",
  "lastModifiedBy": "string",
  "description": "string",
  "status": "string",
  "events": [
    "string"
  ],
  "endpoint": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
name	string	false	none	none
object	string	false	none	none
createdDate	string(date-time)	false	none	none
createdBy	string	false	none	none
lastModifiedDate	string(date-time)	false	none	none
lastModifiedBy	string	false	none	none
description	string	false	none	none
status	string	false	none	none
events	[string]	false	none	none
endpoint	string	false	none	none

CreateEventTypeRegistrationRequest

{
  "name": "string",
  "eventTypes": [
    "string"
  ],
  "endpoint": "string",
  "actionType": "string",
  "description": "string"
}

Properties

Name	Type	Required	Restrictions	Description
name	string	true	none	none
eventTypes	[string]	true	none	none
endpoint	string	true	none	none
actionType	string	false	none	none
description	string	false	none	none

ContactRequestMap

{
  "customerId": "string",
  "requestDisplayId": "string",
  "id": "string",
  "tenantId": "string",
  "objectDisplayName": "string",
  "empty": true,
  "property1": {},
  "property2": {}
}

Properties

Name	Type	Required	Restrictions	Description
additionalProperties	object	false	none	none
customerId	string	false	none	none
requestDisplayId	string	false	none	none
id	string	false	none	none
tenantId	string	false	none	none
objectDisplayName	string	false	none	none
empty	boolean	false	none	none

CustomerRequestMap

{
  "contacts": [
    {
      "customerId": "string",
      "requestDisplayId": "string",
      "id": "string",
      "tenantId": "string",
      "objectDisplayName": "string",
      "empty": true,
      "property1": {},
      "property2": {}
    }
  ],
  "shippingCity": "string",
  "shippingPostalCode": "string",
  "shippingState": "string",
  "shippingStreet": "string",
  "requestDisplayId": "string",
  "id": "string",
  "tenantId": "string",
  "objectDisplayName": "string",
  "empty": true,
  "property1": {},
  "property2": {}
}

Properties

Name	Type	Required	Restrictions	Description
additionalProperties	object	false	none	none
contacts	[ContactRequestMap]	false	none	none
shippingCity	string	false	none	none
shippingPostalCode	string	false	none	none
shippingState	string	false	none	none
shippingStreet	string	false	none	none
requestDisplayId	string	false	none	none
id	string	false	none	none
tenantId	string	false	none	none
objectDisplayName	string	false	none	none
empty	boolean	false	none	none

OrderProductRequestMap

{
  "description": "string",
  "customFields": {
    "property1": {},
    "property2": {}
  },
  "billingTiming": "string",
  "entityId": "string",
  "quantity": 0,
  "subscriptionStartDate": "2019-08-24T14:15:22Z",
  "productId": "string",
  "priceBookEntryId": "string",
  "subscriptionTerm": 0,
  "productOptionId": "string",
  "productOptionQuantity": 0,
  "autoRenew": true,
  "currencyIsoCode": "string",
  "billCycleStartMonth": "string",
  "billCycleDay": "string",
  "billingPeriod": "string",
  "entityUseCode": "string",
  "defaultRenewalTerm": 0,
  "contractLiabilitySegment": "string",
  "contractRevenueSegment": "string",
  "carvesLiabilitySegment": "string",
  "carvesRevenueSegment": "string",
  "carvesEligible": true,
  "requestDisplayId": "string",
  "addOns": [
    {
      "productOptionId": "string",
      "requestDisplayId": "string",
      "tenantId": "string",
      "objectDisplayName": "string",
      "empty": true,
      "property1": {},
      "property2": {}
    }
  ],
  "priceTagCodes": [
    "string"
  ],
  "priceTagIds": [
    "string"
  ],
  "tenantId": "string",
  "objectDisplayName": "string",
  "empty": true,
  "property1": {},
  "property2": {}
}

Properties

Name	Type	Required	Restrictions	Description
additionalProperties	object	false	none	none
description	string	false	none	none
customFields	object	false	none	none
» additionalProperties	object	false	none	none
billingTiming	string	false	none	none
entityId	string	false	none	none
quantity	number	false	none	none
subscriptionStartDate	string(date-time)	false	none	none
productId	string	false	none	none
priceBookEntryId	string	false	none	none
subscriptionTerm	number	false	none	none
productOptionId	string	false	none	none
productOptionQuantity	number	false	none	none
autoRenew	boolean	false	none	none
currencyIsoCode	string	false	none	none
billCycleStartMonth	string	false	none	none
billCycleDay	string	false	none	none
billingPeriod	string	false	none	none
entityUseCode	string	false	none	none
defaultRenewalTerm	number	false	none	none
contractLiabilitySegment	string	false	none	none
contractRevenueSegment	string	false	none	none
carvesLiabilitySegment	string	false	none	none
carvesRevenueSegment	string	false	none	none
carvesEligible	boolean	false	none	none
requestDisplayId	string	false	none	none
addOns	[ProductOptionRequestMap]	false	none	none
priceTagCodes	[string]	false	none	none
priceTagIds	[string]	false	none	none
tenantId	string	false	none	none
objectDisplayName	string	false	none	none
empty	boolean	false	none	none

ProductOptionRequestMap

{
  "productOptionId": "string",
  "requestDisplayId": "string",
  "tenantId": "string",
  "objectDisplayName": "string",
  "empty": true,
  "property1": {},
  "property2": {}
}

Properties

Name	Type	Required	Restrictions	Description
additionalProperties	object	false	none	none
productOptionId	string	false	none	none
requestDisplayId	string	false	none	none
tenantId	string	false	none	none
objectDisplayName	string	false	none	none
empty	boolean	false	none	none

AssetCreatedDto

{
  "assetCompositeId": "string",
  "assetLevel": 0,
  "assetNumber": "string",
  "assetProvidedById": "string",
  "assetServicedById": "string",
  "assetVersion": 0,
  "billingPeriod": "string",
  "billingTiming": "string",
  "cancellationDate": "string",
  "competitorProduct": true,
  "contactId": "string",
  "createdById": "string",
  "customerId": "string",
  "description": "string",
  "externalId": "string",
  "externalName": "string",
  "id": "string",
  "installDate": "string",
  "internalAsset": true,
  "lastModifiedById": "string",
  "lastVersionedAssetId": "string",
  "listPrice": 0,
  "locationId": "string",
  "name": "string",
  "orderProductId": "string",
  "originalAssetId": "string",
  "parentAssetObject": "string",
  "parentId": "string",
  "price": 0,
  "priceBookEntryId": "string",
  "priceBookId": "string",
  "productCode": "string",
  "productDescription": "string",
  "productFamily": "string",
  "productId": "string",
  "purchaseDate": "string",
  "quantity": 0,
  "reconfigureEffectiveDate": "string",
  "rootId": "string",
  "salesPrice": 0,
  "serialNumber": "string",
  "sku": "string",
  "startDate": "string",
  "status": "string",
  "statusReason": "string",
  "taxAmount": 0,
  "tcv": 0,
  "totalAcv": 0,
  "totalAmount": 0,
  "totalPrice": 0,
  "totalTcv": 0,
  "uniqueIdentifier": "string",
  "uomId": "string",
  "usageEndDate": "string"
}

Assets created.

Properties

Name	Type	Required	Restrictions	Description
assetCompositeId	string	false	none	none
assetLevel	integer(int32)	false	none	none
assetNumber	string	false	none	none
assetProvidedById	string	false	none	none
assetServicedById	string	false	none	none
assetVersion	number	false	none	none
billingPeriod	string	false	none	none
billingTiming	string	false	none	none
cancellationDate	string	false	none	none
competitorProduct	boolean	false	none	none
contactId	string	false	none	none
createdById	string	false	none	none
customerId	string	false	none	none
description	string	false	none	none
externalId	string	false	none	Mapping to an identifier from an external system, in this case Salesforce
externalName	string	false	none	Mapping to the name from an external system, in this case Salesforce
id	string	false	none	none
installDate	string	false	none	none
internalAsset	boolean	false	none	none
lastModifiedById	string	false	none	none
lastVersionedAssetId	string	false	none	none
listPrice	number	false	none	none
locationId	string	false	none	none
name	string	false	none	none
orderProductId	string	false	none	none
originalAssetId	string	false	none	none
parentAssetObject	string	false	none	none
parentId	string	false	none	none
price	number	false	none	none
priceBookEntryId	string	false	none	none
priceBookId	string	false	none	none
productCode	string	false	none	none
productDescription	string	false	none	none
productFamily	string	false	none	none
productId	string	false	none	none
purchaseDate	string	false	none	none
quantity	number	false	none	none
reconfigureEffectiveDate	string	false	none	none
rootId	string	false	none	none
salesPrice	number	false	none	none
serialNumber	string	false	none	none
sku	string	false	none	none
startDate	string	false	none	none
status	string	false	none	none
statusReason	string	false	none	none
taxAmount	number	false	none	none
tcv	number	false	none	none
totalAcv	number	false	none	none
totalAmount	number	false	none	none
totalPrice	number	false	none	none
totalTcv	number	false	none	none
uniqueIdentifier	string	false	none	none
uomId	string	false	none	none
usageEndDate	string	false	none	none

CreateOrderResponse

{
  "assets": [
    {
      "assetCompositeId": "string",
      "assetLevel": 0,
      "assetNumber": "string",
      "assetProvidedById": "string",
      "assetServicedById": "string",
      "assetVersion": 0,
      "billingPeriod": "string",
      "billingTiming": "string",
      "cancellationDate": "string",
      "competitorProduct": true,
      "contactId": "string",
      "createdById": "string",
      "customerId": "string",
      "description": "string",
      "externalId": "string",
      "externalName": "string",
      "id": "string",
      "installDate": "string",
      "internalAsset": true,
      "lastModifiedById": "string",
      "lastVersionedAssetId": "string",
      "listPrice": 0,
      "locationId": "string",
      "name": "string",
      "orderProductId": "string",
      "originalAssetId": "string",
      "parentAssetObject": "string",
      "parentId": "string",
      "price": 0,
      "priceBookEntryId": "string",
      "priceBookId": "string",
      "productCode": "string",
      "productDescription": "string",
      "productFamily": "string",
      "productId": "string",
      "purchaseDate": "string",
      "quantity": 0,
      "reconfigureEffectiveDate": "string",
      "rootId": "string",
      "salesPrice": 0,
      "serialNumber": "string",
      "sku": "string",
      "startDate": "string",
      "status": "string",
      "statusReason": "string",
      "taxAmount": 0,
      "tcv": 0,
      "totalAcv": 0,
      "totalAmount": 0,
      "totalPrice": 0,
      "totalTcv": 0,
      "uniqueIdentifier": "string",
      "uomId": "string",
      "usageEndDate": "string"
    }
  ],
  "entitlements": [
    {
      "billingPeriod": "string",
      "billingTime": "string",
      "cancellationDate": "string",
      "createdById": "string",
      "currencyIsoCode": "string",
      "customerId": "string",
      "description": "string",
      "endDate": "string",
      "entitlementCompositeId": "string",
      "entitlementLevel": 0,
      "entitlementNumber": "string",
      "entitlementVersion": 0,
      "externalId": "string",
      "externalName": "string",
      "id": "string",
      "lastModifiedById": "string",
      "lastVersionedEntitlementId": "string",
      "listPrice": 0,
      "name": "string",
      "netSalesPrice": 0,
      "orderNumber": "string",
      "orderOnDate": "string",
      "orderProductId": "string",
      "originalEntitlementId": "string",
      "originalEntitlementNumber": "string",
      "parentEntitlementObject": "string",
      "parentId": "string",
      "priceBookEntryId": "string",
      "priceBookId": "string",
      "productId": "string",
      "productName": "string",
      "quantity": 0,
      "quantityDimension": "string",
      "reconfigureEffectiveDate": "string",
      "rootId": "string",
      "salesPrice": 0,
      "startDate": "string",
      "status": "string",
      "taxAmount": 0,
      "tcv": 0,
      "termDimension": "string",
      "totalAcv": 0,
      "totalAmount": 0,
      "totalPrice": 0,
      "totalTcv": 0,
      "uomId": "string"
    }
  ],
  "invoices": [
    {
      "invoice": {},
      "items": [
        {}
      ]
    }
  ],
  "order": {
    "property1": {},
    "property2": {}
  },
  "orderProducts": [
    {
      "property1": {},
      "property2": {}
    }
  ],
  "previewInvoices": [
    {
      "accountEx": "string",
      "accountId": "string",
      "accountingStatus": "NotStarted",
      "activatedById": "string",
      "activatedTime": "2019-08-24T14:15:22Z",
      "amount": 0,
      "amountWithoutTax": 0,
      "autoNumberFormat": "string",
      "autoNumberSequence": 0,
      "balance": 0,
      "billToContactEx": "string",
      "billToContactId": "string",
      "cancellationDate": "2019-08-24",
      "currencyIsoCode": "string",
      "dueDate": "2019-08-24",
      "einvoicingDocId": "e002708e-3a5b-4ad0-9a8d-67f970507aac",
      "einvoicingDocStatus": "Submitted",
      "einvoicingMandateCode": "string",
      "einvoicingMandateId": "11a4fc7b-acc3-4c4a-83f3-ae2bdaee27d1",
      "einvoicingMessage": "string",
      "endDate": "2019-08-24",
      "entityId": "string",
      "externalInvoiceId": "string",
      "externalTaxId": "string",
      "groupKey": {
        "empty": true,
        "property1": "string",
        "property2": "string"
      },
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "invoiceDate": "2019-08-24",
      "invoiceNumber": "string",
      "invoicePdf": "string",
      "isCatchUp": true,
      "items": [
        {
          "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
          "accountId": "string",
          "groupKey": {
            "empty": true,
            "property1": "string",
            "property2": "string"
          },
          "invoiceId": "4f163819-178d-470c-a246-d6768476a6ec",
          "invoiceNumber": "string",
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "recordType": "Invoice",
          "isCatchUp": true,
          "invoiceItemNumber": "string",
          "productId": "string",
          "productName": "string",
          "assetId": "string",
          "assetNumber": "string",
          "assetType": "Subscription",
          "uomId": "string",
          "uomEx": "string",
          "currencyIsoCode": "string",
          "transactionDate": "2019-08-24",
          "transactionAmount": 0,
          "transactionAmountWithoutTax": 0,
          "transactionQuantity": 0,
          "shippingAndHandling": 0,
          "taxAmount": 0,
          "ratedCredits": 0,
          "appliedCredits": 0,
          "netSalesPrice": 0,
          "balance": 0,
          "startDate": "2019-08-24",
          "endDate": "2019-08-24",
          "billingTiming": "InAdvance",
          "status": "Draft",
          "taxStatus": "NotCalculated",
          "salesAccountId": "string",
          "details": [
            {
              "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
              "accountId": "string",
              "invoiceId": "4f163819-178d-470c-a246-d6768476a6ec",
              "invoiceItemId": "f67649b2-10bf-48d7-88da-9e916e62d319",
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
              "isCatchUp": true,
              "orderProductId": "string",
              "detailType": "Committed",
              "billedAmount": 0,
              "transactionAmount": 0,
              "transactionAmountWithoutTax": 0,
              "transactionQuantity": 0,
              "shippingAndHandling": 0,
              "billedShipping": 0,
              "taxAmount": 0,
              "netSalesPrice": 0,
              "ratedCredits": 0,
              "appliedCredits": 0,
              "startDate": "2019-08-24",
              "endDate": "2019-08-24",
              "billingTiming": "InAdvance",
              "status": "Draft",
              "taxStatus": "NotCalculated",
              "currencyIsoCode": "string",
              "salesAccountId": "string",
              "invoiceItemDetailNumber": "string",
              "taxRates": "string",
              "vatCode": "string",
              "vatNumberTypeId": "string",
              "avtUserBIN": "string",
              "autoNumberFormat": "string",
              "autoNumberSequence": 0,
              "entityId": "string"
            }
          ],
          "taxCode": "string",
          "taxMode": "string",
          "taxRates": "string",
          "taxPercent": 0,
          "description": "string",
          "autoNumberFormat": "string",
          "autoNumberSequence": 0,
          "entityId": "string"
        }
      ],
      "paymentMethods": [
        "string"
      ],
      "poDates": "string",
      "poNumbers": "string",
      "recordType": "Invoice",
      "salesAccountId": "string",
      "shippingAndHandling": 0,
      "source": "Billing",
      "startDate": "2019-08-24",
      "status": "Draft",
      "syncTime": "2019-08-24T14:15:22Z",
      "targetDate": "2019-08-24",
      "taxAmount": 0,
      "taxErrorMessage": "string",
      "taxStatus": "NotCalculated",
      "templateId": "string",
      "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
      "vatMessages": "string"
    }
  ],
  "subscriptions": [
    {
      "actualSubscriptionTerm": 0,
      "autoRenew": true,
      "billingPeriod": "string",
      "billingTiming": "string",
      "bundled": true,
      "cancellationDate": "string",
      "createdById": "string",
      "currencyIsoCode": "string",
      "customerId": "string",
      "description": "string",
      "evergreen": true,
      "externalId": "string",
      "externalName": "string",
      "id": "string",
      "includedUnits": 0,
      "lastModifiedById": "string",
      "lastVersionedSubscriptionId": "string",
      "listPrice": 0,
      "name": "string",
      "orderOnDate": "string",
      "orderProductId": "string",
      "originalSubscriptionId": "string",
      "originalSubscriptionNumber": "string",
      "parentId": "string",
      "parentObjectType": "string",
      "priceBookEntryId": "string",
      "priceBookId": "string",
      "productId": "string",
      "quantity": 0,
      "reconfigureEffectiveDate": "string",
      "renewalTerm": 0,
      "rootId": "string",
      "salesPrice": 0,
      "status": "string",
      "subscriptionCompositeId": "string",
      "subscriptionEndDate": "string",
      "subscriptionLevel": 0,
      "subscriptionStartDate": "string",
      "subscriptionTerm": 0,
      "subscriptionVersion": 0,
      "taxAmount": 0,
      "tcv": 0,
      "todayARR": 0,
      "todayCMRR": 0,
      "todaysQuantity": 0,
      "totalACV": 0,
      "totalAmount": 0,
      "totalPrice": 0,
      "totalTCV": 0,
      "uomId": "string"
    }
  ],
  "transactionHub": {
    "property1": "string",
    "property2": "string"
  }
}

Properties

Name	Type	Required	Restrictions	Description
assets	[AssetCreatedDto]	false	none	Assets created.
entitlements	[EntitlementCreatedDto]	false	none	Entitlements created.
invoices	[InvoiceModelWithItems]	false	none	Invoices created.
order	object	false	none	Order activated.
» additionalProperties	object	false	none	Order activated.
orderProducts	[object]	false	none	Order product activated.
» additionalProperties	object	false	none	Order product activated.
previewInvoices	[Invoice]	false	none	Preview Invoices.
subscriptions	[SubscriptionCreatedDto]	false	none	Subscriptions created.
transactionHub	object	false	none	TransactionHub payment details.
» additionalProperties	string	false	none	TransactionHub payment details.

EntitlementCreatedDto

{
  "billingPeriod": "string",
  "billingTime": "string",
  "cancellationDate": "string",
  "createdById": "string",
  "currencyIsoCode": "string",
  "customerId": "string",
  "description": "string",
  "endDate": "string",
  "entitlementCompositeId": "string",
  "entitlementLevel": 0,
  "entitlementNumber": "string",
  "entitlementVersion": 0,
  "externalId": "string",
  "externalName": "string",
  "id": "string",
  "lastModifiedById": "string",
  "lastVersionedEntitlementId": "string",
  "listPrice": 0,
  "name": "string",
  "netSalesPrice": 0,
  "orderNumber": "string",
  "orderOnDate": "string",
  "orderProductId": "string",
  "originalEntitlementId": "string",
  "originalEntitlementNumber": "string",
  "parentEntitlementObject": "string",
  "parentId": "string",
  "priceBookEntryId": "string",
  "priceBookId": "string",
  "productId": "string",
  "productName": "string",
  "quantity": 0,
  "quantityDimension": "string",
  "reconfigureEffectiveDate": "string",
  "rootId": "string",
  "salesPrice": 0,
  "startDate": "string",
  "status": "string",
  "taxAmount": 0,
  "tcv": 0,
  "termDimension": "string",
  "totalAcv": 0,
  "totalAmount": 0,
  "totalPrice": 0,
  "totalTcv": 0,
  "uomId": "string"
}

Entitlements created.

Properties

Name	Type	Required	Restrictions	Description
billingPeriod	string	false	none	none
billingTime	string	false	none	Timing for billing (e.g., In Advance).
cancellationDate	string	false	none	none
createdById	string	false	none	none
currencyIsoCode	string	false	none	none
customerId	string	false	none	ID of the customer associated with the entitlement.
description	string	false	none	Description of the product.
endDate	string	false	none	End date of the entitlement.
entitlementCompositeId	string	false	none	Unique identifier for the entitlement composite.
entitlementLevel	number	false	none	Level of the entitlement in the hierarchy.
entitlementNumber	string	false	none	Identifier for the entitlement.
entitlementVersion	number	false	none	Version of the entitlement.
externalId	string	false	none	Mapping to an identifier from an external system, in this case Salesforce
externalName	string	false	none	Mapping to the name from an external system, in this case Salesforce
id	string	false	none	Unique identifier for the entitlement.
lastModifiedById	string	false	none	ID of the user who last modified the entitlement.
lastVersionedEntitlementId	string	false	none	none
listPrice	number	false	none	List price of the entitlement.
name	string	false	none	Name of the entitlement.
netSalesPrice	number	false	none	Net sales price of the entitlement.
orderNumber	string	false	none	none
orderOnDate	string	false	none	none
orderProductId	string	false	none	Identifier for the product order.
originalEntitlementId	string	false	none	none
originalEntitlementNumber	string	false	none	none
parentEntitlementObject	string	false	none	Type of the parent entitlement object.
parentId	string	false	none	none
priceBookEntryId	string	false	none	ID of the price book entry.
priceBookId	string	false	none	ID of the price book associated with the entitlement.
productId	string	false	none	ID of the product.
productName	string	false	none	Name of the product associated with the entitlement.
quantity	number	false	none	Quantity of the entitlement.
quantityDimension	string	false	none	Dimension of the quantity (e.g., Each, Box).
reconfigureEffectiveDate	string	false	none	none
rootId	string	false	none	Root ID of the entitlement.
salesPrice	number	false	none	none
startDate	string	false	none	Start date of the entitlement.
status	string	false	none	Status of the entitlement.
taxAmount	number	false	none	Tax amount applicable to the entitlement.
tcv	number	false	none	Total contract value of the entitlement.
termDimension	string	false	none	none
totalAcv	number	false	none	Total annual contract value for the entitlement.
totalAmount	number	false	none	Total amount for the entitlement.
totalPrice	number	false	none	Total price for the entitlement.
totalTcv	number	false	none	Total contract value for the entitlement.
uomId	string	false	none	ID of the unit of measure.

Invoice

{
  "accountEx": "string",
  "accountId": "string",
  "accountingStatus": "NotStarted",
  "activatedById": "string",
  "activatedTime": "2019-08-24T14:15:22Z",
  "amount": 0,
  "amountWithoutTax": 0,
  "autoNumberFormat": "string",
  "autoNumberSequence": 0,
  "balance": 0,
  "billToContactEx": "string",
  "billToContactId": "string",
  "cancellationDate": "2019-08-24",
  "currencyIsoCode": "string",
  "dueDate": "2019-08-24",
  "einvoicingDocId": "e002708e-3a5b-4ad0-9a8d-67f970507aac",
  "einvoicingDocStatus": "Submitted",
  "einvoicingMandateCode": "string",
  "einvoicingMandateId": "11a4fc7b-acc3-4c4a-83f3-ae2bdaee27d1",
  "einvoicingMessage": "string",
  "endDate": "2019-08-24",
  "entityId": "string",
  "externalInvoiceId": "string",
  "externalTaxId": "string",
  "groupKey": {
    "empty": true,
    "property1": "string",
    "property2": "string"
  },
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "invoiceDate": "2019-08-24",
  "invoiceNumber": "string",
  "invoicePdf": "string",
  "isCatchUp": true,
  "items": [
    {
      "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
      "accountId": "string",
      "groupKey": {
        "empty": true,
        "property1": "string",
        "property2": "string"
      },
      "invoiceId": "4f163819-178d-470c-a246-d6768476a6ec",
      "invoiceNumber": "string",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "recordType": "Invoice",
      "isCatchUp": true,
      "invoiceItemNumber": "string",
      "productId": "string",
      "productName": "string",
      "assetId": "string",
      "assetNumber": "string",
      "assetType": "Subscription",
      "uomId": "string",
      "uomEx": "string",
      "currencyIsoCode": "string",
      "transactionDate": "2019-08-24",
      "transactionAmount": 0,
      "transactionAmountWithoutTax": 0,
      "transactionQuantity": 0,
      "shippingAndHandling": 0,
      "taxAmount": 0,
      "ratedCredits": 0,
      "appliedCredits": 0,
      "netSalesPrice": 0,
      "balance": 0,
      "startDate": "2019-08-24",
      "endDate": "2019-08-24",
      "billingTiming": "InAdvance",
      "status": "Draft",
      "taxStatus": "NotCalculated",
      "salesAccountId": "string",
      "details": [
        {
          "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
          "accountId": "string",
          "invoiceId": "4f163819-178d-470c-a246-d6768476a6ec",
          "invoiceItemId": "f67649b2-10bf-48d7-88da-9e916e62d319",
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "isCatchUp": true,
          "orderProductId": "string",
          "detailType": "Committed",
          "billedAmount": 0,
          "transactionAmount": 0,
          "transactionAmountWithoutTax": 0,
          "transactionQuantity": 0,
          "shippingAndHandling": 0,
          "billedShipping": 0,
          "taxAmount": 0,
          "netSalesPrice": 0,
          "ratedCredits": 0,
          "appliedCredits": 0,
          "startDate": "2019-08-24",
          "endDate": "2019-08-24",
          "billingTiming": "InAdvance",
          "status": "Draft",
          "taxStatus": "NotCalculated",
          "currencyIsoCode": "string",
          "salesAccountId": "string",
          "invoiceItemDetailNumber": "string",
          "taxRates": "string",
          "vatCode": "string",
          "vatNumberTypeId": "string",
          "avtUserBIN": "string",
          "autoNumberFormat": "string",
          "autoNumberSequence": 0,
          "entityId": "string"
        }
      ],
      "taxCode": "string",
      "taxMode": "string",
      "taxRates": "string",
      "taxPercent": 0,
      "description": "string",
      "autoNumberFormat": "string",
      "autoNumberSequence": 0,
      "entityId": "string"
    }
  ],
  "paymentMethods": [
    "string"
  ],
  "poDates": "string",
  "poNumbers": "string",
  "recordType": "Invoice",
  "salesAccountId": "string",
  "shippingAndHandling": 0,
  "source": "Billing",
  "startDate": "2019-08-24",
  "status": "Draft",
  "syncTime": "2019-08-24T14:15:22Z",
  "targetDate": "2019-08-24",
  "taxAmount": 0,
  "taxErrorMessage": "string",
  "taxStatus": "NotCalculated",
  "templateId": "string",
  "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
  "vatMessages": "string"
}

Preview Invoices.

Properties

Name	Type	Required	Restrictions	Description
accountEx	string	false	none	none
accountId	string	false	none	none
accountingStatus	string	false	none	none
activatedById	string	false	none	none
activatedTime	string(date-time)	false	none	none
amount	number	false	none	none
amountWithoutTax	number	false	none	none
autoNumberFormat	string	false	none	none
autoNumberSequence	integer(int64)	false	none	none
balance	number	false	none	none
billToContactEx	string	false	none	none
billToContactId	string	false	none	none
cancellationDate	string(date)	false	none	none
currencyIsoCode	string	false	none	none
dueDate	string(date)	false	none	none
einvoicingDocId	string(uuid)	false	none	none
einvoicingDocStatus	string	false	none	none
einvoicingMandateCode	string	false	none	none
einvoicingMandateId	string(uuid)	false	none	none
einvoicingMessage	string	false	none	none
endDate	string(date)	false	none	none
entityId	string	false	none	none
externalInvoiceId	string	false	none	none
externalTaxId	string	false	none	none
groupKey	object	true	none	none
» additionalProperties	string	false	none	none
» empty	boolean	false	none	none
id	string(uuid)	false	none	none
invoiceDate	string(date)	false	none	none
invoiceNumber	string	false	none	none
invoicePdf	string	false	none	none
isCatchUp	boolean	false	none	none
items	[InvoiceItem]	false	none	none
paymentMethods	[string]	false	none	none
poDates	string	false	none	none
poNumbers	string	false	none	none
recordType	string	false	none	none
salesAccountId	string	false	none	none
shippingAndHandling	number	false	none	none
source	string	false	none	none
startDate	string(date)	false	none	none
status	string	false	none	none
syncTime	string(date-time)	false	none	none
targetDate	string(date)	false	none	none
taxAmount	number	false	none	none
taxErrorMessage	string	false	none	none
taxStatus	string	false	none	none
templateId	string	false	none	none
tenantId	string(uuid)	false	none	none
vatMessages	string	false	none	none

Enumerated Values

Property	Value
accountingStatus	NotStarted
accountingStatus	Complete
accountingStatus	Error
accountingStatus	Skipped
einvoicingDocStatus	Submitted
einvoicingDocStatus	Accepted
einvoicingDocStatus	Pending
einvoicingDocStatus	Error
einvoicingDocStatus	Complete
recordType	Invoice
recordType	CreditMemo
source	Billing
source	CreditConversion
source	PaymentOperation
status	Draft
status	PendingActivation
status	Active
status	Canceled
status	EInvoicing
taxStatus	NotCalculated
taxStatus	Calculated
taxStatus	Error
taxStatus	Committed

InvoiceItem

{
  "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
  "accountId": "string",
  "groupKey": {
    "empty": true,
    "property1": "string",
    "property2": "string"
  },
  "invoiceId": "4f163819-178d-470c-a246-d6768476a6ec",
  "invoiceNumber": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "recordType": "Invoice",
  "isCatchUp": true,
  "invoiceItemNumber": "string",
  "productId": "string",
  "productName": "string",
  "assetId": "string",
  "assetNumber": "string",
  "assetType": "Subscription",
  "uomId": "string",
  "uomEx": "string",
  "currencyIsoCode": "string",
  "transactionDate": "2019-08-24",
  "transactionAmount": 0,
  "transactionAmountWithoutTax": 0,
  "transactionQuantity": 0,
  "shippingAndHandling": 0,
  "taxAmount": 0,
  "ratedCredits": 0,
  "appliedCredits": 0,
  "netSalesPrice": 0,
  "balance": 0,
  "startDate": "2019-08-24",
  "endDate": "2019-08-24",
  "billingTiming": "InAdvance",
  "status": "Draft",
  "taxStatus": "NotCalculated",
  "salesAccountId": "string",
  "details": [
    {
      "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
      "accountId": "string",
      "invoiceId": "4f163819-178d-470c-a246-d6768476a6ec",
      "invoiceItemId": "f67649b2-10bf-48d7-88da-9e916e62d319",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "isCatchUp": true,
      "orderProductId": "string",
      "detailType": "Committed",
      "billedAmount": 0,
      "transactionAmount": 0,
      "transactionAmountWithoutTax": 0,
      "transactionQuantity": 0,
      "shippingAndHandling": 0,
      "billedShipping": 0,
      "taxAmount": 0,
      "netSalesPrice": 0,
      "ratedCredits": 0,
      "appliedCredits": 0,
      "startDate": "2019-08-24",
      "endDate": "2019-08-24",
      "billingTiming": "InAdvance",
      "status": "Draft",
      "taxStatus": "NotCalculated",
      "currencyIsoCode": "string",
      "salesAccountId": "string",
      "invoiceItemDetailNumber": "string",
      "taxRates": "string",
      "vatCode": "string",
      "vatNumberTypeId": "string",
      "avtUserBIN": "string",
      "autoNumberFormat": "string",
      "autoNumberSequence": 0,
      "entityId": "string"
    }
  ],
  "taxCode": "string",
  "taxMode": "string",
  "taxRates": "string",
  "taxPercent": 0,
  "description": "string",
  "autoNumberFormat": "string",
  "autoNumberSequence": 0,
  "entityId": "string"
}

Properties

Name	Type	Required	Restrictions	Description
tenantId	string(uuid)	false	none	none
accountId	string	false	none	none
groupKey	object	false	none	none
» additionalProperties	string	false	none	none
» empty	boolean	false	none	none
invoiceId	string(uuid)	false	none	none
invoiceNumber	string	false	none	none
id	string(uuid)	false	none	none
recordType	string	false	none	none
isCatchUp	boolean	false	none	none
invoiceItemNumber	string	false	none	none
productId	string	false	none	none
productName	string	false	none	none
assetId	string	false	none	none
assetNumber	string	false	none	none
assetType	string	false	none	none
uomId	string	false	none	none
uomEx	string	false	none	none
currencyIsoCode	string	false	none	none
transactionDate	string(date)	false	none	none
transactionAmount	number	false	none	none
transactionAmountWithoutTax	number	false	none	none
transactionQuantity	number	false	none	none
shippingAndHandling	number	false	none	none
taxAmount	number	false	none	none
ratedCredits	number	false	none	none
appliedCredits	number	false	none	none
netSalesPrice	number	false	none	none
balance	number	false	none	none
startDate	string(date)	false	none	none
endDate	string(date)	false	none	none
billingTiming	string	false	none	none
status	string	false	none	none
taxStatus	string	false	none	none
salesAccountId	string	false	none	none
details	[InvoiceItemDetail]	false	none	none
taxCode	string	false	none	none
taxMode	string	false	none	none
taxRates	string	false	none	none
taxPercent	number	false	none	none
description	string	false	none	none
autoNumberFormat	string	false	none	none
autoNumberSequence	integer(int64)	false	none	none
entityId	string	false	none	none

Enumerated Values

Property	Value
recordType	Invoice
recordType	CreditMemo
assetType	Subscription
assetType	Asset
assetType	Entitlement
billingTiming	InAdvance
billingTiming	InArrears
status	Draft
status	PendingActivation
status	Active
status	Canceled
status	EInvoicing
taxStatus	NotCalculated
taxStatus	Calculated
taxStatus	Error
taxStatus	Committed

InvoiceItemDetail

{
  "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
  "accountId": "string",
  "invoiceId": "4f163819-178d-470c-a246-d6768476a6ec",
  "invoiceItemId": "f67649b2-10bf-48d7-88da-9e916e62d319",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "isCatchUp": true,
  "orderProductId": "string",
  "detailType": "Committed",
  "billedAmount": 0,
  "transactionAmount": 0,
  "transactionAmountWithoutTax": 0,
  "transactionQuantity": 0,
  "shippingAndHandling": 0,
  "billedShipping": 0,
  "taxAmount": 0,
  "netSalesPrice": 0,
  "ratedCredits": 0,
  "appliedCredits": 0,
  "startDate": "2019-08-24",
  "endDate": "2019-08-24",
  "billingTiming": "InAdvance",
  "status": "Draft",
  "taxStatus": "NotCalculated",
  "currencyIsoCode": "string",
  "salesAccountId": "string",
  "invoiceItemDetailNumber": "string",
  "taxRates": "string",
  "vatCode": "string",
  "vatNumberTypeId": "string",
  "avtUserBIN": "string",
  "autoNumberFormat": "string",
  "autoNumberSequence": 0,
  "entityId": "string"
}

Properties

Name	Type	Required	Restrictions	Description
tenantId	string(uuid)	false	none	none
accountId	string	false	none	none
invoiceId	string(uuid)	false	none	none
invoiceItemId	string(uuid)	false	none	none
id	string(uuid)	false	none	none
isCatchUp	boolean	false	none	none
orderProductId	string	false	none	none
detailType	string	false	none	none
billedAmount	number	false	none	none
transactionAmount	number	false	none	none
transactionAmountWithoutTax	number	false	none	none
transactionQuantity	number	false	none	none
shippingAndHandling	number	false	none	none
billedShipping	number	false	none	none
taxAmount	number	false	none	none
netSalesPrice	number	false	none	none
ratedCredits	number	false	none	none
appliedCredits	number	false	none	none
startDate	string(date)	false	none	none
endDate	string(date)	false	none	none
billingTiming	string	false	none	none
status	string	false	none	none
taxStatus	string	false	none	none
currencyIsoCode	string	false	none	none
salesAccountId	string	false	none	none
invoiceItemDetailNumber	string	false	none	none
taxRates	string	false	none	none
vatCode	string	false	none	none
vatNumberTypeId	string	false	none	none
avtUserBIN	string	false	none	none
autoNumberFormat	string	false	none	none
autoNumberSequence	integer(int64)	false	none	none
entityId	string	false	none	none

Enumerated Values

Property	Value
detailType	Committed
detailType	Overage
billingTiming	InAdvance
billingTiming	InArrears
status	Draft
status	PendingActivation
status	Active
status	Canceled
status	EInvoicing
taxStatus	NotCalculated
taxStatus	Calculated
taxStatus	Error
taxStatus	Committed

InvoiceModelWithItems

{
  "invoice": {},
  "items": [
    {}
  ]
}

Invoices created.

Properties

Name	Type	Required	Restrictions	Description
invoice	object	false	none	none
items	[object]	false	none	none

SubscriptionCreatedDto

{
  "actualSubscriptionTerm": 0,
  "autoRenew": true,
  "billingPeriod": "string",
  "billingTiming": "string",
  "bundled": true,
  "cancellationDate": "string",
  "createdById": "string",
  "currencyIsoCode": "string",
  "customerId": "string",
  "description": "string",
  "evergreen": true,
  "externalId": "string",
  "externalName": "string",
  "id": "string",
  "includedUnits": 0,
  "lastModifiedById": "string",
  "lastVersionedSubscriptionId": "string",
  "listPrice": 0,
  "name": "string",
  "orderOnDate": "string",
  "orderProductId": "string",
  "originalSubscriptionId": "string",
  "originalSubscriptionNumber": "string",
  "parentId": "string",
  "parentObjectType": "string",
  "priceBookEntryId": "string",
  "priceBookId": "string",
  "productId": "string",
  "quantity": 0,
  "reconfigureEffectiveDate": "string",
  "renewalTerm": 0,
  "rootId": "string",
  "salesPrice": 0,
  "status": "string",
  "subscriptionCompositeId": "string",
  "subscriptionEndDate": "string",
  "subscriptionLevel": 0,
  "subscriptionStartDate": "string",
  "subscriptionTerm": 0,
  "subscriptionVersion": 0,
  "taxAmount": 0,
  "tcv": 0,
  "todayARR": 0,
  "todayCMRR": 0,
  "todaysQuantity": 0,
  "totalACV": 0,
  "totalAmount": 0,
  "totalPrice": 0,
  "totalTCV": 0,
  "uomId": "string"
}

Subscriptions created.

Properties

Name	Type	Required	Restrictions	Description
actualSubscriptionTerm	number	false	none	Actual subscription term
autoRenew	boolean	false	none	Indicates if subscription is auto renewed
billingPeriod	string	false	none	Billing period
billingTiming	string	false	none	Billing timing
bundled	boolean	false	none	Indicates if subscription is bundled.
cancellationDate	string	false	none	Cancellation date.
createdById	string	false	none	Created by
currencyIsoCode	string	false	none	Current ISO code
customerId	string	false	none	ID of customer
description	string	false	none	Subscription description
evergreen	boolean	false	none	Indicates if this product or line item has an evergreen subscription term.
externalId	string	false	none	Mapping to an identifier from an external system, in this case Salesforce
externalName	string	false	none	Mapping to the name from an external system, in this case Salesforce
id	string	false	none	ID of subscription
includedUnits	number	false	none	The total units included in the line item for free.
lastModifiedById	string	false	none	Last modified date by
lastVersionedSubscriptionId	string	false	none	Last versioned subscription ID
listPrice	number	false	none	The price of the product within the price book
name	string	false	none	Subscription name
orderOnDate	string	false	none	Order on date
orderProductId	string	false	none	Order product ID
originalSubscriptionId	string	false	none	Original subscription ID
originalSubscriptionNumber	string	false	none	Original subscription number
parentId	string	false	none	Parent subscription ID
parentObjectType	string	false	none	none
priceBookEntryId	string	false	none	Price book entry ID
priceBookId	string	false	none	Price book ID
productId	string	false	none	Product ID
quantity	number	false	none	Quantity of subscription
reconfigureEffectiveDate	string	false	none	Reconfigure effective date
renewalTerm	number	false	none	Renewal term.
rootId	string	false	none	Root subscription ID
salesPrice	number	false	none	Sales price
status	string	false	none	Subscription status
subscriptionCompositeId	string	false	none	Subscription composite ID
subscriptionEndDate	string	false	none	Subscription end date
subscriptionLevel	number	false	none	Subscription level
subscriptionStartDate	string	false	none	Subscription start date
subscriptionTerm	number	false	none	Subscription term
subscriptionVersion	number	false	none	Subscription version
taxAmount	number	false	none	Tax amount
tcv	number	false	none	Total Contractual Value
todayARR	number	false	none	Today ARR
todayCMRR	number	false	none	Today CMRR
todaysQuantity	number	false	none	Today's quantity
totalACV	number	false	none	Total ACV
totalAmount	number	false	none	Total amount
totalPrice	number	false	none	Total price
totalTCV	number	false	none	Total TCV
uomId	string	false	none	UOM ID

ActivateOrderRequest

{
  "generateInvoice": true,
  "activateInvoice": true,
  "cancelOnPaymentFail": true,
  "asyncPayment": true,
  "additionalFields": {
    "property1": {},
    "property2": {}
  }
}

Properties

Name	Type	Required	Restrictions	Description
generateInvoice	boolean	false	none	Indicates if the first invoice will be generated. If activateInvoice is true, then generateInvoice is default to true. Default value is false
activateInvoice	boolean	false	none	Indicates if the first invoice will be generated and activated for payments. If activateInvoice is true, then activateOrder, generateInvoice will be all considered true, and previewInvoice will be ignored. Default value is false
cancelOnPaymentFail	boolean	false	none	Indicates if the order will be canceled when payment fails. Default value is false
asyncPayment	boolean	false	none	Indicates if the payment can be submitted asynchronously when 'activateInvoice' is true. Default value is false
additionalFields	object	false	none	Any additional fields to be added to the order before activation.
» additionalProperties	object	false	none	Any additional fields to be added to the order before activation.

ActivateOrderAndInvoiceResponse

{
  "subscriptions": [
    {
      "actualSubscriptionTerm": 0,
      "autoRenew": true,
      "billingPeriod": "string",
      "billingTiming": "string",
      "bundled": true,
      "cancellationDate": "string",
      "createdById": "string",
      "currencyIsoCode": "string",
      "customerId": "string",
      "description": "string",
      "evergreen": true,
      "externalId": "string",
      "externalName": "string",
      "id": "string",
      "includedUnits": 0,
      "lastModifiedById": "string",
      "lastVersionedSubscriptionId": "string",
      "listPrice": 0,
      "name": "string",
      "orderOnDate": "string",
      "orderProductId": "string",
      "originalSubscriptionId": "string",
      "originalSubscriptionNumber": "string",
      "parentId": "string",
      "parentObjectType": "string",
      "priceBookEntryId": "string",
      "priceBookId": "string",
      "productId": "string",
      "quantity": 0,
      "reconfigureEffectiveDate": "string",
      "renewalTerm": 0,
      "rootId": "string",
      "salesPrice": 0,
      "status": "string",
      "subscriptionCompositeId": "string",
      "subscriptionEndDate": "string",
      "subscriptionLevel": 0,
      "subscriptionStartDate": "string",
      "subscriptionTerm": 0,
      "subscriptionVersion": 0,
      "taxAmount": 0,
      "tcv": 0,
      "todayARR": 0,
      "todayCMRR": 0,
      "todaysQuantity": 0,
      "totalACV": 0,
      "totalAmount": 0,
      "totalPrice": 0,
      "totalTCV": 0,
      "uomId": "string"
    }
  ],
  "assets": [
    {
      "assetCompositeId": "string",
      "assetLevel": 0,
      "assetNumber": "string",
      "assetProvidedById": "string",
      "assetServicedById": "string",
      "assetVersion": 0,
      "billingPeriod": "string",
      "billingTiming": "string",
      "cancellationDate": "string",
      "competitorProduct": true,
      "contactId": "string",
      "createdById": "string",
      "customerId": "string",
      "description": "string",
      "externalId": "string",
      "externalName": "string",
      "id": "string",
      "installDate": "string",
      "internalAsset": true,
      "lastModifiedById": "string",
      "lastVersionedAssetId": "string",
      "listPrice": 0,
      "locationId": "string",
      "name": "string",
      "orderProductId": "string",
      "originalAssetId": "string",
      "parentAssetObject": "string",
      "parentId": "string",
      "price": 0,
      "priceBookEntryId": "string",
      "priceBookId": "string",
      "productCode": "string",
      "productDescription": "string",
      "productFamily": "string",
      "productId": "string",
      "purchaseDate": "string",
      "quantity": 0,
      "reconfigureEffectiveDate": "string",
      "rootId": "string",
      "salesPrice": 0,
      "serialNumber": "string",
      "sku": "string",
      "startDate": "string",
      "status": "string",
      "statusReason": "string",
      "taxAmount": 0,
      "tcv": 0,
      "totalAcv": 0,
      "totalAmount": 0,
      "totalPrice": 0,
      "totalTcv": 0,
      "uniqueIdentifier": "string",
      "uomId": "string",
      "usageEndDate": "string"
    }
  ],
  "entitlements": [
    {
      "billingPeriod": "string",
      "billingTime": "string",
      "cancellationDate": "string",
      "createdById": "string",
      "currencyIsoCode": "string",
      "customerId": "string",
      "description": "string",
      "endDate": "string",
      "entitlementCompositeId": "string",
      "entitlementLevel": 0,
      "entitlementNumber": "string",
      "entitlementVersion": 0,
      "externalId": "string",
      "externalName": "string",
      "id": "string",
      "lastModifiedById": "string",
      "lastVersionedEntitlementId": "string",
      "listPrice": 0,
      "name": "string",
      "netSalesPrice": 0,
      "orderNumber": "string",
      "orderOnDate": "string",
      "orderProductId": "string",
      "originalEntitlementId": "string",
      "originalEntitlementNumber": "string",
      "parentEntitlementObject": "string",
      "parentId": "string",
      "priceBookEntryId": "string",
      "priceBookId": "string",
      "productId": "string",
      "productName": "string",
      "quantity": 0,
      "quantityDimension": "string",
      "reconfigureEffectiveDate": "string",
      "rootId": "string",
      "salesPrice": 0,
      "startDate": "string",
      "status": "string",
      "taxAmount": 0,
      "tcv": 0,
      "termDimension": "string",
      "totalAcv": 0,
      "totalAmount": 0,
      "totalPrice": 0,
      "totalTcv": 0,
      "uomId": "string"
    }
  ],
  "invoices": [
    {
      "invoice": {},
      "items": [
        {}
      ]
    }
  ],
  "order": {
    "description": "string",
    "todayCMRR": 0,
    "todayARR": 0,
    "paymentMethods": "string",
    "status": "string",
    "id": "string",
    "cancelOnPaymentFail": true,
    "orderNumber": "string",
    "shippingAddress": "string",
    "shippingAddressSameAsBilling": true,
    "billingAddress": "string",
    "totalPrice": 0,
    "tax": 0,
    "totalAmount": 0,
    "paymentMethod": "string",
    "customerId": "string",
    "billingAccountId": "string",
    "priceBookId": "string",
    "cancellationDate": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "lastModifiedBy": "string",
    "lastModifiedDate": "2019-08-24T14:15:22Z",
    "createdTime": "2019-08-24T14:15:22Z",
    "subscriptionStartDate": "2019-08-24T14:15:22Z",
    "subscriptionEndDate": "2019-08-24T14:15:22Z",
    "discountPercentage": 0,
    "subscriptionTerm": 0,
    "subtotal": 0,
    "listTotal": 0,
    "ownerId": "string",
    "autoNumberFormat": "string",
    "autoNumberSequence": 0,
    "orderStartDateAsString": "string",
    "currencyIsoCode": "string",
    "billCycleDay": "string",
    "billingPeriod": "string",
    "entityUseCode": "string",
    "billToContactId": "string",
    "poDate": "2019-08-24T14:15:22Z",
    "poNumber": "string",
    "discountAmount": 0,
    "systemDiscount": 0,
    "systemDiscountAmount": 0,
    "orderType": "string",
    "orderEndDate": "2019-08-24T14:15:22Z",
    "orderStartDate": "2019-08-24T14:15:22Z",
    "orderReferenceNumber": "string",
    "opportunityId": "string",
    "orderPlacedDate": "2019-08-24T14:15:22Z",
    "orderTcv": 0,
    "orderAcv": 0,
    "shipToContactId": "string",
    "activatedBy": "string",
    "activatedDate": "2019-08-24T14:15:22Z",
    "platformOrigin": "string",
    "subscriptionTermDimension": "string",
    "name": "string",
    "empty": true,
    "property1": {},
    "property2": {}
  },
  "orderProducts": [
    {
      "description": "string",
      "status": "string",
      "parentId": "string",
      "deltaCMRR": 0,
      "actualSubscriptionTerm": 0,
      "id": "string",
      "billingTiming": "string",
      "createdDate": "2019-08-24T14:15:22Z",
      "taxAmount": 0,
      "entityId": "string",
      "isChange": true,
      "orderId": "string",
      "lineType": "string",
      "quantity": 0,
      "totalPrice": 0,
      "taxCode": "string",
      "taxMode": "string",
      "product__r": {
        "id": "string",
        "customFields": {
          "property1": {},
          "property2": {}
        },
        "name": "string",
        "sku": "string",
        "recordType": "string",
        "configurable": true,
        "soldIndependently": true,
        "status": "string",
        "bundleTemplate": "string",
        "description": "string",
        "priceModel": "string",
        "startDate": "string",
        "endDate": "string",
        "freeTrialUnit": 0,
        "freeTrialType": "string",
        "productCategory": "string",
        "autoRenew": true,
        "defaultRenewalTerm": 0,
        "defaultSubscriptionTerm": 0,
        "billingTiming": "string",
        "billingPeriod": "string",
        "showIncludedProductOptions": true,
        "publishStatus": "Unpublished",
        "lastPublishedById": "string",
        "lastPublishedDate": "string",
        "taxCode": "string",
        "taxMode": "string",
        "referenceProduct": {},
        "uom": {
          "id": "string",
          "name": "string",
          "decimalScale": 0,
          "roundingMode": "Up",
          "quantityDimension": "string",
          "termDimension": "string",
          "unitCode": "string"
        },
        "priceBook": {
          "id": "string",
          "name": "string",
          "description": "string",
          "standard": true,
          "active": true,
          "archived": true,
          "selfServiceEnabled": true,
          "priceAttributes": [
            "Currency"
          ]
        },
        "imageUrl": "string",
        "evergreen": true,
        "carvesLiabilitySegment": "string",
        "carvesRevenueSegment": "string",
        "contractLiabilitySegment": "string",
        "contractRevenueSegment": "string",
        "creditConversionId": "string",
        "creditConversion": {
          "id": "string",
          "name": "string",
          "creditTypeId": "string",
          "uomQuantityDimension": "string",
          "uomQuantity": 0,
          "creditQuantity": 0,
          "conversionRate": 0,
          "decimalScale": 0,
          "roundingMode": "string"
        },
        "priceBookEntries": [
          {
            "id": "string",
            "listPrice": 0,
            "active": true,
            "currencyIsoCode": "string",
            "recommended": true,
            "billingTiming": "string",
            "pricingAttribute_1": "string",
            "pricingAttribute_2": "string",
            "pricingAttribute_3": "string",
            "pricingAttribute_4": "string",
            "pricingAttribute_5": "string",
            "pricingAttribute_6": "string",
            "pricingAttribute_7": "string",
            "pricingAttribute_8": "string",
            "pricingAttribute_9": "string",
            "pricingAttribute_10": "string",
            "uom": {
              "id": "string",
              "name": "string",
              "decimalScale": 0,
              "roundingMode": "Up",
              "quantityDimension": "string",
              "termDimension": "string",
              "unitCode": "string"
            },
            "priceBookId": "string"
          }
        ],
        "productFeatures": [
          {
            "id": "string",
            "name": "string",
            "featureOrder": 0,
            "minOptions": 0,
            "maxOptions": 0,
            "featureName": "string",
            "featureDescription": "string",
            "feature": {
              "id": "string",
              "imageSignedUrl": "string",
              "status": "string",
              "name": "string",
              "featurePriceTags": [
                {
                  "id": "string",
                  "name": "string",
                  "serialNumber": 0,
                  "active": true,
                  "priceTag": {
                    "id": "string",
                    "name": "string",
                    "description": "string",
                    "recordType": "string",
                    "priceTagType": "string",
                    "startTime": "string",
                    "endTime": "string",
                    "priceType": "string",
                    "active": true,
                    "objectId": "string",
                    "objectType": "string",
                    "code": "string",
                    "uomDimension": "string",
                    "priceBook": {},
                    "uom": {},
                    "priceTiers": [],
                    "publishStatus": "Unpublished",
                    "lastPublishedById": "string",
                    "lastPublishedDate": "string"
                  }
                }
              ]
            },
            "productOptions": [
              {
                "id": "string",
                "name": "string",
                "optionName": "string",
                "optionOrder": 0,
                "optionType": "string",
                "defaultQuantity": 0,
                "includedQuantity": 0,
                "minQuantity": 0,
                "maxQuantity": 0,
                "quantityEditable": true,
                "required": true,
                "bundled": true,
                "recommended": true,
                "independentPricing": true,
                "priceBookEntry": {
                  "id": "string",
                  "listPrice": 0,
                  "active": true,
                  "currencyIsoCode": "string",
                  "recommended": true,
                  "billingTiming": "string",
                  "pricingAttribute_1": "string",
                  "pricingAttribute_2": "string",
                  "pricingAttribute_3": "string",
                  "pricingAttribute_4": "string",
                  "pricingAttribute_5": "string",
                  "pricingAttribute_6": "string",
                  "pricingAttribute_7": "string",
                  "pricingAttribute_8": "string",
                  "pricingAttribute_9": "string",
                  "pricingAttribute_10": "string",
                  "uom": {
                    "id": "string",
                    "name": "string",
                    "decimalScale": 0,
                    "roundingMode": "Up",
                    "quantityDimension": "string",
                    "termDimension": "string",
                    "unitCode": "string"
                  },
                  "priceBookId": "string"
                },
                "product": {},
                "productOptionPriceTags": [
                  {
                    "id": "string",
                    "name": "string",
                    "serialNumber": 0,
                    "active": true,
                    "priceTag": {}
                  }
                ]
              }
            ]
          }
        ],
        "productOptions": [
          {
            "id": "string",
            "name": "string",
            "optionName": "string",
            "optionOrder": 0,
            "optionType": "string",
            "defaultQuantity": 0,
            "includedQuantity": 0,
            "minQuantity": 0,
            "maxQuantity": 0,
            "quantityEditable": true,
            "required": true,
            "bundled": true,
            "recommended": true,
            "independentPricing": true,
            "priceBookEntry": {
              "id": "string",
              "listPrice": 0,
              "active": true,
              "currencyIsoCode": "string",
              "recommended": true,
              "billingTiming": "string",
              "pricingAttribute_1": "string",
              "pricingAttribute_2": "string",
              "pricingAttribute_3": "string",
              "pricingAttribute_4": "string",
              "pricingAttribute_5": "string",
              "pricingAttribute_6": "string",
              "pricingAttribute_7": "string",
              "pricingAttribute_8": "string",
              "pricingAttribute_9": "string",
              "pricingAttribute_10": "string",
              "uom": {
                "id": "string",
                "name": "string",
                "decimalScale": 0,
                "roundingMode": "Up",
                "quantityDimension": "string",
                "termDimension": "string",
                "unitCode": "string"
              },
              "priceBookId": "string"
            },
            "product": {},
            "productOptionPriceTags": [
              {
                "id": "string",
                "name": "string",
                "serialNumber": 0,
                "active": true,
                "priceTag": {
                  "id": "string",
                  "name": "string",
                  "description": "string",
                  "recordType": "string",
                  "priceTagType": "string",
                  "startTime": "string",
                  "endTime": "string",
                  "priceType": "string",
                  "active": true,
                  "objectId": "string",
                  "objectType": "string",
                  "code": "string",
                  "uomDimension": "string",
                  "priceBook": {
                    "id": "string",
                    "name": "string",
                    "description": "string",
                    "standard": true,
                    "active": true,
                    "archived": true,
                    "selfServiceEnabled": true,
                    "priceAttributes": []
                  },
                  "uom": {
                    "id": "string",
                    "name": "string",
                    "decimalScale": 0,
                    "roundingMode": "Up",
                    "quantityDimension": "string",
                    "termDimension": "string",
                    "unitCode": "string"
                  },
                  "priceTiers": [
                    {}
                  ],
                  "publishStatus": "Unpublished",
                  "lastPublishedById": "string",
                  "lastPublishedDate": "string"
                }
              }
            ]
          }
        ],
        "productPriceTags": [
          {
            "id": "string",
            "name": "string",
            "serialNumber": 0,
            "active": true,
            "priceBookEntry": {
              "id": "string",
              "listPrice": 0,
              "active": true,
              "currencyIsoCode": "string",
              "recommended": true,
              "billingTiming": "string",
              "pricingAttribute_1": "string",
              "pricingAttribute_2": "string",
              "pricingAttribute_3": "string",
              "pricingAttribute_4": "string",
              "pricingAttribute_5": "string",
              "pricingAttribute_6": "string",
              "pricingAttribute_7": "string",
              "pricingAttribute_8": "string",
              "pricingAttribute_9": "string",
              "pricingAttribute_10": "string",
              "uom": {
                "id": "string",
                "name": "string",
                "decimalScale": 0,
                "roundingMode": "Up",
                "quantityDimension": "string",
                "termDimension": "string",
                "unitCode": "string"
              },
              "priceBookId": "string"
            },
            "priceTag": {
              "id": "string",
              "name": "string",
              "description": "string",
              "recordType": "string",
              "priceTagType": "string",
              "startTime": "string",
              "endTime": "string",
              "priceType": "string",
              "active": true,
              "objectId": "string",
              "objectType": "string",
              "code": "string",
              "uomDimension": "string",
              "priceBook": {
                "id": "string",
                "name": "string",
                "description": "string",
                "standard": true,
                "active": true,
                "archived": true,
                "selfServiceEnabled": true,
                "priceAttributes": [
                  "Currency"
                ]
              },
              "uom": {
                "id": "string",
                "name": "string",
                "decimalScale": 0,
                "roundingMode": "Up",
                "quantityDimension": "string",
                "termDimension": "string",
                "unitCode": "string"
              },
              "priceTiers": [
                {
                  "id": "string",
                  "name": "string",
                  "amount": 0,
                  "chargeModel": "string",
                  "discountPercentage": 0,
                  "endUnit": 0,
                  "endUnitDimension": "string",
                  "startUnit": 0,
                  "startUnitDimension": "string",
                  "tierNumber": 0
                }
              ],
              "publishStatus": "Unpublished",
              "lastPublishedById": "string",
              "lastPublishedDate": "string"
            }
          }
        ],
        "carvesEligible": true
      },
      "totalAmount": 0,
      "summaryItemId": "string",
      "customerId": "string",
      "billingAccountId": "string",
      "cancellationDate": "2019-08-24T14:15:22Z",
      "sortOrder": 0,
      "createdBy": "string",
      "lastModifiedBy": "string",
      "lastModifiedDate": "2019-08-24T14:15:22Z",
      "subscriptionStartDate": "string",
      "subscriptionEndDate": "string",
      "productId": "string",
      "priceBookEntryId": "string",
      "subscriptionTerm": 0,
      "subtotal": 0,
      "netSalesPrice": 0,
      "listTotalPrice": 0,
      "actualQuantity": 0,
      "changeType": "string",
      "uomId": "string",
      "listPrice": 0,
      "evergreen": true,
      "productOptionId": "string",
      "productOptionQuantity": 0,
      "includedUnits": 0,
      "sku": "string",
      "productName": "string",
      "autoNumberFormat": "string",
      "autoNumberSequence": 0,
      "order__r": {
        "description": "string",
        "todayCMRR": 0,
        "todayARR": 0,
        "paymentMethods": "string",
        "status": "string",
        "id": "string",
        "cancelOnPaymentFail": true,
        "orderNumber": "string",
        "shippingAddress": "string",
        "shippingAddressSameAsBilling": true,
        "billingAddress": "string",
        "totalPrice": 0,
        "tax": 0,
        "totalAmount": 0,
        "paymentMethod": "string",
        "customerId": "string",
        "billingAccountId": "string",
        "priceBookId": "string",
        "cancellationDate": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "lastModifiedBy": "string",
        "lastModifiedDate": "2019-08-24T14:15:22Z",
        "createdTime": "2019-08-24T14:15:22Z",
        "subscriptionStartDate": "2019-08-24T14:15:22Z",
        "subscriptionEndDate": "2019-08-24T14:15:22Z",
        "discountPercentage": 0,
        "subscriptionTerm": 0,
        "subtotal": 0,
        "listTotal": 0,
        "ownerId": "string",
        "autoNumberFormat": "string",
        "autoNumberSequence": 0,
        "orderStartDateAsString": "string",
        "currencyIsoCode": "string",
        "billCycleDay": "string",
        "billingPeriod": "string",
        "entityUseCode": "string",
        "billToContactId": "string",
        "poDate": "2019-08-24T14:15:22Z",
        "poNumber": "string",
        "discountAmount": 0,
        "systemDiscount": 0,
        "systemDiscountAmount": 0,
        "orderType": "string",
        "orderEndDate": "2019-08-24T14:15:22Z",
        "orderStartDate": "2019-08-24T14:15:22Z",
        "orderReferenceNumber": "string",
        "opportunityId": "string",
        "orderPlacedDate": "2019-08-24T14:15:22Z",
        "orderTcv": 0,
        "orderAcv": 0,
        "shipToContactId": "string",
        "activatedBy": "string",
        "activatedDate": "2019-08-24T14:15:22Z",
        "platformOrigin": "string",
        "subscriptionTermDimension": "string",
        "name": "string",
        "empty": true,
        "property1": {},
        "property2": {}
      },
      "autoRenew": true,
      "currencyIsoCode": "string",
      "billCycleStartMonth": "string",
      "billCycleDay": "string",
      "billingPeriod": "string",
      "rootId": "string",
      "entityUseCode": "string",
      "deltaACV": 0,
      "discount": 0,
      "poDate": "string",
      "poNumber": "string",
      "freeTrialConversionDate": "2019-08-24T14:15:22Z",
      "discountAmount": 0,
      "systemDiscount": 0,
      "systemDiscountAmount": 0,
      "deltaTCV": 0,
      "salesPrice": 0,
      "deltaARR": 0,
      "changeAssetId": "string",
      "reconfigureEffectiveDate": "2019-08-24T14:15:22Z",
      "defaultRenewalTerm": 0,
      "changeReferenceOrderProductId": "string",
      "contractLiabilitySegment": "string",
      "contractRevenueSegment": "string",
      "carvesLiabilitySegment": "string",
      "carvesRevenueSegment": "string",
      "changeAssetType": "string",
      "revenueContractId": "string",
      "carvesEligible": true,
      "name": "string",
      "empty": true,
      "property1": {},
      "property2": {}
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
subscriptions	[SubscriptionCreatedDto]	false	none	Subscriptions created.
assets	[AssetCreatedDto]	false	none	Assets created.
entitlements	[EntitlementCreatedDto]	false	none	Entitlements created.
invoices	[InvoiceModelWithItems]	false	none	Invoices created.
order	object	false	none	Order activated.
» additionalProperties	object	false	none	Order activated.
» description	string	false	none	none
» todayCMRR	number	false	none	none
» todayARR	number	false	none	none
» paymentMethods	string	false	none	none
» status	string	false	none	none
» id	string	false	none	none
» cancelOnPaymentFail	boolean	false	none	none
» orderNumber	string	false	none	none
» shippingAddress	string	false	none	none
» shippingAddressSameAsBilling	boolean	false	none	none
» billingAddress	string	false	none	none
» totalPrice	number	false	none	none
» tax	number	false	none	none
» totalAmount	number	false	none	none
» paymentMethod	string	false	none	none
» customerId	string	false	none	none
» billingAccountId	string	false	none	none
» priceBookId	string	false	none	none
» cancellationDate	string(date-time)	false	none	none
» createdBy	string	false	none	none
» lastModifiedBy	string	false	none	none
» lastModifiedDate	string(date-time)	false	none	none
» createdTime	string(date-time)	false	none	none
» subscriptionStartDate	string(date-time)	false	none	none
» subscriptionEndDate	string(date-time)	false	none	none
» discountPercentage	number	false	none	none
» subscriptionTerm	number	false	none	none
» subtotal	number	false	none	none
» listTotal	number	false	none	none
» ownerId	string	false	none	none
» autoNumberFormat	string	false	none	none
» autoNumberSequence	integer(int64)	false	none	none
» orderStartDateAsString	string	false	none	none
» currencyIsoCode	string	false	none	none
» billCycleDay	string	false	none	none
» billingPeriod	string	false	none	none
» entityUseCode	string	false	none	none
» billToContactId	string	false	none	none
» poDate	string(date-time)	false	none	none
» poNumber	string	false	none	none
» discountAmount	number	false	none	none
» systemDiscount	number	false	none	none
» systemDiscountAmount	number	false	none	none
» orderType	string	false	none	none
» orderEndDate	string(date-time)	false	none	none
» orderStartDate	string(date-time)	false	none	none
» orderReferenceNumber	string	false	none	none
» opportunityId	string	false	none	none
» orderPlacedDate	string(date-time)	false	none	none
» orderTcv	number	false	none	none
» orderAcv	number	false	none	none
» shipToContactId	string	false	none	none
» activatedBy	string	false	none	none
» activatedDate	string(date-time)	false	none	none
» platformOrigin	string	false	none	none
» subscriptionTermDimension	string	false	none	none
» name	string	false	none	none
» empty	boolean	false	none	none
orderProducts	[OrderProductModel]	false	none	Order product activated.

CreditConversion

{
  "id": "string",
  "name": "string",
  "creditTypeId": "string",
  "uomQuantityDimension": "string",
  "uomQuantity": 0,
  "creditQuantity": 0,
  "conversionRate": 0,
  "decimalScale": 0,
  "roundingMode": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
name	string	false	none	none
creditTypeId	string	false	none	none
uomQuantityDimension	string	false	none	none
uomQuantity	number	false	none	none
creditQuantity	number	false	none	none
conversionRate	number	false	none	none
decimalScale	integer(int32)	false	none	none
roundingMode	string	false	none	none

Feature

{
  "id": "string",
  "imageSignedUrl": "string",
  "status": "string",
  "name": "string",
  "featurePriceTags": [
    {
      "id": "string",
      "name": "string",
      "serialNumber": 0,
      "active": true,
      "priceTag": {
        "id": "string",
        "name": "string",
        "description": "string",
        "recordType": "string",
        "priceTagType": "string",
        "startTime": "string",
        "endTime": "string",
        "priceType": "string",
        "active": true,
        "objectId": "string",
        "objectType": "string",
        "code": "string",
        "uomDimension": "string",
        "priceBook": {
          "id": "string",
          "name": "string",
          "description": "string",
          "standard": true,
          "active": true,
          "archived": true,
          "selfServiceEnabled": true,
          "priceAttributes": [
            "Currency"
          ]
        },
        "uom": {
          "id": "string",
          "name": "string",
          "decimalScale": 0,
          "roundingMode": "Up",
          "quantityDimension": "string",
          "termDimension": "string",
          "unitCode": "string"
        },
        "priceTiers": [
          {
            "id": "string",
            "name": "string",
            "amount": 0,
            "chargeModel": "string",
            "discountPercentage": 0,
            "endUnit": 0,
            "endUnitDimension": "string",
            "startUnit": 0,
            "startUnitDimension": "string",
            "tierNumber": 0
          }
        ],
        "publishStatus": "Unpublished",
        "lastPublishedById": "string",
        "lastPublishedDate": "string"
      }
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
imageSignedUrl	string	false	none	none
status	string	false	none	none
name	string	false	none	none
featurePriceTags	[FeaturePriceDimension]	false	none	none

FeaturePriceDimension

{
  "id": "string",
  "name": "string",
  "serialNumber": 0,
  "active": true,
  "priceTag": {
    "id": "string",
    "name": "string",
    "description": "string",
    "recordType": "string",
    "priceTagType": "string",
    "startTime": "string",
    "endTime": "string",
    "priceType": "string",
    "active": true,
    "objectId": "string",
    "objectType": "string",
    "code": "string",
    "uomDimension": "string",
    "priceBook": {
      "id": "string",
      "name": "string",
      "description": "string",
      "standard": true,
      "active": true,
      "archived": true,
      "selfServiceEnabled": true,
      "priceAttributes": [
        "Currency"
      ]
    },
    "uom": {
      "id": "string",
      "name": "string",
      "decimalScale": 0,
      "roundingMode": "Up",
      "quantityDimension": "string",
      "termDimension": "string",
      "unitCode": "string"
    },
    "priceTiers": [
      {
        "id": "string",
        "name": "string",
        "amount": 0,
        "chargeModel": "string",
        "discountPercentage": 0,
        "endUnit": 0,
        "endUnitDimension": "string",
        "startUnit": 0,
        "startUnitDimension": "string",
        "tierNumber": 0
      }
    ],
    "publishStatus": "Unpublished",
    "lastPublishedById": "string",
    "lastPublishedDate": "string"
  }
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
name	string	false	none	none
serialNumber	integer(int32)	false	none	none
active	boolean	false	none	none
priceTag	PriceDimension	false	none	none

OrderProductModel

{
  "description": "string",
  "status": "string",
  "parentId": "string",
  "deltaCMRR": 0,
  "actualSubscriptionTerm": 0,
  "id": "string",
  "billingTiming": "string",
  "createdDate": "2019-08-24T14:15:22Z",
  "taxAmount": 0,
  "entityId": "string",
  "isChange": true,
  "orderId": "string",
  "lineType": "string",
  "quantity": 0,
  "totalPrice": 0,
  "taxCode": "string",
  "taxMode": "string",
  "product__r": {
    "id": "string",
    "customFields": {
      "property1": {},
      "property2": {}
    },
    "name": "string",
    "sku": "string",
    "recordType": "string",
    "configurable": true,
    "soldIndependently": true,
    "status": "string",
    "bundleTemplate": "string",
    "description": "string",
    "priceModel": "string",
    "startDate": "string",
    "endDate": "string",
    "freeTrialUnit": 0,
    "freeTrialType": "string",
    "productCategory": "string",
    "autoRenew": true,
    "defaultRenewalTerm": 0,
    "defaultSubscriptionTerm": 0,
    "billingTiming": "string",
    "billingPeriod": "string",
    "showIncludedProductOptions": true,
    "publishStatus": "Unpublished",
    "lastPublishedById": "string",
    "lastPublishedDate": "string",
    "taxCode": "string",
    "taxMode": "string",
    "referenceProduct": {},
    "uom": {
      "id": "string",
      "name": "string",
      "decimalScale": 0,
      "roundingMode": "Up",
      "quantityDimension": "string",
      "termDimension": "string",
      "unitCode": "string"
    },
    "priceBook": {
      "id": "string",
      "name": "string",
      "description": "string",
      "standard": true,
      "active": true,
      "archived": true,
      "selfServiceEnabled": true,
      "priceAttributes": [
        "Currency"
      ]
    },
    "imageUrl": "string",
    "evergreen": true,
    "carvesLiabilitySegment": "string",
    "carvesRevenueSegment": "string",
    "contractLiabilitySegment": "string",
    "contractRevenueSegment": "string",
    "creditConversionId": "string",
    "creditConversion": {
      "id": "string",
      "name": "string",
      "creditTypeId": "string",
      "uomQuantityDimension": "string",
      "uomQuantity": 0,
      "creditQuantity": 0,
      "conversionRate": 0,
      "decimalScale": 0,
      "roundingMode": "string"
    },
    "priceBookEntries": [
      {
        "id": "string",
        "listPrice": 0,
        "active": true,
        "currencyIsoCode": "string",
        "recommended": true,
        "billingTiming": "string",
        "pricingAttribute_1": "string",
        "pricingAttribute_2": "string",
        "pricingAttribute_3": "string",
        "pricingAttribute_4": "string",
        "pricingAttribute_5": "string",
        "pricingAttribute_6": "string",
        "pricingAttribute_7": "string",
        "pricingAttribute_8": "string",
        "pricingAttribute_9": "string",
        "pricingAttribute_10": "string",
        "uom": {
          "id": "string",
          "name": "string",
          "decimalScale": 0,
          "roundingMode": "Up",
          "quantityDimension": "string",
          "termDimension": "string",
          "unitCode": "string"
        },
        "priceBookId": "string"
      }
    ],
    "productFeatures": [
      {
        "id": "string",
        "name": "string",
        "featureOrder": 0,
        "minOptions": 0,
        "maxOptions": 0,
        "featureName": "string",
        "featureDescription": "string",
        "feature": {
          "id": "string",
          "imageSignedUrl": "string",
          "status": "string",
          "name": "string",
          "featurePriceTags": [
            {
              "id": "string",
              "name": "string",
              "serialNumber": 0,
              "active": true,
              "priceTag": {
                "id": "string",
                "name": "string",
                "description": "string",
                "recordType": "string",
                "priceTagType": "string",
                "startTime": "string",
                "endTime": "string",
                "priceType": "string",
                "active": true,
                "objectId": "string",
                "objectType": "string",
                "code": "string",
                "uomDimension": "string",
                "priceBook": {
                  "id": "string",
                  "name": "string",
                  "description": "string",
                  "standard": true,
                  "active": true,
                  "archived": true,
                  "selfServiceEnabled": true,
                  "priceAttributes": [
                    "Currency"
                  ]
                },
                "uom": {
                  "id": "string",
                  "name": "string",
                  "decimalScale": 0,
                  "roundingMode": "Up",
                  "quantityDimension": "string",
                  "termDimension": "string",
                  "unitCode": "string"
                },
                "priceTiers": [
                  {
                    "id": "string",
                    "name": "string",
                    "amount": 0,
                    "chargeModel": "string",
                    "discountPercentage": 0,
                    "endUnit": 0,
                    "endUnitDimension": "string",
                    "startUnit": 0,
                    "startUnitDimension": "string",
                    "tierNumber": 0
                  }
                ],
                "publishStatus": "Unpublished",
                "lastPublishedById": "string",
                "lastPublishedDate": "string"
              }
            }
          ]
        },
        "productOptions": [
          {
            "id": "string",
            "name": "string",
            "optionName": "string",
            "optionOrder": 0,
            "optionType": "string",
            "defaultQuantity": 0,
            "includedQuantity": 0,
            "minQuantity": 0,
            "maxQuantity": 0,
            "quantityEditable": true,
            "required": true,
            "bundled": true,
            "recommended": true,
            "independentPricing": true,
            "priceBookEntry": {
              "id": "string",
              "listPrice": 0,
              "active": true,
              "currencyIsoCode": "string",
              "recommended": true,
              "billingTiming": "string",
              "pricingAttribute_1": "string",
              "pricingAttribute_2": "string",
              "pricingAttribute_3": "string",
              "pricingAttribute_4": "string",
              "pricingAttribute_5": "string",
              "pricingAttribute_6": "string",
              "pricingAttribute_7": "string",
              "pricingAttribute_8": "string",
              "pricingAttribute_9": "string",
              "pricingAttribute_10": "string",
              "uom": {
                "id": "string",
                "name": "string",
                "decimalScale": 0,
                "roundingMode": "Up",
                "quantityDimension": "string",
                "termDimension": "string",
                "unitCode": "string"
              },
              "priceBookId": "string"
            },
            "product": {},
            "productOptionPriceTags": [
              {
                "id": "string",
                "name": "string",
                "serialNumber": 0,
                "active": true,
                "priceTag": {
                  "id": "string",
                  "name": "string",
                  "description": "string",
                  "recordType": "string",
                  "priceTagType": "string",
                  "startTime": "string",
                  "endTime": "string",
                  "priceType": "string",
                  "active": true,
                  "objectId": "string",
                  "objectType": "string",
                  "code": "string",
                  "uomDimension": "string",
                  "priceBook": {
                    "id": "string",
                    "name": "string",
                    "description": "string",
                    "standard": true,
                    "active": true,
                    "archived": true,
                    "selfServiceEnabled": true,
                    "priceAttributes": []
                  },
                  "uom": {
                    "id": "string",
                    "name": "string",
                    "decimalScale": 0,
                    "roundingMode": "Up",
                    "quantityDimension": "string",
                    "termDimension": "string",
                    "unitCode": "string"
                  },
                  "priceTiers": [
                    {}
                  ],
                  "publishStatus": "Unpublished",
                  "lastPublishedById": "string",
                  "lastPublishedDate": "string"
                }
              }
            ]
          }
        ]
      }
    ],
    "productOptions": [
      {
        "id": "string",
        "name": "string",
        "optionName": "string",
        "optionOrder": 0,
        "optionType": "string",
        "defaultQuantity": 0,
        "includedQuantity": 0,
        "minQuantity": 0,
        "maxQuantity": 0,
        "quantityEditable": true,
        "required": true,
        "bundled": true,
        "recommended": true,
        "independentPricing": true,
        "priceBookEntry": {
          "id": "string",
          "listPrice": 0,
          "active": true,
          "currencyIsoCode": "string",
          "recommended": true,
          "billingTiming": "string",
          "pricingAttribute_1": "string",
          "pricingAttribute_2": "string",
          "pricingAttribute_3": "string",
          "pricingAttribute_4": "string",
          "pricingAttribute_5": "string",
          "pricingAttribute_6": "string",
          "pricingAttribute_7": "string",
          "pricingAttribute_8": "string",
          "pricingAttribute_9": "string",
          "pricingAttribute_10": "string",
          "uom": {
            "id": "string",
            "name": "string",
            "decimalScale": 0,
            "roundingMode": "Up",
            "quantityDimension": "string",
            "termDimension": "string",
            "unitCode": "string"
          },
          "priceBookId": "string"
        },
        "product": {},
        "productOptionPriceTags": [
          {
            "id": "string",
            "name": "string",
            "serialNumber": 0,
            "active": true,
            "priceTag": {
              "id": "string",
              "name": "string",
              "description": "string",
              "recordType": "string",
              "priceTagType": "string",
              "startTime": "string",
              "endTime": "string",
              "priceType": "string",
              "active": true,
              "objectId": "string",
              "objectType": "string",
              "code": "string",
              "uomDimension": "string",
              "priceBook": {
                "id": "string",
                "name": "string",
                "description": "string",
                "standard": true,
                "active": true,
                "archived": true,
                "selfServiceEnabled": true,
                "priceAttributes": [
                  "Currency"
                ]
              },
              "uom": {
                "id": "string",
                "name": "string",
                "decimalScale": 0,
                "roundingMode": "Up",
                "quantityDimension": "string",
                "termDimension": "string",
                "unitCode": "string"
              },
              "priceTiers": [
                {
                  "id": "string",
                  "name": "string",
                  "amount": 0,
                  "chargeModel": "string",
                  "discountPercentage": 0,
                  "endUnit": 0,
                  "endUnitDimension": "string",
                  "startUnit": 0,
                  "startUnitDimension": "string",
                  "tierNumber": 0
                }
              ],
              "publishStatus": "Unpublished",
              "lastPublishedById": "string",
              "lastPublishedDate": "string"
            }
          }
        ]
      }
    ],
    "productPriceTags": [
      {
        "id": "string",
        "name": "string",
        "serialNumber": 0,
        "active": true,
        "priceBookEntry": {
          "id": "string",
          "listPrice": 0,
          "active": true,
          "currencyIsoCode": "string",
          "recommended": true,
          "billingTiming": "string",
          "pricingAttribute_1": "string",
          "pricingAttribute_2": "string",
          "pricingAttribute_3": "string",
          "pricingAttribute_4": "string",
          "pricingAttribute_5": "string",
          "pricingAttribute_6": "string",
          "pricingAttribute_7": "string",
          "pricingAttribute_8": "string",
          "pricingAttribute_9": "string",
          "pricingAttribute_10": "string",
          "uom": {
            "id": "string",
            "name": "string",
            "decimalScale": 0,
            "roundingMode": "Up",
            "quantityDimension": "string",
            "termDimension": "string",
            "unitCode": "string"
          },
          "priceBookId": "string"
        },
        "priceTag": {
          "id": "string",
          "name": "string",
          "description": "string",
          "recordType": "string",
          "priceTagType": "string",
          "startTime": "string",
          "endTime": "string",
          "priceType": "string",
          "active": true,
          "objectId": "string",
          "objectType": "string",
          "code": "string",
          "uomDimension": "string",
          "priceBook": {
            "id": "string",
            "name": "string",
            "description": "string",
            "standard": true,
            "active": true,
            "archived": true,
            "selfServiceEnabled": true,
            "priceAttributes": [
              "Currency"
            ]
          },
          "uom": {
            "id": "string",
            "name": "string",
            "decimalScale": 0,
            "roundingMode": "Up",
            "quantityDimension": "string",
            "termDimension": "string",
            "unitCode": "string"
          },
          "priceTiers": [
            {
              "id": "string",
              "name": "string",
              "amount": 0,
              "chargeModel": "string",
              "discountPercentage": 0,
              "endUnit": 0,
              "endUnitDimension": "string",
              "startUnit": 0,
              "startUnitDimension": "string",
              "tierNumber": 0
            }
          ],
          "publishStatus": "Unpublished",
          "lastPublishedById": "string",
          "lastPublishedDate": "string"
        }
      }
    ],
    "carvesEligible": true
  },
  "totalAmount": 0,
  "summaryItemId": "string",
  "customerId": "string",
  "billingAccountId": "string",
  "cancellationDate": "2019-08-24T14:15:22Z",
  "sortOrder": 0,
  "createdBy": "string",
  "lastModifiedBy": "string",
  "lastModifiedDate": "2019-08-24T14:15:22Z",
  "subscriptionStartDate": "string",
  "subscriptionEndDate": "string",
  "productId": "string",
  "priceBookEntryId": "string",
  "subscriptionTerm": 0,
  "subtotal": 0,
  "netSalesPrice": 0,
  "listTotalPrice": 0,
  "actualQuantity": 0,
  "changeType": "string",
  "uomId": "string",
  "listPrice": 0,
  "evergreen": true,
  "productOptionId": "string",
  "productOptionQuantity": 0,
  "includedUnits": 0,
  "sku": "string",
  "productName": "string",
  "autoNumberFormat": "string",
  "autoNumberSequence": 0,
  "order__r": {
    "description": "string",
    "todayCMRR": 0,
    "todayARR": 0,
    "paymentMethods": "string",
    "status": "string",
    "id": "string",
    "cancelOnPaymentFail": true,
    "orderNumber": "string",
    "shippingAddress": "string",
    "shippingAddressSameAsBilling": true,
    "billingAddress": "string",
    "totalPrice": 0,
    "tax": 0,
    "totalAmount": 0,
    "paymentMethod": "string",
    "customerId": "string",
    "billingAccountId": "string",
    "priceBookId": "string",
    "cancellationDate": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "lastModifiedBy": "string",
    "lastModifiedDate": "2019-08-24T14:15:22Z",
    "createdTime": "2019-08-24T14:15:22Z",
    "subscriptionStartDate": "2019-08-24T14:15:22Z",
    "subscriptionEndDate": "2019-08-24T14:15:22Z",
    "discountPercentage": 0,
    "subscriptionTerm": 0,
    "subtotal": 0,
    "listTotal": 0,
    "ownerId": "string",
    "autoNumberFormat": "string",
    "autoNumberSequence": 0,
    "orderStartDateAsString": "string",
    "currencyIsoCode": "string",
    "billCycleDay": "string",
    "billingPeriod": "string",
    "entityUseCode": "string",
    "billToContactId": "string",
    "poDate": "2019-08-24T14:15:22Z",
    "poNumber": "string",
    "discountAmount": 0,
    "systemDiscount": 0,
    "systemDiscountAmount": 0,
    "orderType": "string",
    "orderEndDate": "2019-08-24T14:15:22Z",
    "orderStartDate": "2019-08-24T14:15:22Z",
    "orderReferenceNumber": "string",
    "opportunityId": "string",
    "orderPlacedDate": "2019-08-24T14:15:22Z",
    "orderTcv": 0,
    "orderAcv": 0,
    "shipToContactId": "string",
    "activatedBy": "string",
    "activatedDate": "2019-08-24T14:15:22Z",
    "platformOrigin": "string",
    "subscriptionTermDimension": "string",
    "name": "string",
    "empty": true,
    "property1": {},
    "property2": {}
  },
  "autoRenew": true,
  "currencyIsoCode": "string",
  "billCycleStartMonth": "string",
  "billCycleDay": "string",
  "billingPeriod": "string",
  "rootId": "string",
  "entityUseCode": "string",
  "deltaACV": 0,
  "discount": 0,
  "poDate": "string",
  "poNumber": "string",
  "freeTrialConversionDate": "2019-08-24T14:15:22Z",
  "discountAmount": 0,
  "systemDiscount": 0,
  "systemDiscountAmount": 0,
  "deltaTCV": 0,
  "salesPrice": 0,
  "deltaARR": 0,
  "changeAssetId": "string",
  "reconfigureEffectiveDate": "2019-08-24T14:15:22Z",
  "defaultRenewalTerm": 0,
  "changeReferenceOrderProductId": "string",
  "contractLiabilitySegment": "string",
  "contractRevenueSegment": "string",
  "carvesLiabilitySegment": "string",
  "carvesRevenueSegment": "string",
  "changeAssetType": "string",
  "revenueContractId": "string",
  "carvesEligible": true,
  "name": "string",
  "empty": true,
  "property1": {},
  "property2": {}
}

Order product activated.

Properties

Name	Type	Required	Restrictions	Description
additionalProperties	object	false	none	Order product activated.
description	string	false	none	none
status	string	false	none	none
parentId	string	false	none	none
deltaCMRR	number	false	none	none
actualSubscriptionTerm	number	false	none	none
id	string	false	none	none
billingTiming	string	false	none	none
createdDate	string(date-time)	false	none	none
taxAmount	number	false	none	none
entityId	string	false	none	none
isChange	boolean	false	none	none
orderId	string	false	none	none
lineType	string	false	none	none
quantity	number	false	none	none
totalPrice	number	false	none	none
taxCode	string	false	none	none
taxMode	string	false	none	none
product__r	Product	false	none	none
totalAmount	number	false	none	none
summaryItemId	string	false	none	none
customerId	string	false	none	none
billingAccountId	string	false	none	none
cancellationDate	string(date-time)	false	none	none
sortOrder	integer(int32)	false	none	none
createdBy	string	false	none	none
lastModifiedBy	string	false	none	none
lastModifiedDate	string(date-time)	false	none	none
subscriptionStartDate	string	false	none	none
subscriptionEndDate	string	false	none	none
productId	string	false	none	none
priceBookEntryId	string	false	none	none
subscriptionTerm	number	false	none	none
subtotal	number	false	none	none
netSalesPrice	number	false	none	none
listTotalPrice	number	false	none	none
actualQuantity	number	false	none	none
changeType	string	false	none	none
uomId	string	false	none	none
listPrice	number	false	none	none
evergreen	boolean	false	none	none
productOptionId	string	false	none	none
productOptionQuantity	number	false	none	none
includedUnits	number	false	none	none
sku	string	false	none	none
productName	string	false	none	none
autoNumberFormat	string	false	none	none
autoNumberSequence	integer(int64)	false	none	none
order__r	object	false	none	none
» additionalProperties	object	false	none	none
» description	string	false	none	none
» todayCMRR	number	false	none	none
» todayARR	number	false	none	none
» paymentMethods	string	false	none	none
» status	string	false	none	none
» id	string	false	none	none
» cancelOnPaymentFail	boolean	false	none	none
» orderNumber	string	false	none	none
» shippingAddress	string	false	none	none
» shippingAddressSameAsBilling	boolean	false	none	none
» billingAddress	string	false	none	none
» totalPrice	number	false	none	none
» tax	number	false	none	none
» totalAmount	number	false	none	none
» paymentMethod	string	false	none	none
» customerId	string	false	none	none
» billingAccountId	string	false	none	none
» priceBookId	string	false	none	none
» cancellationDate	string(date-time)	false	none	none
» createdBy	string	false	none	none
» lastModifiedBy	string	false	none	none
» lastModifiedDate	string(date-time)	false	none	none
» createdTime	string(date-time)	false	none	none
» subscriptionStartDate	string(date-time)	false	none	none
» subscriptionEndDate	string(date-time)	false	none	none
» discountPercentage	number	false	none	none
» subscriptionTerm	number	false	none	none
» subtotal	number	false	none	none
» listTotal	number	false	none	none
» ownerId	string	false	none	none
» autoNumberFormat	string	false	none	none
» autoNumberSequence	integer(int64)	false	none	none
» orderStartDateAsString	string	false	none	none
» currencyIsoCode	string	false	none	none
» billCycleDay	string	false	none	none
» billingPeriod	string	false	none	none
» entityUseCode	string	false	none	none
» billToContactId	string	false	none	none
» poDate	string(date-time)	false	none	none
» poNumber	string	false	none	none
» discountAmount	number	false	none	none
» systemDiscount	number	false	none	none
» systemDiscountAmount	number	false	none	none
» orderType	string	false	none	none
» orderEndDate	string(date-time)	false	none	none
» orderStartDate	string(date-time)	false	none	none
» orderReferenceNumber	string	false	none	none
» opportunityId	string	false	none	none
» orderPlacedDate	string(date-time)	false	none	none
» orderTcv	number	false	none	none
» orderAcv	number	false	none	none
» shipToContactId	string	false	none	none
» activatedBy	string	false	none	none
» activatedDate	string(date-time)	false	none	none
» platformOrigin	string	false	none	none
» subscriptionTermDimension	string	false	none	none
» name	string	false	none	none
» empty	boolean	false	none	none
autoRenew	boolean	false	none	none
currencyIsoCode	string	false	none	none
billCycleStartMonth	string	false	none	none
billCycleDay	string	false	none	none
billingPeriod	string	false	none	none
rootId	string	false	none	none
entityUseCode	string	false	none	none
deltaACV	number	false	none	none
discount	number	false	none	none
poDate	string	false	none	none
poNumber	string	false	none	none
freeTrialConversionDate	string(date-time)	false	none	none
discountAmount	number	false	none	none
systemDiscount	number	false	none	none
systemDiscountAmount	number	false	none	none
deltaTCV	number	false	none	none
salesPrice	number	false	none	none
deltaARR	number	false	none	none
changeAssetId	string	false	none	none
reconfigureEffectiveDate	string(date-time)	false	none	none
defaultRenewalTerm	number	false	none	none
changeReferenceOrderProductId	string	false	none	none
contractLiabilitySegment	string	false	none	none
contractRevenueSegment	string	false	none	none
carvesLiabilitySegment	string	false	none	none
carvesRevenueSegment	string	false	none	none
changeAssetType	string	false	none	none
revenueContractId	string	false	none	none
carvesEligible	boolean	false	none	none
name	string	false	none	none
empty	boolean	false	none	none

PriceBook

{
  "id": "string",
  "name": "string",
  "description": "string",
  "standard": true,
  "active": true,
  "archived": true,
  "selfServiceEnabled": true,
  "priceAttributes": [
    "Currency"
  ]
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
name	string	false	none	none
description	string	false	none	none
standard	boolean	false	none	none
active	boolean	false	none	none
archived	boolean	false	none	none
selfServiceEnabled	boolean	false	none	none
priceAttributes	[string]	false	none	none

PriceBookEntry

{
  "id": "string",
  "listPrice": 0,
  "active": true,
  "currencyIsoCode": "string",
  "recommended": true,
  "billingTiming": "string",
  "pricingAttribute_1": "string",
  "pricingAttribute_2": "string",
  "pricingAttribute_3": "string",
  "pricingAttribute_4": "string",
  "pricingAttribute_5": "string",
  "pricingAttribute_6": "string",
  "pricingAttribute_7": "string",
  "pricingAttribute_8": "string",
  "pricingAttribute_9": "string",
  "pricingAttribute_10": "string",
  "uom": {
    "id": "string",
    "name": "string",
    "decimalScale": 0,
    "roundingMode": "Up",
    "quantityDimension": "string",
    "termDimension": "string",
    "unitCode": "string"
  },
  "priceBookId": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
listPrice	number	false	none	none
active	boolean	false	none	none
currencyIsoCode	string	false	none	none
recommended	boolean	false	none	none
billingTiming	string	false	none	none
pricingAttribute_1	string	false	none	none
pricingAttribute_2	string	false	none	none
pricingAttribute_3	string	false	none	none
pricingAttribute_4	string	false	none	none
pricingAttribute_5	string	false	none	none
pricingAttribute_6	string	false	none	none
pricingAttribute_7	string	false	none	none
pricingAttribute_8	string	false	none	none
pricingAttribute_9	string	false	none	none
pricingAttribute_10	string	false	none	none
uom	Uom	false	none	none
priceBookId	string	false	none	none

PriceDimension

{
  "id": "string",
  "name": "string",
  "description": "string",
  "recordType": "string",
  "priceTagType": "string",
  "startTime": "string",
  "endTime": "string",
  "priceType": "string",
  "active": true,
  "objectId": "string",
  "objectType": "string",
  "code": "string",
  "uomDimension": "string",
  "priceBook": {
    "id": "string",
    "name": "string",
    "description": "string",
    "standard": true,
    "active": true,
    "archived": true,
    "selfServiceEnabled": true,
    "priceAttributes": [
      "Currency"
    ]
  },
  "uom": {
    "id": "string",
    "name": "string",
    "decimalScale": 0,
    "roundingMode": "Up",
    "quantityDimension": "string",
    "termDimension": "string",
    "unitCode": "string"
  },
  "priceTiers": [
    {
      "id": "string",
      "name": "string",
      "amount": 0,
      "chargeModel": "string",
      "discountPercentage": 0,
      "endUnit": 0,
      "endUnitDimension": "string",
      "startUnit": 0,
      "startUnitDimension": "string",
      "tierNumber": 0
    }
  ],
  "publishStatus": "Unpublished",
  "lastPublishedById": "string",
  "lastPublishedDate": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
name	string	false	none	none
description	string	false	none	none
recordType	string	false	none	none
priceTagType	string	false	none	none
startTime	string	false	none	none
endTime	string	false	none	none
priceType	string	false	none	none
active	boolean	false	none	none
objectId	string	false	none	none
objectType	string	false	none	none
code	string	false	none	none
uomDimension	string	false	none	none
priceBook	PriceBook	false	none	none
uom	Uom	false	none	none
priceTiers	[PriceTier]	false	none	none
publishStatus	string	false	none	none
lastPublishedById	string	false	none	none
lastPublishedDate	string	false	none	none

Enumerated Values

Property	Value
publishStatus	Unpublished
publishStatus	Published
publishStatus	Outdated

PriceTier

{
  "id": "string",
  "name": "string",
  "amount": 0,
  "chargeModel": "string",
  "discountPercentage": 0,
  "endUnit": 0,
  "endUnitDimension": "string",
  "startUnit": 0,
  "startUnitDimension": "string",
  "tierNumber": 0
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
name	string	false	none	none
amount	number	false	none	none
chargeModel	string	false	none	none
discountPercentage	number	false	none	none
endUnit	number	false	none	none
endUnitDimension	string	false	none	none
startUnit	number	false	none	none
startUnitDimension	string	false	none	none
tierNumber	number	false	none	none

Product

{
  "id": "string",
  "customFields": {
    "property1": {},
    "property2": {}
  },
  "name": "string",
  "sku": "string",
  "recordType": "string",
  "configurable": true,
  "soldIndependently": true,
  "status": "string",
  "bundleTemplate": "string",
  "description": "string",
  "priceModel": "string",
  "startDate": "string",
  "endDate": "string",
  "freeTrialUnit": 0,
  "freeTrialType": "string",
  "productCategory": "string",
  "autoRenew": true,
  "defaultRenewalTerm": 0,
  "defaultSubscriptionTerm": 0,
  "billingTiming": "string",
  "billingPeriod": "string",
  "showIncludedProductOptions": true,
  "publishStatus": "Unpublished",
  "lastPublishedById": "string",
  "lastPublishedDate": "string",
  "taxCode": "string",
  "taxMode": "string",
  "referenceProduct": {
    "id": "string",
    "customFields": {
      "property1": {},
      "property2": {}
    },
    "name": "string",
    "sku": "string",
    "recordType": "string",
    "configurable": true,
    "soldIndependently": true,
    "status": "string",
    "bundleTemplate": "string",
    "description": "string",
    "priceModel": "string",
    "startDate": "string",
    "endDate": "string",
    "freeTrialUnit": 0,
    "freeTrialType": "string",
    "productCategory": "string",
    "autoRenew": true,
    "defaultRenewalTerm": 0,
    "defaultSubscriptionTerm": 0,
    "billingTiming": "string",
    "billingPeriod": "string",
    "showIncludedProductOptions": true,
    "publishStatus": "Unpublished",
    "lastPublishedById": "string",
    "lastPublishedDate": "string",
    "taxCode": "string",
    "taxMode": "string",
    "referenceProduct": {},
    "uom": {
      "id": "string",
      "name": "string",
      "decimalScale": 0,
      "roundingMode": "Up",
      "quantityDimension": "string",
      "termDimension": "string",
      "unitCode": "string"
    },
    "priceBook": {
      "id": "string",
      "name": "string",
      "description": "string",
      "standard": true,
      "active": true,
      "archived": true,
      "selfServiceEnabled": true,
      "priceAttributes": [
        "Currency"
      ]
    },
    "imageUrl": "string",
    "evergreen": true,
    "carvesLiabilitySegment": "string",
    "carvesRevenueSegment": "string",
    "contractLiabilitySegment": "string",
    "contractRevenueSegment": "string",
    "creditConversionId": "string",
    "creditConversion": {
      "id": "string",
      "name": "string",
      "creditTypeId": "string",
      "uomQuantityDimension": "string",
      "uomQuantity": 0,
      "creditQuantity": 0,
      "conversionRate": 0,
      "decimalScale": 0,
      "roundingMode": "string"
    },
    "priceBookEntries": [
      {
        "id": "string",
        "listPrice": 0,
        "active": true,
        "currencyIsoCode": "string",
        "recommended": true,
        "billingTiming": "string",
        "pricingAttribute_1": "string",
        "pricingAttribute_2": "string",
        "pricingAttribute_3": "string",
        "pricingAttribute_4": "string",
        "pricingAttribute_5": "string",
        "pricingAttribute_6": "string",
        "pricingAttribute_7": "string",
        "pricingAttribute_8": "string",
        "pricingAttribute_9": "string",
        "pricingAttribute_10": "string",
        "uom": {
          "id": "string",
          "name": "string",
          "decimalScale": 0,
          "roundingMode": "Up",
          "quantityDimension": "string",
          "termDimension": "string",
          "unitCode": "string"
        },
        "priceBookId": "string"
      }
    ],
    "productFeatures": [
      {
        "id": "string",
        "name": "string",
        "featureOrder": 0,
        "minOptions": 0,
        "maxOptions": 0,
        "featureName": "string",
        "featureDescription": "string",
        "feature": {
          "id": "string",
          "imageSignedUrl": "string",
          "status": "string",
          "name": "string",
          "featurePriceTags": [
            {
              "id": "string",
              "name": "string",
              "serialNumber": 0,
              "active": true,
              "priceTag": {
                "id": "string",
                "name": "string",
                "description": "string",
                "recordType": "string",
                "priceTagType": "string",
                "startTime": "string",
                "endTime": "string",
                "priceType": "string",
                "active": true,
                "objectId": "string",
                "objectType": "string",
                "code": "string",
                "uomDimension": "string",
                "priceBook": {
                  "id": "string",
                  "name": "string",
                  "description": "string",
                  "standard": true,
                  "active": true,
                  "archived": true,
                  "selfServiceEnabled": true,
                  "priceAttributes": [
                    "Currency"
                  ]
                },
                "uom": {
                  "id": "string",
                  "name": "string",
                  "decimalScale": 0,
                  "roundingMode": "Up",
                  "quantityDimension": "string",
                  "termDimension": "string",
                  "unitCode": "string"
                },
                "priceTiers": [
                  {
                    "id": "string",
                    "name": "string",
                    "amount": 0,
                    "chargeModel": "string",
                    "discountPercentage": 0,
                    "endUnit": 0,
                    "endUnitDimension": "string",
                    "startUnit": 0,
                    "startUnitDimension": "string",
                    "tierNumber": 0
                  }
                ],
                "publishStatus": "Unpublished",
                "lastPublishedById": "string",
                "lastPublishedDate": "string"
              }
            }
          ]
        },
        "productOptions": [
          {
            "id": "string",
            "name": "string",
            "optionName": "string",
            "optionOrder": 0,
            "optionType": "string",
            "defaultQuantity": 0,
            "includedQuantity": 0,
            "minQuantity": 0,
            "maxQuantity": 0,
            "quantityEditable": true,
            "required": true,
            "bundled": true,
            "recommended": true,
            "independentPricing": true,
            "priceBookEntry": {
              "id": "string",
              "listPrice": 0,
              "active": true,
              "currencyIsoCode": "string",
              "recommended": true,
              "billingTiming": "string",
              "pricingAttribute_1": "string",
              "pricingAttribute_2": "string",
              "pricingAttribute_3": "string",
              "pricingAttribute_4": "string",
              "pricingAttribute_5": "string",
              "pricingAttribute_6": "string",
              "pricingAttribute_7": "string",
              "pricingAttribute_8": "string",
              "pricingAttribute_9": "string",
              "pricingAttribute_10": "string",
              "uom": {
                "id": "string",
                "name": "string",
                "decimalScale": 0,
                "roundingMode": "Up",
                "quantityDimension": "string",
                "termDimension": "string",
                "unitCode": "string"
              },
              "priceBookId": "string"
            },
            "product": {},
            "productOptionPriceTags": [
              {
                "id": "string",
                "name": "string",
                "serialNumber": 0,
                "active": true,
                "priceTag": {
                  "id": "string",
                  "name": "string",
                  "description": "string",
                  "recordType": "string",
                  "priceTagType": "string",
                  "startTime": "string",
                  "endTime": "string",
                  "priceType": "string",
                  "active": true,
                  "objectId": "string",
                  "objectType": "string",
                  "code": "string",
                  "uomDimension": "string",
                  "priceBook": {
                    "id": "string",
                    "name": "string",
                    "description": "string",
                    "standard": true,
                    "active": true,
                    "archived": true,
                    "selfServiceEnabled": true,
                    "priceAttributes": []
                  },
                  "uom": {
                    "id": "string",
                    "name": "string",
                    "decimalScale": 0,
                    "roundingMode": "Up",
                    "quantityDimension": "string",
                    "termDimension": "string",
                    "unitCode": "string"
                  },
                  "priceTiers": [
                    {}
                  ],
                  "publishStatus": "Unpublished",
                  "lastPublishedById": "string",
                  "lastPublishedDate": "string"
                }
              }
            ]
          }
        ]
      }
    ],
    "productOptions": [
      {
        "id": "string",
        "name": "string",
        "optionName": "string",
        "optionOrder": 0,
        "optionType": "string",
        "defaultQuantity": 0,
        "includedQuantity": 0,
        "minQuantity": 0,
        "maxQuantity": 0,
        "quantityEditable": true,
        "required": true,
        "bundled": true,
        "recommended": true,
        "independentPricing": true,
        "priceBookEntry": {
          "id": "string",
          "listPrice": 0,
          "active": true,
          "currencyIsoCode": "string",
          "recommended": true,
          "billingTiming": "string",
          "pricingAttribute_1": "string",
          "pricingAttribute_2": "string",
          "pricingAttribute_3": "string",
          "pricingAttribute_4": "string",
          "pricingAttribute_5": "string",
          "pricingAttribute_6": "string",
          "pricingAttribute_7": "string",
          "pricingAttribute_8": "string",
          "pricingAttribute_9": "string",
          "pricingAttribute_10": "string",
          "uom": {
            "id": "string",
            "name": "string",
            "decimalScale": 0,
            "roundingMode": "Up",
            "quantityDimension": "string",
            "termDimension": "string",
            "unitCode": "string"
          },
          "priceBookId": "string"
        },
        "product": {},
        "productOptionPriceTags": [
          {
            "id": "string",
            "name": "string",
            "serialNumber": 0,
            "active": true,
            "priceTag": {
              "id": "string",
              "name": "string",
              "description": "string",
              "recordType": "string",
              "priceTagType": "string",
              "startTime": "string",
              "endTime": "string",
              "priceType": "string",
              "active": true,
              "objectId": "string",
              "objectType": "string",
              "code": "string",
              "uomDimension": "string",
              "priceBook": {
                "id": "string",
                "name": "string",
                "description": "string",
                "standard": true,
                "active": true,
                "archived": true,
                "selfServiceEnabled": true,
                "priceAttributes": [
                  "Currency"
                ]
              },
              "uom": {
                "id": "string",
                "name": "string",
                "decimalScale": 0,
                "roundingMode": "Up",
                "quantityDimension": "string",
                "termDimension": "string",
                "unitCode": "string"
              },
              "priceTiers": [
                {
                  "id": "string",
                  "name": "string",
                  "amount": 0,
                  "chargeModel": "string",
                  "discountPercentage": 0,
                  "endUnit": 0,
                  "endUnitDimension": "string",
                  "startUnit": 0,
                  "startUnitDimension": "string",
                  "tierNumber": 0
                }
              ],
              "publishStatus": "Unpublished",
              "lastPublishedById": "string",
              "lastPublishedDate": "string"
            }
          }
        ]
      }
    ],
    "productPriceTags": [
      {
        "id": "string",
        "name": "string",
        "serialNumber": 0,
        "active": true,
        "priceBookEntry": {
          "id": "string",
          "listPrice": 0,
          "active": true,
          "currencyIsoCode": "string",
          "recommended": true,
          "billingTiming": "string",
          "pricingAttribute_1": "string",
          "pricingAttribute_2": "string",
          "pricingAttribute_3": "string",
          "pricingAttribute_4": "string",
          "pricingAttribute_5": "string",
          "pricingAttribute_6": "string",
          "pricingAttribute_7": "string",
          "pricingAttribute_8": "string",
          "pricingAttribute_9": "string",
          "pricingAttribute_10": "string",
          "uom": {
            "id": "string",
            "name": "string",
            "decimalScale": 0,
            "roundingMode": "Up",
            "quantityDimension": "string",
            "termDimension": "string",
            "unitCode": "string"
          },
          "priceBookId": "string"
        },
        "priceTag": {
          "id": "string",
          "name": "string",
          "description": "string",
          "recordType": "string",
          "priceTagType": "string",
          "startTime": "string",
          "endTime": "string",
          "priceType": "string",
          "active": true,
          "objectId": "string",
          "objectType": "string",
          "code": "string",
          "uomDimension": "string",
          "priceBook": {
            "id": "string",
            "name": "string",
            "description": "string",
            "standard": true,
            "active": true,
            "archived": true,
            "selfServiceEnabled": true,
            "priceAttributes": [
              "Currency"
            ]
          },
          "uom": {
            "id": "string",
            "name": "string",
            "decimalScale": 0,
            "roundingMode": "Up",
            "quantityDimension": "string",
            "termDimension": "string",
            "unitCode": "string"
          },
          "priceTiers": [
            {
              "id": "string",
              "name": "string",
              "amount": 0,
              "chargeModel": "string",
              "discountPercentage": 0,
              "endUnit": 0,
              "endUnitDimension": "string",
              "startUnit": 0,
              "startUnitDimension": "string",
              "tierNumber": 0
            }
          ],
          "publishStatus": "Unpublished",
          "lastPublishedById": "string",
          "lastPublishedDate": "string"
        }
      }
    ],
    "carvesEligible": true
  },
  "uom": {
    "id": "string",
    "name": "string",
    "decimalScale": 0,
    "roundingMode": "Up",
    "quantityDimension": "string",
    "termDimension": "string",
    "unitCode": "string"
  },
  "priceBook": {
    "id": "string",
    "name": "string",
    "description": "string",
    "standard": true,
    "active": true,
    "archived": true,
    "selfServiceEnabled": true,
    "priceAttributes": [
      "Currency"
    ]
  },
  "imageUrl": "string",
  "evergreen": true,
  "carvesLiabilitySegment": "string",
  "carvesRevenueSegment": "string",
  "contractLiabilitySegment": "string",
  "contractRevenueSegment": "string",
  "creditConversionId": "string",
  "creditConversion": {
    "id": "string",
    "name": "string",
    "creditTypeId": "string",
    "uomQuantityDimension": "string",
    "uomQuantity": 0,
    "creditQuantity": 0,
    "conversionRate": 0,
    "decimalScale": 0,
    "roundingMode": "string"
  },
  "priceBookEntries": [
    {
      "id": "string",
      "listPrice": 0,
      "active": true,
      "currencyIsoCode": "string",
      "recommended": true,
      "billingTiming": "string",
      "pricingAttribute_1": "string",
      "pricingAttribute_2": "string",
      "pricingAttribute_3": "string",
      "pricingAttribute_4": "string",
      "pricingAttribute_5": "string",
      "pricingAttribute_6": "string",
      "pricingAttribute_7": "string",
      "pricingAttribute_8": "string",
      "pricingAttribute_9": "string",
      "pricingAttribute_10": "string",
      "uom": {
        "id": "string",
        "name": "string",
        "decimalScale": 0,
        "roundingMode": "Up",
        "quantityDimension": "string",
        "termDimension": "string",
        "unitCode": "string"
      },
      "priceBookId": "string"
    }
  ],
  "productFeatures": [
    {
      "id": "string",
      "name": "string",
      "featureOrder": 0,
      "minOptions": 0,
      "maxOptions": 0,
      "featureName": "string",
      "featureDescription": "string",
      "feature": {
        "id": "string",
        "imageSignedUrl": "string",
        "status": "string",
        "name": "string",
        "featurePriceTags": [
          {
            "id": "string",
            "name": "string",
            "serialNumber": 0,
            "active": true,
            "priceTag": {
              "id": "string",
              "name": "string",
              "description": "string",
              "recordType": "string",
              "priceTagType": "string",
              "startTime": "string",
              "endTime": "string",
              "priceType": "string",
              "active": true,
              "objectId": "string",
              "objectType": "string",
              "code": "string",
              "uomDimension": "string",
              "priceBook": {
                "id": "string",
                "name": "string",
                "description": "string",
                "standard": true,
                "active": true,
                "archived": true,
                "selfServiceEnabled": true,
                "priceAttributes": [
                  "Currency"
                ]
              },
              "uom": {
                "id": "string",
                "name": "string",
                "decimalScale": 0,
                "roundingMode": "Up",
                "quantityDimension": "string",
                "termDimension": "string",
                "unitCode": "string"
              },
              "priceTiers": [
                {
                  "id": "string",
                  "name": "string",
                  "amount": 0,
                  "chargeModel": "string",
                  "discountPercentage": 0,
                  "endUnit": 0,
                  "endUnitDimension": "string",
                  "startUnit": 0,
                  "startUnitDimension": "string",
                  "tierNumber": 0
                }
              ],
              "publishStatus": "Unpublished",
              "lastPublishedById": "string",
              "lastPublishedDate": "string"
            }
          }
        ]
      },
      "productOptions": [
        {
          "id": "string",
          "name": "string",
          "optionName": "string",
          "optionOrder": 0,
          "optionType": "string",
          "defaultQuantity": 0,
          "includedQuantity": 0,
          "minQuantity": 0,
          "maxQuantity": 0,
          "quantityEditable": true,
          "required": true,
          "bundled": true,
          "recommended": true,
          "independentPricing": true,
          "priceBookEntry": {
            "id": "string",
            "listPrice": 0,
            "active": true,
            "currencyIsoCode": "string",
            "recommended": true,
            "billingTiming": "string",
            "pricingAttribute_1": "string",
            "pricingAttribute_2": "string",
            "pricingAttribute_3": "string",
            "pricingAttribute_4": "string",
            "pricingAttribute_5": "string",
            "pricingAttribute_6": "string",
            "pricingAttribute_7": "string",
            "pricingAttribute_8": "string",
            "pricingAttribute_9": "string",
            "pricingAttribute_10": "string",
            "uom": {
              "id": "string",
              "name": "string",
              "decimalScale": 0,
              "roundingMode": "Up",
              "quantityDimension": "string",
              "termDimension": "string",
              "unitCode": "string"
            },
            "priceBookId": "string"
          },
          "product": {
            "id": "string",
            "customFields": {
              "property1": {},
              "property2": {}
            },
            "name": "string",
            "sku": "string",
            "recordType": "string",
            "configurable": true,
            "soldIndependently": true,
            "status": "string",
            "bundleTemplate": "string",
            "description": "string",
            "priceModel": "string",
            "startDate": "string",
            "endDate": "string",
            "freeTrialUnit": 0,
            "freeTrialType": "string",
            "productCategory": "string",
            "autoRenew": true,
            "defaultRenewalTerm": 0,
            "defaultSubscriptionTerm": 0,
            "billingTiming": "string",
            "billingPeriod": "string",
            "showIncludedProductOptions": true,
            "publishStatus": "Unpublished",
            "lastPublishedById": "string",
            "lastPublishedDate": "string",
            "taxCode": "string",
            "taxMode": "string",
            "referenceProduct": {},
            "uom": {
              "id": "string",
              "name": "string",
              "decimalScale": 0,
              "roundingMode": "Up",
              "quantityDimension": "string",
              "termDimension": "string",
              "unitCode": "string"
            },
            "priceBook": {
              "id": "string",
              "name": "string",
              "description": "string",
              "standard": true,
              "active": true,
              "archived": true,
              "selfServiceEnabled": true,
              "priceAttributes": [
                "Currency"
              ]
            },
            "imageUrl": "string",
            "evergreen": true,
            "carvesLiabilitySegment": "string",
            "carvesRevenueSegment": "string",
            "contractLiabilitySegment": "string",
            "contractRevenueSegment": "string",
            "creditConversionId": "string",
            "creditConversion": {
              "id": "string",
              "name": "string",
              "creditTypeId": "string",
              "uomQuantityDimension": "string",
              "uomQuantity": 0,
              "creditQuantity": 0,
              "conversionRate": 0,
              "decimalScale": 0,
              "roundingMode": "string"
            },
            "priceBookEntries": [
              {
                "id": "string",
                "listPrice": 0,
                "active": true,
                "currencyIsoCode": "string",
                "recommended": true,
                "billingTiming": "string",
                "pricingAttribute_1": "string",
                "pricingAttribute_2": "string",
                "pricingAttribute_3": "string",
                "pricingAttribute_4": "string",
                "pricingAttribute_5": "string",
                "pricingAttribute_6": "string",
                "pricingAttribute_7": "string",
                "pricingAttribute_8": "string",
                "pricingAttribute_9": "string",
                "pricingAttribute_10": "string",
                "uom": {
                  "id": "string",
                  "name": "string",
                  "decimalScale": 0,
                  "roundingMode": "Up",
                  "quantityDimension": "string",
                  "termDimension": "string",
                  "unitCode": "string"
                },
                "priceBookId": "string"
              }
            ],
            "productFeatures": [],
            "productOptions": [
              {}
            ],
            "productPriceTags": [
              {
                "id": "string",
                "name": "string",
                "serialNumber": 0,
                "active": true,
                "priceBookEntry": {
                  "id": "string",
                  "listPrice": 0,
                  "active": true,
                  "currencyIsoCode": "string",
                  "recommended": true,
                  "billingTiming": "string",
                  "pricingAttribute_1": "string",
                  "pricingAttribute_2": "string",
                  "pricingAttribute_3": "string",
                  "pricingAttribute_4": "string",
                  "pricingAttribute_5": "string",
                  "pricingAttribute_6": "string",
                  "pricingAttribute_7": "string",
                  "pricingAttribute_8": "string",
                  "pricingAttribute_9": "string",
                  "pricingAttribute_10": "string",
                  "uom": {
                    "id": "string",
                    "name": "string",
                    "decimalScale": 0,
                    "roundingMode": "Up",
                    "quantityDimension": "string",
                    "termDimension": "string",
                    "unitCode": "string"
                  },
                  "priceBookId": "string"
                },
                "priceTag": {
                  "id": "string",
                  "name": "string",
                  "description": "string",
                  "recordType": "string",
                  "priceTagType": "string",
                  "startTime": "string",
                  "endTime": "string",
                  "priceType": "string",
                  "active": true,
                  "objectId": "string",
                  "objectType": "string",
                  "code": "string",
                  "uomDimension": "string",
                  "priceBook": {
                    "id": "string",
                    "name": "string",
                    "description": "string",
                    "standard": true,
                    "active": true,
                    "archived": true,
                    "selfServiceEnabled": true,
                    "priceAttributes": []
                  },
                  "uom": {
                    "id": "string",
                    "name": "string",
                    "decimalScale": 0,
                    "roundingMode": "Up",
                    "quantityDimension": "string",
                    "termDimension": "string",
                    "unitCode": "string"
                  },
                  "priceTiers": [
                    {}
                  ],
                  "publishStatus": "Unpublished",
                  "lastPublishedById": "string",
                  "lastPublishedDate": "string"
                }
              }
            ],
            "carvesEligible": true
          },
          "productOptionPriceTags": [
            {
              "id": "string",
              "name": "string",
              "serialNumber": 0,
              "active": true,
              "priceTag": {
                "id": "string",
                "name": "string",
                "description": "string",
                "recordType": "string",
                "priceTagType": "string",
                "startTime": "string",
                "endTime": "string",
                "priceType": "string",
                "active": true,
                "objectId": "string",
                "objectType": "string",
                "code": "string",
                "uomDimension": "string",
                "priceBook": {
                  "id": "string",
                  "name": "string",
                  "description": "string",
                  "standard": true,
                  "active": true,
                  "archived": true,
                  "selfServiceEnabled": true,
                  "priceAttributes": [
                    "Currency"
                  ]
                },
                "uom": {
                  "id": "string",
                  "name": "string",
                  "decimalScale": 0,
                  "roundingMode": "Up",
                  "quantityDimension": "string",
                  "termDimension": "string",
                  "unitCode": "string"
                },
                "priceTiers": [
                  {
                    "id": "string",
                    "name": "string",
                    "amount": 0,
                    "chargeModel": "string",
                    "discountPercentage": 0,
                    "endUnit": 0,
                    "endUnitDimension": "string",
                    "startUnit": 0,
                    "startUnitDimension": "string",
                    "tierNumber": 0
                  }
                ],
                "publishStatus": "Unpublished",
                "lastPublishedById": "string",
                "lastPublishedDate": "string"
              }
            }
          ]
        }
      ]
    }
  ],
  "productOptions": [
    {
      "id": "string",
      "name": "string",
      "optionName": "string",
      "optionOrder": 0,
      "optionType": "string",
      "defaultQuantity": 0,
      "includedQuantity": 0,
      "minQuantity": 0,
      "maxQuantity": 0,
      "quantityEditable": true,
      "required": true,
      "bundled": true,
      "recommended": true,
      "independentPricing": true,
      "priceBookEntry": {
        "id": "string",
        "listPrice": 0,
        "active": true,
        "currencyIsoCode": "string",
        "recommended": true,
        "billingTiming": "string",
        "pricingAttribute_1": "string",
        "pricingAttribute_2": "string",
        "pricingAttribute_3": "string",
        "pricingAttribute_4": "string",
        "pricingAttribute_5": "string",
        "pricingAttribute_6": "string",
        "pricingAttribute_7": "string",
        "pricingAttribute_8": "string",
        "pricingAttribute_9": "string",
        "pricingAttribute_10": "string",
        "uom": {
          "id": "string",
          "name": "string",
          "decimalScale": 0,
          "roundingMode": "Up",
          "quantityDimension": "string",
          "termDimension": "string",
          "unitCode": "string"
        },
        "priceBookId": "string"
      },
      "product": {
        "id": "string",
        "customFields": {
          "property1": {},
          "property2": {}
        },
        "name": "string",
        "sku": "string",
        "recordType": "string",
        "configurable": true,
        "soldIndependently": true,
        "status": "string",
        "bundleTemplate": "string",
        "description": "string",
        "priceModel": "string",
        "startDate": "string",
        "endDate": "string",
        "freeTrialUnit": 0,
        "freeTrialType": "string",
        "productCategory": "string",
        "autoRenew": true,
        "defaultRenewalTerm": 0,
        "defaultSubscriptionTerm": 0,
        "billingTiming": "string",
        "billingPeriod": "string",
        "showIncludedProductOptions": true,
        "publishStatus": "Unpublished",
        "lastPublishedById": "string",
        "lastPublishedDate": "string",
        "taxCode": "string",
        "taxMode": "string",
        "referenceProduct": {},
        "uom": {
          "id": "string",
          "name": "string",
          "decimalScale": 0,
          "roundingMode": "Up",
          "quantityDimension": "string",
          "termDimension": "string",
          "unitCode": "string"
        },
        "priceBook": {
          "id": "string",
          "name": "string",
          "description": "string",
          "standard": true,
          "active": true,
          "archived": true,
          "selfServiceEnabled": true,
          "priceAttributes": [
            "Currency"
          ]
        },
        "imageUrl": "string",
        "evergreen": true,
        "carvesLiabilitySegment": "string",
        "carvesRevenueSegment": "string",
        "contractLiabilitySegment": "string",
        "contractRevenueSegment": "string",
        "creditConversionId": "string",
        "creditConversion": {
          "id": "string",
          "name": "string",
          "creditTypeId": "string",
          "uomQuantityDimension": "string",
          "uomQuantity": 0,
          "creditQuantity": 0,
          "conversionRate": 0,
          "decimalScale": 0,
          "roundingMode": "string"
        },
        "priceBookEntries": [
          {
            "id": "string",
            "listPrice": 0,
            "active": true,
            "currencyIsoCode": "string",
            "recommended": true,
            "billingTiming": "string",
            "pricingAttribute_1": "string",
            "pricingAttribute_2": "string",
            "pricingAttribute_3": "string",
            "pricingAttribute_4": "string",
            "pricingAttribute_5": "string",
            "pricingAttribute_6": "string",
            "pricingAttribute_7": "string",
            "pricingAttribute_8": "string",
            "pricingAttribute_9": "string",
            "pricingAttribute_10": "string",
            "uom": {
              "id": "string",
              "name": "string",
              "decimalScale": 0,
              "roundingMode": "Up",
              "quantityDimension": "string",
              "termDimension": "string",
              "unitCode": "string"
            },
            "priceBookId": "string"
          }
        ],
        "productFeatures": [
          {
            "id": "string",
            "name": "string",
            "featureOrder": 0,
            "minOptions": 0,
            "maxOptions": 0,
            "featureName": "string",
            "featureDescription": "string",
            "feature": {
              "id": "string",
              "imageSignedUrl": "string",
              "status": "string",
              "name": "string",
              "featurePriceTags": [
                {
                  "id": "string",
                  "name": "string",
                  "serialNumber": 0,
                  "active": true,
                  "priceTag": {
                    "id": "string",
                    "name": "string",
                    "description": "string",
                    "recordType": "string",
                    "priceTagType": "string",
                    "startTime": "string",
                    "endTime": "string",
                    "priceType": "string",
                    "active": true,
                    "objectId": "string",
                    "objectType": "string",
                    "code": "string",
                    "uomDimension": "string",
                    "priceBook": {},
                    "uom": {},
                    "priceTiers": [],
                    "publishStatus": "Unpublished",
                    "lastPublishedById": "string",
                    "lastPublishedDate": "string"
                  }
                }
              ]
            },
            "productOptions": [
              {}
            ]
          }
        ],
        "productOptions": [],
        "productPriceTags": [
          {
            "id": "string",
            "name": "string",
            "serialNumber": 0,
            "active": true,
            "priceBookEntry": {
              "id": "string",
              "listPrice": 0,
              "active": true,
              "currencyIsoCode": "string",
              "recommended": true,
              "billingTiming": "string",
              "pricingAttribute_1": "string",
              "pricingAttribute_2": "string",
              "pricingAttribute_3": "string",
              "pricingAttribute_4": "string",
              "pricingAttribute_5": "string",
              "pricingAttribute_6": "string",
              "pricingAttribute_7": "string",
              "pricingAttribute_8": "string",
              "pricingAttribute_9": "string",
              "pricingAttribute_10": "string",
              "uom": {
                "id": "string",
                "name": "string",
                "decimalScale": 0,
                "roundingMode": "Up",
                "quantityDimension": "string",
                "termDimension": "string",
                "unitCode": "string"
              },
              "priceBookId": "string"
            },
            "priceTag": {
              "id": "string",
              "name": "string",
              "description": "string",
              "recordType": "string",
              "priceTagType": "string",
              "startTime": "string",
              "endTime": "string",
              "priceType": "string",
              "active": true,
              "objectId": "string",
              "objectType": "string",
              "code": "string",
              "uomDimension": "string",
              "priceBook": {
                "id": "string",
                "name": "string",
                "description": "string",
                "standard": true,
                "active": true,
                "archived": true,
                "selfServiceEnabled": true,
                "priceAttributes": [
                  "Currency"
                ]
              },
              "uom": {
                "id": "string",
                "name": "string",
                "decimalScale": 0,
                "roundingMode": "Up",
                "quantityDimension": "string",
                "termDimension": "string",
                "unitCode": "string"
              },
              "priceTiers": [
                {
                  "id": "string",
                  "name": "string",
                  "amount": 0,
                  "chargeModel": "string",
                  "discountPercentage": 0,
                  "endUnit": 0,
                  "endUnitDimension": "string",
                  "startUnit": 0,
                  "startUnitDimension": "string",
                  "tierNumber": 0
                }
              ],
              "publishStatus": "Unpublished",
              "lastPublishedById": "string",
              "lastPublishedDate": "string"
            }
          }
        ],
        "carvesEligible": true
      },
      "productOptionPriceTags": [
        {
          "id": "string",
          "name": "string",
          "serialNumber": 0,
          "active": true,
          "priceTag": {
            "id": "string",
            "name": "string",
            "description": "string",
            "recordType": "string",
            "priceTagType": "string",
            "startTime": "string",
            "endTime": "string",
            "priceType": "string",
            "active": true,
            "objectId": "string",
            "objectType": "string",
            "code": "string",
            "uomDimension": "string",
            "priceBook": {
              "id": "string",
              "name": "string",
              "description": "string",
              "standard": true,
              "active": true,
              "archived": true,
              "selfServiceEnabled": true,
              "priceAttributes": [
                "Currency"
              ]
            },
            "uom": {
              "id": "string",
              "name": "string",
              "decimalScale": 0,
              "roundingMode": "Up",
              "quantityDimension": "string",
              "termDimension": "string",
              "unitCode": "string"
            },
            "priceTiers": [
              {
                "id": "string",
                "name": "string",
                "amount": 0,
                "chargeModel": "string",
                "discountPercentage": 0,
                "endUnit": 0,
                "endUnitDimension": "string",
                "startUnit": 0,
                "startUnitDimension": "string",
                "tierNumber": 0
              }
            ],
            "publishStatus": "Unpublished",
            "lastPublishedById": "string",
            "lastPublishedDate": "string"
          }
        }
      ]
    }
  ],
  "productPriceTags": [
    {
      "id": "string",
      "name": "string",
      "serialNumber": 0,
      "active": true,
      "priceBookEntry": {
        "id": "string",
        "listPrice": 0,
        "active": true,
        "currencyIsoCode": "string",
        "recommended": true,
        "billingTiming": "string",
        "pricingAttribute_1": "string",
        "pricingAttribute_2": "string",
        "pricingAttribute_3": "string",
        "pricingAttribute_4": "string",
        "pricingAttribute_5": "string",
        "pricingAttribute_6": "string",
        "pricingAttribute_7": "string",
        "pricingAttribute_8": "string",
        "pricingAttribute_9": "string",
        "pricingAttribute_10": "string",
        "uom": {
          "id": "string",
          "name": "string",
          "decimalScale": 0,
          "roundingMode": "Up",
          "quantityDimension": "string",
          "termDimension": "string",
          "unitCode": "string"
        },
        "priceBookId": "string"
      },
      "priceTag": {
        "id": "string",
        "name": "string",
        "description": "string",
        "recordType": "string",
        "priceTagType": "string",
        "startTime": "string",
        "endTime": "string",
        "priceType": "string",
        "active": true,
        "objectId": "string",
        "objectType": "string",
        "code": "string",
        "uomDimension": "string",
        "priceBook": {
          "id": "string",
          "name": "string",
          "description": "string",
          "standard": true,
          "active": true,
          "archived": true,
          "selfServiceEnabled": true,
          "priceAttributes": [
            "Currency"
          ]
        },
        "uom": {
          "id": "string",
          "name": "string",
          "decimalScale": 0,
          "roundingMode": "Up",
          "quantityDimension": "string",
          "termDimension": "string",
          "unitCode": "string"
        },
        "priceTiers": [
          {
            "id": "string",
            "name": "string",
            "amount": 0,
            "chargeModel": "string",
            "discountPercentage": 0,
            "endUnit": 0,
            "endUnitDimension": "string",
            "startUnit": 0,
            "startUnitDimension": "string",
            "tierNumber": 0
          }
        ],
        "publishStatus": "Unpublished",
        "lastPublishedById": "string",
        "lastPublishedDate": "string"
      }
    }
  ],
  "carvesEligible": true
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
customFields	object	false	none	none
» additionalProperties	object	false	none	none
name	string	false	none	none
sku	string	false	none	none
recordType	string	false	none	none
configurable	boolean	false	none	none
soldIndependently	boolean	false	none	none
status	string	false	none	none
bundleTemplate	string	false	none	none
description	string	false	none	none
priceModel	string	false	none	none
startDate	string	false	none	none
endDate	string	false	none	none
freeTrialUnit	integer(int32)	false	none	none
freeTrialType	string	false	none	none
productCategory	string	false	none	none
autoRenew	boolean	false	none	none
defaultRenewalTerm	number	false	none	none
defaultSubscriptionTerm	integer(int32)	false	none	none
billingTiming	string	false	none	none
billingPeriod	string	false	none	none
showIncludedProductOptions	boolean	false	none	none
publishStatus	string	false	none	none
lastPublishedById	string	false	none	none
lastPublishedDate	string	false	none	none
taxCode	string	false	none	none
taxMode	string	false	none	none
referenceProduct	Product	false	none	none
uom	Uom	false	none	none
priceBook	PriceBook	false	none	none
imageUrl	string	false	none	none
evergreen	boolean	false	none	none
carvesLiabilitySegment	string	false	none	none
carvesRevenueSegment	string	false	none	none
contractLiabilitySegment	string	false	none	none
contractRevenueSegment	string	false	none	none
creditConversionId	string	false	none	none
creditConversion	CreditConversion	false	none	none
priceBookEntries	[PriceBookEntry]	false	none	none
productFeatures	[ProductFeature]	false	none	none
productOptions	[ProductOption]	false	none	none
productPriceTags	[ProductPriceDimension]	false	none	none
carvesEligible	boolean	false	none	none

Enumerated Values

Property	Value
publishStatus	Unpublished
publishStatus	Published
publishStatus	Outdated

ProductFeature

{
  "id": "string",
  "name": "string",
  "featureOrder": 0,
  "minOptions": 0,
  "maxOptions": 0,
  "featureName": "string",
  "featureDescription": "string",
  "feature": {
    "id": "string",
    "imageSignedUrl": "string",
    "status": "string",
    "name": "string",
    "featurePriceTags": [
      {
        "id": "string",
        "name": "string",
        "serialNumber": 0,
        "active": true,
        "priceTag": {
          "id": "string",
          "name": "string",
          "description": "string",
          "recordType": "string",
          "priceTagType": "string",
          "startTime": "string",
          "endTime": "string",
          "priceType": "string",
          "active": true,
          "objectId": "string",
          "objectType": "string",
          "code": "string",
          "uomDimension": "string",
          "priceBook": {
            "id": "string",
            "name": "string",
            "description": "string",
            "standard": true,
            "active": true,
            "archived": true,
            "selfServiceEnabled": true,
            "priceAttributes": [
              "Currency"
            ]
          },
          "uom": {
            "id": "string",
            "name": "string",
            "decimalScale": 0,
            "roundingMode": "Up",
            "quantityDimension": "string",
            "termDimension": "string",
            "unitCode": "string"
          },
          "priceTiers": [
            {
              "id": "string",
              "name": "string",
              "amount": 0,
              "chargeModel": "string",
              "discountPercentage": 0,
              "endUnit": 0,
              "endUnitDimension": "string",
              "startUnit": 0,
              "startUnitDimension": "string",
              "tierNumber": 0
            }
          ],
          "publishStatus": "Unpublished",
          "lastPublishedById": "string",
          "lastPublishedDate": "string"
        }
      }
    ]
  },
  "productOptions": [
    {
      "id": "string",
      "name": "string",
      "optionName": "string",
      "optionOrder": 0,
      "optionType": "string",
      "defaultQuantity": 0,
      "includedQuantity": 0,
      "minQuantity": 0,
      "maxQuantity": 0,
      "quantityEditable": true,
      "required": true,
      "bundled": true,
      "recommended": true,
      "independentPricing": true,
      "priceBookEntry": {
        "id": "string",
        "listPrice": 0,
        "active": true,
        "currencyIsoCode": "string",
        "recommended": true,
        "billingTiming": "string",
        "pricingAttribute_1": "string",
        "pricingAttribute_2": "string",
        "pricingAttribute_3": "string",
        "pricingAttribute_4": "string",
        "pricingAttribute_5": "string",
        "pricingAttribute_6": "string",
        "pricingAttribute_7": "string",
        "pricingAttribute_8": "string",
        "pricingAttribute_9": "string",
        "pricingAttribute_10": "string",
        "uom": {
          "id": "string",
          "name": "string",
          "decimalScale": 0,
          "roundingMode": "Up",
          "quantityDimension": "string",
          "termDimension": "string",
          "unitCode": "string"
        },
        "priceBookId": "string"
      },
      "product": {
        "id": "string",
        "customFields": {
          "property1": {},
          "property2": {}
        },
        "name": "string",
        "sku": "string",
        "recordType": "string",
        "configurable": true,
        "soldIndependently": true,
        "status": "string",
        "bundleTemplate": "string",
        "description": "string",
        "priceModel": "string",
        "startDate": "string",
        "endDate": "string",
        "freeTrialUnit": 0,
        "freeTrialType": "string",
        "productCategory": "string",
        "autoRenew": true,
        "defaultRenewalTerm": 0,
        "defaultSubscriptionTerm": 0,
        "billingTiming": "string",
        "billingPeriod": "string",
        "showIncludedProductOptions": true,
        "publishStatus": "Unpublished",
        "lastPublishedById": "string",
        "lastPublishedDate": "string",
        "taxCode": "string",
        "taxMode": "string",
        "referenceProduct": {},
        "uom": {
          "id": "string",
          "name": "string",
          "decimalScale": 0,
          "roundingMode": "Up",
          "quantityDimension": "string",
          "termDimension": "string",
          "unitCode": "string"
        },
        "priceBook": {
          "id": "string",
          "name": "string",
          "description": "string",
          "standard": true,
          "active": true,
          "archived": true,
          "selfServiceEnabled": true,
          "priceAttributes": [
            "Currency"
          ]
        },
        "imageUrl": "string",
        "evergreen": true,
        "carvesLiabilitySegment": "string",
        "carvesRevenueSegment": "string",
        "contractLiabilitySegment": "string",
        "contractRevenueSegment": "string",
        "creditConversionId": "string",
        "creditConversion": {
          "id": "string",
          "name": "string",
          "creditTypeId": "string",
          "uomQuantityDimension": "string",
          "uomQuantity": 0,
          "creditQuantity": 0,
          "conversionRate": 0,
          "decimalScale": 0,
          "roundingMode": "string"
        },
        "priceBookEntries": [
          {
            "id": "string",
            "listPrice": 0,
            "active": true,
            "currencyIsoCode": "string",
            "recommended": true,
            "billingTiming": "string",
            "pricingAttribute_1": "string",
            "pricingAttribute_2": "string",
            "pricingAttribute_3": "string",
            "pricingAttribute_4": "string",
            "pricingAttribute_5": "string",
            "pricingAttribute_6": "string",
            "pricingAttribute_7": "string",
            "pricingAttribute_8": "string",
            "pricingAttribute_9": "string",
            "pricingAttribute_10": "string",
            "uom": {
              "id": "string",
              "name": "string",
              "decimalScale": 0,
              "roundingMode": "Up",
              "quantityDimension": "string",
              "termDimension": "string",
              "unitCode": "string"
            },
            "priceBookId": "string"
          }
        ],
        "productFeatures": [
          {
            "id": "string",
            "name": "string",
            "featureOrder": 0,
            "minOptions": 0,
            "maxOptions": 0,
            "featureName": "string",
            "featureDescription": "string",
            "feature": {
              "id": "string",
              "imageSignedUrl": "string",
              "status": "string",
              "name": "string",
              "featurePriceTags": [
                {
                  "id": "string",
                  "name": "string",
                  "serialNumber": 0,
                  "active": true,
                  "priceTag": {
                    "id": "string",
                    "name": "string",
                    "description": "string",
                    "recordType": "string",
                    "priceTagType": "string",
                    "startTime": "string",
                    "endTime": "string",
                    "priceType": "string",
                    "active": true,
                    "objectId": "string",
                    "objectType": "string",
                    "code": "string",
                    "uomDimension": "string",
                    "priceBook": {},
                    "uom": {},
                    "priceTiers": [],
                    "publishStatus": "Unpublished",
                    "lastPublishedById": "string",
                    "lastPublishedDate": "string"
                  }
                }
              ]
            },
            "productOptions": []
          }
        ],
        "productOptions": [
          {}
        ],
        "productPriceTags": [
          {
            "id": "string",
            "name": "string",
            "serialNumber": 0,
            "active": true,
            "priceBookEntry": {
              "id": "string",
              "listPrice": 0,
              "active": true,
              "currencyIsoCode": "string",
              "recommended": true,
              "billingTiming": "string",
              "pricingAttribute_1": "string",
              "pricingAttribute_2": "string",
              "pricingAttribute_3": "string",
              "pricingAttribute_4": "string",
              "pricingAttribute_5": "string",
              "pricingAttribute_6": "string",
              "pricingAttribute_7": "string",
              "pricingAttribute_8": "string",
              "pricingAttribute_9": "string",
              "pricingAttribute_10": "string",
              "uom": {
                "id": "string",
                "name": "string",
                "decimalScale": 0,
                "roundingMode": "Up",
                "quantityDimension": "string",
                "termDimension": "string",
                "unitCode": "string"
              },
              "priceBookId": "string"
            },
            "priceTag": {
              "id": "string",
              "name": "string",
              "description": "string",
              "recordType": "string",
              "priceTagType": "string",
              "startTime": "string",
              "endTime": "string",
              "priceType": "string",
              "active": true,
              "objectId": "string",
              "objectType": "string",
              "code": "string",
              "uomDimension": "string",
              "priceBook": {
                "id": "string",
                "name": "string",
                "description": "string",
                "standard": true,
                "active": true,
                "archived": true,
                "selfServiceEnabled": true,
                "priceAttributes": [
                  "Currency"
                ]
              },
              "uom": {
                "id": "string",
                "name": "string",
                "decimalScale": 0,
                "roundingMode": "Up",
                "quantityDimension": "string",
                "termDimension": "string",
                "unitCode": "string"
              },
              "priceTiers": [
                {
                  "id": "string",
                  "name": "string",
                  "amount": 0,
                  "chargeModel": "string",
                  "discountPercentage": 0,
                  "endUnit": 0,
                  "endUnitDimension": "string",
                  "startUnit": 0,
                  "startUnitDimension": "string",
                  "tierNumber": 0
                }
              ],
              "publishStatus": "Unpublished",
              "lastPublishedById": "string",
              "lastPublishedDate": "string"
            }
          }
        ],
        "carvesEligible": true
      },
      "productOptionPriceTags": [
        {
          "id": "string",
          "name": "string",
          "serialNumber": 0,
          "active": true,
          "priceTag": {
            "id": "string",
            "name": "string",
            "description": "string",
            "recordType": "string",
            "priceTagType": "string",
            "startTime": "string",
            "endTime": "string",
            "priceType": "string",
            "active": true,
            "objectId": "string",
            "objectType": "string",
            "code": "string",
            "uomDimension": "string",
            "priceBook": {
              "id": "string",
              "name": "string",
              "description": "string",
              "standard": true,
              "active": true,
              "archived": true,
              "selfServiceEnabled": true,
              "priceAttributes": [
                "Currency"
              ]
            },
            "uom": {
              "id": "string",
              "name": "string",
              "decimalScale": 0,
              "roundingMode": "Up",
              "quantityDimension": "string",
              "termDimension": "string",
              "unitCode": "string"
            },
            "priceTiers": [
              {
                "id": "string",
                "name": "string",
                "amount": 0,
                "chargeModel": "string",
                "discountPercentage": 0,
                "endUnit": 0,
                "endUnitDimension": "string",
                "startUnit": 0,
                "startUnitDimension": "string",
                "tierNumber": 0
              }
            ],
            "publishStatus": "Unpublished",
            "lastPublishedById": "string",
            "lastPublishedDate": "string"
          }
        }
      ]
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
name	string	false	none	none
featureOrder	integer(int32)	false	none	none
minOptions	integer(int32)	false	none	none
maxOptions	integer(int32)	false	none	none
featureName	string	false	none	none
featureDescription	string	false	none	none
feature	Feature	false	none	none
productOptions	[ProductOption]	false	none	none

ProductOption

{
  "id": "string",
  "name": "string",
  "optionName": "string",
  "optionOrder": 0,
  "optionType": "string",
  "defaultQuantity": 0,
  "includedQuantity": 0,
  "minQuantity": 0,
  "maxQuantity": 0,
  "quantityEditable": true,
  "required": true,
  "bundled": true,
  "recommended": true,
  "independentPricing": true,
  "priceBookEntry": {
    "id": "string",
    "listPrice": 0,
    "active": true,
    "currencyIsoCode": "string",
    "recommended": true,
    "billingTiming": "string",
    "pricingAttribute_1": "string",
    "pricingAttribute_2": "string",
    "pricingAttribute_3": "string",
    "pricingAttribute_4": "string",
    "pricingAttribute_5": "string",
    "pricingAttribute_6": "string",
    "pricingAttribute_7": "string",
    "pricingAttribute_8": "string",
    "pricingAttribute_9": "string",
    "pricingAttribute_10": "string",
    "uom": {
      "id": "string",
      "name": "string",
      "decimalScale": 0,
      "roundingMode": "Up",
      "quantityDimension": "string",
      "termDimension": "string",
      "unitCode": "string"
    },
    "priceBookId": "string"
  },
  "product": {
    "id": "string",
    "customFields": {
      "property1": {},
      "property2": {}
    },
    "name": "string",
    "sku": "string",
    "recordType": "string",
    "configurable": true,
    "soldIndependently": true,
    "status": "string",
    "bundleTemplate": "string",
    "description": "string",
    "priceModel": "string",
    "startDate": "string",
    "endDate": "string",
    "freeTrialUnit": 0,
    "freeTrialType": "string",
    "productCategory": "string",
    "autoRenew": true,
    "defaultRenewalTerm": 0,
    "defaultSubscriptionTerm": 0,
    "billingTiming": "string",
    "billingPeriod": "string",
    "showIncludedProductOptions": true,
    "publishStatus": "Unpublished",
    "lastPublishedById": "string",
    "lastPublishedDate": "string",
    "taxCode": "string",
    "taxMode": "string",
    "referenceProduct": {},
    "uom": {
      "id": "string",
      "name": "string",
      "decimalScale": 0,
      "roundingMode": "Up",
      "quantityDimension": "string",
      "termDimension": "string",
      "unitCode": "string"
    },
    "priceBook": {
      "id": "string",
      "name": "string",
      "description": "string",
      "standard": true,
      "active": true,
      "archived": true,
      "selfServiceEnabled": true,
      "priceAttributes": [
        "Currency"
      ]
    },
    "imageUrl": "string",
    "evergreen": true,
    "carvesLiabilitySegment": "string",
    "carvesRevenueSegment": "string",
    "contractLiabilitySegment": "string",
    "contractRevenueSegment": "string",
    "creditConversionId": "string",
    "creditConversion": {
      "id": "string",
      "name": "string",
      "creditTypeId": "string",
      "uomQuantityDimension": "string",
      "uomQuantity": 0,
      "creditQuantity": 0,
      "conversionRate": 0,
      "decimalScale": 0,
      "roundingMode": "string"
    },
    "priceBookEntries": [
      {
        "id": "string",
        "listPrice": 0,
        "active": true,
        "currencyIsoCode": "string",
        "recommended": true,
        "billingTiming": "string",
        "pricingAttribute_1": "string",
        "pricingAttribute_2": "string",
        "pricingAttribute_3": "string",
        "pricingAttribute_4": "string",
        "pricingAttribute_5": "string",
        "pricingAttribute_6": "string",
        "pricingAttribute_7": "string",
        "pricingAttribute_8": "string",
        "pricingAttribute_9": "string",
        "pricingAttribute_10": "string",
        "uom": {
          "id": "string",
          "name": "string",
          "decimalScale": 0,
          "roundingMode": "Up",
          "quantityDimension": "string",
          "termDimension": "string",
          "unitCode": "string"
        },
        "priceBookId": "string"
      }
    ],
    "productFeatures": [
      {
        "id": "string",
        "name": "string",
        "featureOrder": 0,
        "minOptions": 0,
        "maxOptions": 0,
        "featureName": "string",
        "featureDescription": "string",
        "feature": {
          "id": "string",
          "imageSignedUrl": "string",
          "status": "string",
          "name": "string",
          "featurePriceTags": [
            {
              "id": "string",
              "name": "string",
              "serialNumber": 0,
              "active": true,
              "priceTag": {
                "id": "string",
                "name": "string",
                "description": "string",
                "recordType": "string",
                "priceTagType": "string",
                "startTime": "string",
                "endTime": "string",
                "priceType": "string",
                "active": true,
                "objectId": "string",
                "objectType": "string",
                "code": "string",
                "uomDimension": "string",
                "priceBook": {
                  "id": "string",
                  "name": "string",
                  "description": "string",
                  "standard": true,
                  "active": true,
                  "archived": true,
                  "selfServiceEnabled": true,
                  "priceAttributes": [
                    "Currency"
                  ]
                },
                "uom": {
                  "id": "string",
                  "name": "string",
                  "decimalScale": 0,
                  "roundingMode": "Up",
                  "quantityDimension": "string",
                  "termDimension": "string",
                  "unitCode": "string"
                },
                "priceTiers": [
                  {
                    "id": "string",
                    "name": "string",
                    "amount": 0,
                    "chargeModel": "string",
                    "discountPercentage": 0,
                    "endUnit": 0,
                    "endUnitDimension": "string",
                    "startUnit": 0,
                    "startUnitDimension": "string",
                    "tierNumber": 0
                  }
                ],
                "publishStatus": "Unpublished",
                "lastPublishedById": "string",
                "lastPublishedDate": "string"
              }
            }
          ]
        },
        "productOptions": [
          {
            "id": "string",
            "name": "string",
            "optionName": "string",
            "optionOrder": 0,
            "optionType": "string",
            "defaultQuantity": 0,
            "includedQuantity": 0,
            "minQuantity": 0,
            "maxQuantity": 0,
            "quantityEditable": true,
            "required": true,
            "bundled": true,
            "recommended": true,
            "independentPricing": true,
            "priceBookEntry": {
              "id": "string",
              "listPrice": 0,
              "active": true,
              "currencyIsoCode": "string",
              "recommended": true,
              "billingTiming": "string",
              "pricingAttribute_1": "string",
              "pricingAttribute_2": "string",
              "pricingAttribute_3": "string",
              "pricingAttribute_4": "string",
              "pricingAttribute_5": "string",
              "pricingAttribute_6": "string",
              "pricingAttribute_7": "string",
              "pricingAttribute_8": "string",
              "pricingAttribute_9": "string",
              "pricingAttribute_10": "string",
              "uom": {
                "id": "string",
                "name": "string",
                "decimalScale": 0,
                "roundingMode": "Up",
                "quantityDimension": "string",
                "termDimension": "string",
                "unitCode": "string"
              },
              "priceBookId": "string"
            },
            "product": {},
            "productOptionPriceTags": [
              {
                "id": "string",
                "name": "string",
                "serialNumber": 0,
                "active": true,
                "priceTag": {
                  "id": "string",
                  "name": "string",
                  "description": "string",
                  "recordType": "string",
                  "priceTagType": "string",
                  "startTime": "string",
                  "endTime": "string",
                  "priceType": "string",
                  "active": true,
                  "objectId": "string",
                  "objectType": "string",
                  "code": "string",
                  "uomDimension": "string",
                  "priceBook": {
                    "id": "string",
                    "name": "string",
                    "description": "string",
                    "standard": true,
                    "active": true,
                    "archived": true,
                    "selfServiceEnabled": true,
                    "priceAttributes": []
                  },
                  "uom": {
                    "id": "string",
                    "name": "string",
                    "decimalScale": 0,
                    "roundingMode": "Up",
                    "quantityDimension": "string",
                    "termDimension": "string",
                    "unitCode": "string"
                  },
                  "priceTiers": [
                    {}
                  ],
                  "publishStatus": "Unpublished",
                  "lastPublishedById": "string",
                  "lastPublishedDate": "string"
                }
              }
            ]
          }
        ]
      }
    ],
    "productOptions": [
      {
        "id": "string",
        "name": "string",
        "optionName": "string",
        "optionOrder": 0,
        "optionType": "string",
        "defaultQuantity": 0,
        "includedQuantity": 0,
        "minQuantity": 0,
        "maxQuantity": 0,
        "quantityEditable": true,
        "required": true,
        "bundled": true,
        "recommended": true,
        "independentPricing": true,
        "priceBookEntry": {
          "id": "string",
          "listPrice": 0,
          "active": true,
          "currencyIsoCode": "string",
          "recommended": true,
          "billingTiming": "string",
          "pricingAttribute_1": "string",
          "pricingAttribute_2": "string",
          "pricingAttribute_3": "string",
          "pricingAttribute_4": "string",
          "pricingAttribute_5": "string",
          "pricingAttribute_6": "string",
          "pricingAttribute_7": "string",
          "pricingAttribute_8": "string",
          "pricingAttribute_9": "string",
          "pricingAttribute_10": "string",
          "uom": {
            "id": "string",
            "name": "string",
            "decimalScale": 0,
            "roundingMode": "Up",
            "quantityDimension": "string",
            "termDimension": "string",
            "unitCode": "string"
          },
          "priceBookId": "string"
        },
        "product": {},
        "productOptionPriceTags": [
          {
            "id": "string",
            "name": "string",
            "serialNumber": 0,
            "active": true,
            "priceTag": {
              "id": "string",
              "name": "string",
              "description": "string",
              "recordType": "string",
              "priceTagType": "string",
              "startTime": "string",
              "endTime": "string",
              "priceType": "string",
              "active": true,
              "objectId": "string",
              "objectType": "string",
              "code": "string",
              "uomDimension": "string",
              "priceBook": {
                "id": "string",
                "name": "string",
                "description": "string",
                "standard": true,
                "active": true,
                "archived": true,
                "selfServiceEnabled": true,
                "priceAttributes": [
                  "Currency"
                ]
              },
              "uom": {
                "id": "string",
                "name": "string",
                "decimalScale": 0,
                "roundingMode": "Up",
                "quantityDimension": "string",
                "termDimension": "string",
                "unitCode": "string"
              },
              "priceTiers": [
                {
                  "id": "string",
                  "name": "string",
                  "amount": 0,
                  "chargeModel": "string",
                  "discountPercentage": 0,
                  "endUnit": 0,
                  "endUnitDimension": "string",
                  "startUnit": 0,
                  "startUnitDimension": "string",
                  "tierNumber": 0
                }
              ],
              "publishStatus": "Unpublished",
              "lastPublishedById": "string",
              "lastPublishedDate": "string"
            }
          }
        ]
      }
    ],
    "productPriceTags": [
      {
        "id": "string",
        "name": "string",
        "serialNumber": 0,
        "active": true,
        "priceBookEntry": {
          "id": "string",
          "listPrice": 0,
          "active": true,
          "currencyIsoCode": "string",
          "recommended": true,
          "billingTiming": "string",
          "pricingAttribute_1": "string",
          "pricingAttribute_2": "string",
          "pricingAttribute_3": "string",
          "pricingAttribute_4": "string",
          "pricingAttribute_5": "string",
          "pricingAttribute_6": "string",
          "pricingAttribute_7": "string",
          "pricingAttribute_8": "string",
          "pricingAttribute_9": "string",
          "pricingAttribute_10": "string",
          "uom": {
            "id": "string",
            "name": "string",
            "decimalScale": 0,
            "roundingMode": "Up",
            "quantityDimension": "string",
            "termDimension": "string",
            "unitCode": "string"
          },
          "priceBookId": "string"
        },
        "priceTag": {
          "id": "string",
          "name": "string",
          "description": "string",
          "recordType": "string",
          "priceTagType": "string",
          "startTime": "string",
          "endTime": "string",
          "priceType": "string",
          "active": true,
          "objectId": "string",
          "objectType": "string",
          "code": "string",
          "uomDimension": "string",
          "priceBook": {
            "id": "string",
            "name": "string",
            "description": "string",
            "standard": true,
            "active": true,
            "archived": true,
            "selfServiceEnabled": true,
            "priceAttributes": [
              "Currency"
            ]
          },
          "uom": {
            "id": "string",
            "name": "string",
            "decimalScale": 0,
            "roundingMode": "Up",
            "quantityDimension": "string",
            "termDimension": "string",
            "unitCode": "string"
          },
          "priceTiers": [
            {
              "id": "string",
              "name": "string",
              "amount": 0,
              "chargeModel": "string",
              "discountPercentage": 0,
              "endUnit": 0,
              "endUnitDimension": "string",
              "startUnit": 0,
              "startUnitDimension": "string",
              "tierNumber": 0
            }
          ],
          "publishStatus": "Unpublished",
          "lastPublishedById": "string",
          "lastPublishedDate": "string"
        }
      }
    ],
    "carvesEligible": true
  },
  "productOptionPriceTags": [
    {
      "id": "string",
      "name": "string",
      "serialNumber": 0,
      "active": true,
      "priceTag": {
        "id": "string",
        "name": "string",
        "description": "string",
        "recordType": "string",
        "priceTagType": "string",
        "startTime": "string",
        "endTime": "string",
        "priceType": "string",
        "active": true,
        "objectId": "string",
        "objectType": "string",
        "code": "string",
        "uomDimension": "string",
        "priceBook": {
          "id": "string",
          "name": "string",
          "description": "string",
          "standard": true,
          "active": true,
          "archived": true,
          "selfServiceEnabled": true,
          "priceAttributes": [
            "Currency"
          ]
        },
        "uom": {
          "id": "string",
          "name": "string",
          "decimalScale": 0,
          "roundingMode": "Up",
          "quantityDimension": "string",
          "termDimension": "string",
          "unitCode": "string"
        },
        "priceTiers": [
          {
            "id": "string",
            "name": "string",
            "amount": 0,
            "chargeModel": "string",
            "discountPercentage": 0,
            "endUnit": 0,
            "endUnitDimension": "string",
            "startUnit": 0,
            "startUnitDimension": "string",
            "tierNumber": 0
          }
        ],
        "publishStatus": "Unpublished",
        "lastPublishedById": "string",
        "lastPublishedDate": "string"
      }
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
name	string	false	none	none
optionName	string	false	none	none
optionOrder	integer(int32)	false	none	none
optionType	string	false	none	none
defaultQuantity	number	false	none	none
includedQuantity	number	false	none	none
minQuantity	number	false	none	none
maxQuantity	number	false	none	none
quantityEditable	boolean	false	none	none
required	boolean	false	none	none
bundled	boolean	false	none	none
recommended	boolean	false	none	none
independentPricing	boolean	false	none	none
priceBookEntry	PriceBookEntry	false	none	none
product	Product	false	none	none
productOptionPriceTags	[ProductOptionPriceDimension]	false	none	none

ProductOptionPriceDimension

{
  "id": "string",
  "name": "string",
  "serialNumber": 0,
  "active": true,
  "priceTag": {
    "id": "string",
    "name": "string",
    "description": "string",
    "recordType": "string",
    "priceTagType": "string",
    "startTime": "string",
    "endTime": "string",
    "priceType": "string",
    "active": true,
    "objectId": "string",
    "objectType": "string",
    "code": "string",
    "uomDimension": "string",
    "priceBook": {
      "id": "string",
      "name": "string",
      "description": "string",
      "standard": true,
      "active": true,
      "archived": true,
      "selfServiceEnabled": true,
      "priceAttributes": [
        "Currency"
      ]
    },
    "uom": {
      "id": "string",
      "name": "string",
      "decimalScale": 0,
      "roundingMode": "Up",
      "quantityDimension": "string",
      "termDimension": "string",
      "unitCode": "string"
    },
    "priceTiers": [
      {
        "id": "string",
        "name": "string",
        "amount": 0,
        "chargeModel": "string",
        "discountPercentage": 0,
        "endUnit": 0,
        "endUnitDimension": "string",
        "startUnit": 0,
        "startUnitDimension": "string",
        "tierNumber": 0
      }
    ],
    "publishStatus": "Unpublished",
    "lastPublishedById": "string",
    "lastPublishedDate": "string"
  }
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
name	string	false	none	none
serialNumber	integer(int32)	false	none	none
active	boolean	false	none	none
priceTag	PriceDimension	false	none	none

ProductPriceDimension

{
  "id": "string",
  "name": "string",
  "serialNumber": 0,
  "active": true,
  "priceBookEntry": {
    "id": "string",
    "listPrice": 0,
    "active": true,
    "currencyIsoCode": "string",
    "recommended": true,
    "billingTiming": "string",
    "pricingAttribute_1": "string",
    "pricingAttribute_2": "string",
    "pricingAttribute_3": "string",
    "pricingAttribute_4": "string",
    "pricingAttribute_5": "string",
    "pricingAttribute_6": "string",
    "pricingAttribute_7": "string",
    "pricingAttribute_8": "string",
    "pricingAttribute_9": "string",
    "pricingAttribute_10": "string",
    "uom": {
      "id": "string",
      "name": "string",
      "decimalScale": 0,
      "roundingMode": "Up",
      "quantityDimension": "string",
      "termDimension": "string",
      "unitCode": "string"
    },
    "priceBookId": "string"
  },
  "priceTag": {
    "id": "string",
    "name": "string",
    "description": "string",
    "recordType": "string",
    "priceTagType": "string",
    "startTime": "string",
    "endTime": "string",
    "priceType": "string",
    "active": true,
    "objectId": "string",
    "objectType": "string",
    "code": "string",
    "uomDimension": "string",
    "priceBook": {
      "id": "string",
      "name": "string",
      "description": "string",
      "standard": true,
      "active": true,
      "archived": true,
      "selfServiceEnabled": true,
      "priceAttributes": [
        "Currency"
      ]
    },
    "uom": {
      "id": "string",
      "name": "string",
      "decimalScale": 0,
      "roundingMode": "Up",
      "quantityDimension": "string",
      "termDimension": "string",
      "unitCode": "string"
    },
    "priceTiers": [
      {
        "id": "string",
        "name": "string",
        "amount": 0,
        "chargeModel": "string",
        "discountPercentage": 0,
        "endUnit": 0,
        "endUnitDimension": "string",
        "startUnit": 0,
        "startUnitDimension": "string",
        "tierNumber": 0
      }
    ],
    "publishStatus": "Unpublished",
    "lastPublishedById": "string",
    "lastPublishedDate": "string"
  }
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
name	string	false	none	none
serialNumber	integer(int32)	false	none	none
active	boolean	false	none	none
priceBookEntry	PriceBookEntry	false	none	none
priceTag	PriceDimension	false	none	none

Uom

{
  "id": "string",
  "name": "string",
  "decimalScale": 0,
  "roundingMode": "Up",
  "quantityDimension": "string",
  "termDimension": "string",
  "unitCode": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
name	string	false	none	none
decimalScale	integer(int32)	false	none	none
roundingMode	string	false	none	none
quantityDimension	string	false	none	none
termDimension	string	false	none	none
unitCode	string	false	none	none

Enumerated Values

Property	Value
roundingMode	Up
roundingMode	Down

UsageRateBulkRequest

{
  "usages": [
    {
      "referenceId": "string",
      "subscriptionNumber": "string",
      "consumedQuantity": 0,
      "deltaQuantity": 0,
      "ratingDate": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
usages	[UsageRateRequest]	false	none	none

UsageRateRequest

{
  "referenceId": "string",
  "subscriptionNumber": "string",
  "consumedQuantity": 0,
  "deltaQuantity": 0,
  "ratingDate": "string"
}

Properties

Name	Type	Required	Restrictions	Description
referenceId	string	false	none	none
subscriptionNumber	string	false	none	none
consumedQuantity	number	false	none	none
deltaQuantity	number	false	none	none
ratingDate	string	false	none	none

UsageRateBulkResponse

{
  "error": "string",
  "results": [
    {
      "referenceId": "string",
      "subscriptionNumber": "string",
      "lineItemId": "string",
      "totalPrice": 0,
      "totalAmount": 0,
      "subtotal": 0,
      "listTotal": 0,
      "quantity": 0,
      "discountAmount": 0,
      "discountPercentage": 0,
      "systemDiscount": 0,
      "systemDiscountAmount": 0,
      "netSalesPrice": 0,
      "salesPrice": 0,
      "ratedCredit": 0,
      "success": true,
      "error": "string",
      "orderItemId": "string",
      "orderItemNumber": "string",
      "orderNumber": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
error	string	false	none	none
results	[UsageRateResponse]	false	none	none

UsageRateResponse

{
  "referenceId": "string",
  "subscriptionNumber": "string",
  "lineItemId": "string",
  "totalPrice": 0,
  "totalAmount": 0,
  "subtotal": 0,
  "listTotal": 0,
  "quantity": 0,
  "discountAmount": 0,
  "discountPercentage": 0,
  "systemDiscount": 0,
  "systemDiscountAmount": 0,
  "netSalesPrice": 0,
  "salesPrice": 0,
  "ratedCredit": 0,
  "success": true,
  "error": "string",
  "orderItemId": "string",
  "orderItemNumber": "string",
  "orderNumber": "string"
}

Properties

Name	Type	Required	Restrictions	Description
referenceId	string	false	none	none
subscriptionNumber	string	false	none	none
lineItemId	string	false	none	none
totalPrice	number	false	none	none
totalAmount	number	false	none	none
subtotal	number	false	none	none
listTotal	number	false	none	none
quantity	number	false	none	none
discountAmount	number	false	none	none
discountPercentage	number	false	none	none
systemDiscount	number	false	none	none
systemDiscountAmount	number	false	none	none
netSalesPrice	number	false	none	none
salesPrice	number	false	none	none
ratedCredit	number	false	none	none
success	boolean	false	none	none
error	string	false	none	none
orderItemId	string	false	none	none
orderItemNumber	string	false	none	none
orderNumber	string	false	none	none

ImportAndExportOrderSettingsVO

{
  "settings": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
settings	[OrderSetting]	false	none	none

OrderSetting

{
  "key": "string",
  "value": "string"
}

Properties

Name	Type	Required	Restrictions	Description
key	string	false	none	none
value	string	false	none	none

OrderForPreview

{
  "id": "string",
  "customerId": "string",
  "billingAccountId": "string",
  "Billing Period": "Month",
  "Bill Cycle Day": "string",
  "Payment Term": "string",
  "Billing Start Month on sales account": "string",
  "Bill Cycle Day on sales Account": "string",
  "Payment Term on sales account": "string",
  "Billing Period on sales account": "Month",
  "salesAccountProrationEnabled": true,
  "salesAccountSubscriptionCreated": true,
  "Billing Start Month on billing account": "string",
  "Bill Cycle Day on billing Account": "string",
  "Payment Term on billing account": "string",
  "Billing Period on billing account": "Month",
  "billingAccountProrationEnabled": true,
  "billingAccountSubscriptionCreated": true
}

Orders.

Properties

Name	Type	Required	Restrictions	Description
id	string	true	none	ID of order.
customerId	string	false	none	Customer ID. Optional if different from parent customer ID.
billingAccountId	string	false	none	Billing Account ID. Optional if different from customer ID.
Billing Period	string	false	none	The billing period determines how often the order products are billed, for example, Monthly, Quarterly, Annual, etc. There is an organization default, and each customer may have its own default value. When an order is created, the Billing Period is defaulted from that of the customer.
Bill Cycle Day	string	false	none	Determines on which day the billing cycle starts. There is an organizational default Bill Cycle Day, but can be overridden at product, account, and order product (asset) level.
Payment Term	string	false	none	Determines when customers pay for their products or services
Billing Start Month on sales account	string	false	none	The billing start month
Bill Cycle Day on sales Account	string	false	none	Determines on which day the billing cycle starts. There is an organizational default Bill Cycle Day, but can be overridden at product, account, and order product (asset) level.
Payment Term on sales account	string	false	none	Determines when customers pay for their products or services
Billing Period on sales account	string	false	none	The billing period determines how often the order products are billed, for example, Monthly, Quarterly, Annual, etc. There is an organization default, and each customer may have its own default value. When an order is created, the Billing Period is defaulted from that of the customer.
salesAccountProrationEnabled	boolean	false	none	Billing Proration Enabled on sales account.
salesAccountSubscriptionCreated	boolean	false	none	Indicate if sales account has subscription created.
Billing Start Month on billing account	string	false	none	The billing start month
Bill Cycle Day on billing Account	string	false	none	Determines on which day the billing cycle starts. There is an organizational default Bill Cycle Day, but can be overridden at product, account, and order product (asset) level.
Payment Term on billing account	string	false	none	Determines when customers pay for their products or services
Billing Period on billing account	string	false	none	The billing period determines how often the order products are billed, for example, Monthly, Quarterly, Annual, etc. There is an organization default, and each customer may have its own default value. When an order is created, the Billing Period is defaulted from that of the customer.
billingAccountProrationEnabled	boolean	false	none	Billing Proration Enabled on billing account.
billingAccountSubscriptionCreated	boolean	false	none	Indicate if billing account has subscription created

Enumerated Values

Property	Value
Billing Period	Month
Billing Period	Quarter
Billing Period	Semi-Annual
Billing Period	Annual
Billing Period on sales account	Month
Billing Period on sales account	Quarter
Billing Period on sales account	Semi-Annual
Billing Period on sales account	Annual
Billing Period on billing account	Month
Billing Period on billing account	Quarter
Billing Period on billing account	Semi-Annual
Billing Period on billing account	Annual

OrderInvoicePreviewRequest

{
  "customerId": "string",
  "billingAccountId": "string",
  "targetDate": "2019-08-24",
  "Billing Period": "Month",
  "Bill Cycle Day": "string",
  "Billing Start Month": "string",
  "Payment Term": "string",
  "prorationEnabled": true,
  "firstInvoiceOnly": true,
  "skipInvoicedItems": true,
  "Billing Start Month on sales account": "string",
  "Bill Cycle Day on sales Account": "string",
  "Payment Term on sales account": "string",
  "Billing Period on sales account": "Month",
  "salesAccountProrationEnabled": true,
  "Billing Start Month on billing account": "string",
  "Bill Cycle Day on billing Account": "string",
  "Payment Term on billing account": "string",
  "Billing Period on billing account": "Month",
  "billingAccountProrationEnabled": true,
  "orders": [
    {
      "id": "string",
      "customerId": "string",
      "billingAccountId": "string",
      "Billing Period": "Month",
      "Bill Cycle Day": "string",
      "Payment Term": "string",
      "Billing Start Month on sales account": "string",
      "Bill Cycle Day on sales Account": "string",
      "Payment Term on sales account": "string",
      "Billing Period on sales account": "Month",
      "salesAccountProrationEnabled": true,
      "salesAccountSubscriptionCreated": true,
      "Billing Start Month on billing account": "string",
      "Bill Cycle Day on billing Account": "string",
      "Payment Term on billing account": "string",
      "Billing Period on billing account": "Month",
      "billingAccountProrationEnabled": true,
      "billingAccountSubscriptionCreated": true
    }
  ],
  "orderProducts": [
    {
      "id": "string",
      "customerId": "string",
      "billingAccountId": "string",
      "orderId": "string",
      "orderProductNumber": "string",
      "priceBookEntryId": "string",
      "subscriptionTerm": 0,
      "summaryLineItemId": "string",
      "uomId": "string",
      "evergreen": true,
      "description": "string",
      "priceModel": "string",
      "startDate": "2019-08-24",
      "endDate": "2019-08-24",
      "totalPrice": 0,
      "totalAmount": 0,
      "tax": 0,
      "quantity": 0,
      "productId": "string",
      "productName": "string",
      "lineType": "LineItem",
      "netSalesPrice": 0,
      "billingTiming": "string",
      "Billing Period": "Month",
      "Payment Term": "string",
      "Billing Start Month": "string",
      "Bill Cycle Day": "string",
      "uomEx": "string",
      "currencyIsoCode": "string",
      "entityId": "string",
      "assetType": "Subscription",
      "productSku": "string",
      "change": true
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
customerId	string	true	none	Customer ID.
billingAccountId	string	false	none	Billing Account ID.
targetDate	string(date)	false	none	Invoice target date.
Billing Period	string	false	none	The billing period determines how often the order products are billed, for example, Monthly, Quarterly, Annual, etc. There is an organization default, and each customer may have its own default value. When an order is created, the Billing Period is defaulted from that of the customer.
Bill Cycle Day	string	false	none	Determines on which day the billing cycle starts. There is an organizational default Bill Cycle Day, but can be overridden at product, account, and order product (asset) level.
Billing Start Month	string	false	none	The billing start month
Payment Term	string	false	none	Determines when customers pay for their products or services
prorationEnabled	boolean	false	none	Billing Proration Enabled.
firstInvoiceOnly	boolean	false	none	First invoice only.
skipInvoicedItems	boolean	false	none	Skip invoiced items from future invoice preview.
Billing Start Month on sales account	string	false	none	The billing start month
Bill Cycle Day on sales Account	string	false	none	Determines on which day the billing cycle starts. There is an organizational default Bill Cycle Day, but can be overridden at product, account, and order product (asset) level.
Payment Term on sales account	string	false	none	Determines when customers pay for their products or services
Billing Period on sales account	string	false	none	The billing period determines how often the order products are billed, for example, Monthly, Quarterly, Annual, etc. There is an organization default, and each customer may have its own default value. When an order is created, the Billing Period is defaulted from that of the customer.
salesAccountProrationEnabled	boolean	false	none	Billing Proration Enabled on sales account.
Billing Start Month on billing account	string	false	none	The billing start month
Bill Cycle Day on billing Account	string	false	none	Determines on which day the billing cycle starts. There is an organizational default Bill Cycle Day, but can be overridden at product, account, and order product (asset) level.
Payment Term on billing account	string	false	none	Determines when customers pay for their products or services
Billing Period on billing account	string	false	none	The billing period determines how often the order products are billed, for example, Monthly, Quarterly, Annual, etc. There is an organization default, and each customer may have its own default value. When an order is created, the Billing Period is defaulted from that of the customer.
billingAccountProrationEnabled	boolean	false	none	Billing Proration Enabled on billing account.
orders	[OrderForPreview]	false	none	Orders.
orderProducts	[OrderProductForPreview]	true	none	Order products.

Enumerated Values

Property	Value
Billing Period	Month
Billing Period	Quarter
Billing Period	Semi-Annual
Billing Period	Annual
Billing Period on sales account	Month
Billing Period on sales account	Quarter
Billing Period on sales account	Semi-Annual
Billing Period on sales account	Annual
Billing Period on billing account	Month
Billing Period on billing account	Quarter
Billing Period on billing account	Semi-Annual
Billing Period on billing account	Annual

OrderProductForPreview

{
  "id": "string",
  "customerId": "string",
  "billingAccountId": "string",
  "orderId": "string",
  "orderProductNumber": "string",
  "priceBookEntryId": "string",
  "subscriptionTerm": 0,
  "summaryLineItemId": "string",
  "uomId": "string",
  "evergreen": true,
  "description": "string",
  "priceModel": "string",
  "startDate": "2019-08-24",
  "endDate": "2019-08-24",
  "totalPrice": 0,
  "totalAmount": 0,
  "tax": 0,
  "quantity": 0,
  "productId": "string",
  "productName": "string",
  "lineType": "LineItem",
  "netSalesPrice": 0,
  "billingTiming": "string",
  "Billing Period": "Month",
  "Payment Term": "string",
  "Billing Start Month": "string",
  "Bill Cycle Day": "string",
  "uomEx": "string",
  "currencyIsoCode": "string",
  "entityId": "string",
  "assetType": "Subscription",
  "productSku": "string",
  "change": true
}

Order products.

Properties

Name	Type	Required	Restrictions	Description
id	string	true	none	ID of order product.
customerId	string	false	none	Customer ID. Optional if different from parent customer ID.
billingAccountId	string	false	none	Billing Account ID. Optional if different from customer ID.
orderId	string	false	none	ID of order.
orderProductNumber	string	false	none	Order Product Number.
priceBookEntryId	string	false	none	Price Book Entry.
subscriptionTerm	number	false	none	Subscription Term.
summaryLineItemId	string	false	none	Summary Line Item
uomId	string	false	none	UOM Id.
evergreen	boolean	false	none	Evergreen. This indicates if the line item is a evergreen item.
description	string	false	none	Description.
priceModel	string	true	none	Price model.
startDate	string(date)	true	none	Subscription start date.
endDate	string(date)	false	none	Subscription end date.
totalPrice	number	true	none	Total price. The line time's sales price multiplied by the quantity and Term, minus discounts.
totalAmount	number	false	none	Total amount.
tax	number	true	none	The tax amount.
quantity	number	true	none	The quantity of the product.
productId	string	true	none	ID of the product associated with this OrderLineItem.
productName	string	true	none	Name of the product associated with this OrderLineItem.
lineType	string	true	none	The order product type.
netSalesPrice	number	true	none	The actual sales price after the on-the-fly discount
billingTiming	string	false	none	Determines whether customers are billed for the products or services before or after they are provided or consumed.
Billing Period	string	false	none	The billing period determines how often the order products are billed, for example, Monthly, Quarterly, Annual, etc. There is an organization default, and each customer may have its own default value. When an order is created, the Billing Period is defaulted from that of the customer.
Payment Term	string	false	none	Determines when customers pay for their products or services
Billing Start Month	string	false	none	The billing start month
Bill Cycle Day	string	false	none	Determines on which day the billing cycle starts. There is an organizational default Bill Cycle Day, but can be overridden at product, account, and order product (asset) level.
uomEx	string	false	none	UOM in JSON form
currencyIsoCode	string	false	none	Available only for organizations with the multiplcurrency feature enabled. Contains the ISO code for any currency allowed by the organization.
entityId	string	false	none	The associated entity.
assetType	string	false	none	The type of the associated asset, including Subscription, Asset, Entitlement, etc.
productSku	string	true	none	Sku of the product associated with this OrderLineItem.
change	boolean	false	none	none

Enumerated Values

Property	Value
lineType	LineItem
lineType	RampItem
lineType	SummaryItem
lineType	SplitItem
Billing Period	Month
Billing Period	Quarter
Billing Period	Semi-Annual
Billing Period	Annual
assetType	Subscription
assetType	Asset
assetType	Entitlement

FieldsSyncParam

{
  "objectApiName": "Order",
  "fieldApiNames": [
    "IsReseller__c",
    "orderACV",
    "paymentMethod",
    "description",
    "poNumber"
  ],
  "graphqlFilter": "{ IsReseller__c: {  _eq  : false } }"
}

The additional parameters of the batch job, currently only ‘graphqlFilter’ is supported, set this parameter in the request if only filtered records need to be synced

Properties

Name	Type	Required	Restrictions	Description
objectApiName	string	true	none	Object API name, currently supported: Order, Customer, Invoice and CreditMemo.
fieldApiNames	[string]	true	none	Fields expected to be synced.
graphqlFilter	string	false	none	Define conditions for the records to be synced in graphql.

Enumerated Values

Property	Value
objectApiName	AbstractAsset
objectApiName	Order
objectApiName	OrderProduct
objectApiName	Asset
objectApiName	AssetOrderProduct
objectApiName	Contact
objectApiName	Customer
objectApiName	Subscription
objectApiName	UserProfile
objectApiName	Company
objectApiName	RelatedCustomer
objectApiName	BillingSchedule
objectApiName	BillingJob
objectApiName	Invoice
objectApiName	InvoiceItem
objectApiName	InvoiceItemDetail
objectApiName	CreditMemo
objectApiName	CreditMemoItem
objectApiName	CreditMemoItemDetail
objectApiName	Usage
objectApiName	PaymentApplication
objectApiName	PaymentApplicationItem
objectApiName	CreditType
objectApiName	CreditPool
objectApiName	AccountCreditPool
objectApiName	Credit
objectApiName	CreditFlow
objectApiName	DebitMemo
objectApiName	DebitMemoItem
objectApiName	BillingState
objectApiName	BillingAsset
objectApiName	PaymentRule
objectApiName	Entitlement
objectApiName	Entity
objectApiName	LinePriceDimension
objectApiName	PriceDimension
objectApiName	FeaturePriceDimension
objectApiName	PriceBook
objectApiName	PriceTier
objectApiName	ProductOptionPriceDimension
objectApiName	ProductPriceDimension
objectApiName	UOM
objectApiName	Feature
objectApiName	BundleSuite
objectApiName	PriceBookEntry
objectApiName	Product
objectApiName	ProductOption
objectApiName	ProductFeature
objectApiName	BundleSuiteBundle
objectApiName	CreditConversion
objectApiName	ProductOptionRelation
objectApiName	ChangeHistory
objectApiName	SsSubscription
objectApiName	SsAsset
objectApiName	SsEntitlement
objectApiName	FormTemplate

SyncJobRequestFieldsSyncParam

{
  "parameters": {
    "objectApiName": "Order",
    "fieldApiNames": [
      "IsReseller__c",
      "orderACV",
      "paymentMethod",
      "description",
      "poNumber"
    ],
    "graphqlFilter": "{ IsReseller__c: {  _eq  : false } }"
  },
  "batchSize": 0,
  "scheduleId": "string",
  "name": "string"
}

Properties

Name	Type	Required	Restrictions	Description
parameters	FieldsSyncParam	false	none	The additional parameters of the batch job, currently only ‘graphqlFilter’ is supported, set this parameter in the request if only filtered records need to be synced
batchSize	integer(int64)	false	none	The size of each batch in the current job, this parameter is passed from the request
scheduleId	string	false	none	The schedule Id if the current batch job is triggered by a scheduled job, this parameter is passed from the request
name	string	false	none	The name of the current batch job

SyncJobFieldsSyncParam

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "scheduleId": "string",
  "type": "string",
  "parameters": {
    "objectApiName": "Order",
    "fieldApiNames": [
      "IsReseller__c",
      "orderACV",
      "paymentMethod",
      "description",
      "poNumber"
    ],
    "graphqlFilter": "{ IsReseller__c: {  _eq  : false } }"
  },
  "status": "Queued",
  "sourceRecords": 0,
  "targetRecords": 0,
  "recordsToSync": 0,
  "recordsProcessed": 0,
  "batchSize": 0,
  "totalBatches": 0,
  "batchesProcessed": 0,
  "errorCode": "string",
  "errorMessage": "string",
  "executionSeconds": 0,
  "startTime": 0,
  "endTime": 0
}

Properties

Name	Type	Required	Restrictions	Description
id	string(uuid)	false	none	The unique id of the current batch job
name	string	false	none	The name of the current batch job
scheduleId	string	false	none	The schedule Id if the current batch job is triggered by a scheduled job, this parameter is passed from the request
type	string	false	none	The object type to be synced
parameters	FieldsSyncParam	false	none	The additional parameters of the batch job, currently only ‘graphqlFilter’ is supported, set this parameter in the request if only filtered records need to be synced
status	string	false	none	The status of the current batch job, the available options are Queued, Processing, Completed, and Error.
sourceRecords	integer(int64)	false	none	The number of order records in Salesforce included in the current batch job
targetRecords	integer(int64)	false	none	The number of order records in Nue included in the current batch job
recordsToSync	integer(int64)	false	none	The number of order records to be synced from Salesforce to Nue, this number indicates the records do not exist in Nue and need to be synced
recordsProcessed	integer(int64)	false	none	The number of order records being processed in the current batch job
batchSize	integer(int64)	false	none	The size of each batch in the current job, this parameter is passed from the request
totalBatches	integer(int64)	false	none	The total number of batches in the current job
batchesProcessed	integer(int64)	false	none	The number of batches being processed in the current job
errorCode	string	false	none	The error code when the current job is completed with errors
errorMessage	string	false	none	The error message details when the current job is completed with errors
executionSeconds	integer(int64)	false	none	The execution time of the current job in seconds
startTime	integer(int64)	false	none	The start time of the current job
endTime	integer(int64)	false	none	The end time of the current job

Enumerated Values

Property	Value
status	Queued
status	Processing
status	Completed
status	Failed

ContactReturnResponse

{
  "id": "string",
  "name": "string",
  "firstName": "string",
  "lastName": "string",
  "middleName": "string",
  "suffix": "string",
  "title": "string",
  "birthday": "2019-08-24",
  "email": "string",
  "mobilePhone": "string",
  "phone": "string",
  "shippingStreet": "string",
  "shippingCity": "string",
  "shippingState": "string",
  "shippingCountry": "string",
  "shippingPostalCode": "string",
  "billingStreet": "string",
  "billingCity": "string",
  "billingState": "string",
  "billingCountry": "string",
  "billingPostalCode": "string",
  "createdBy": "string",
  "createdDate": "2019-08-24T14:15:22Z",
  "lastModifiedBy": "string",
  "lastModifiedDate": "2019-08-24T14:15:22Z"
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	Id of contact.
name	string	false	none	Name of contact.
firstName	string	false	none	First name of contact.
lastName	string	false	none	Last name of contact.
middleName	string	false	none	Middle name of contact.
suffix	string	false	none	Suffix of contact.
title	string	false	none	Title of contact.
birthday	string(date)	false	none	Birthdate of contact.
email	string	false	none	Email address of contact.
mobilePhone	string	false	none	Mobile phone number of contact.
phone	string	false	none	Phone number of contact.
shippingStreet	string	false	none	Street of shipping address.
shippingCity	string	false	none	City of shipping address.
shippingState	string	false	none	State of shipping address.
shippingCountry	string	false	none	Country of shipping address.
shippingPostalCode	string	false	none	Postal code of shipping address.
billingStreet	string	false	none	Street of billing address.
billingCity	string	false	none	City of billing address.
billingState	string	false	none	State of billing address.
billingCountry	string	false	none	Country of billing address.
billingPostalCode	string	false	none	Postal code of billing address.
createdBy	string	false	none	The user who created the record.
createdDate	string(date-time)	false	none	The date when the record was created.
lastModifiedBy	string	false	none	The user who last updated the record.
lastModifiedDate	string(date-time)	false	none	The date when the record was last updated.

CustomerReturnResponse

{
  "id": "string",
  "name": "string",
  "description": "string",
  "accountNumber": "string",
  "email": "string",
  "phone": "string",
  "fax": "string",
  "industry": "string",
  "parentCustomerId": "string",
  "recordType": "string",
  "autoRenew": "string",
  "shippingStreet": "string",
  "shippingCity": "string",
  "shippingState": "string",
  "shippingCountry": "string",
  "shippingPostalCode": "string",
  "billingStreet": "string",
  "billingCity": "string",
  "billingState": "string",
  "billingCountry": "string",
  "billingPostalCode": "string",
  "invoiceBalance": 0,
  "latestOrderDate": "string",
  "todayARR": 0,
  "todayCMRR": 0,
  "totalTCV": 0,
  "contacts": [
    {
      "id": "string",
      "name": "string",
      "firstName": "string",
      "lastName": "string",
      "middleName": "string",
      "suffix": "string",
      "title": "string",
      "birthday": "2019-08-24",
      "email": "string",
      "mobilePhone": "string",
      "phone": "string",
      "shippingStreet": "string",
      "shippingCity": "string",
      "shippingState": "string",
      "shippingCountry": "string",
      "shippingPostalCode": "string",
      "billingStreet": "string",
      "billingCity": "string",
      "billingState": "string",
      "billingCountry": "string",
      "billingPostalCode": "string",
      "createdBy": "string",
      "createdDate": "2019-08-24T14:15:22Z",
      "lastModifiedBy": "string",
      "lastModifiedDate": "2019-08-24T14:15:22Z"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	Id of customer.
name	string	false	none	Name of customer.
description	string	false	none	Description of customer.
accountNumber	string	false	none	Account number of customer.
email	string	false	none	Email address of customer.
phone	string	false	none	Phone number of customer.
fax	string	false	none	Fax number of customer.
industry	string	false	none	Industry of customer.
parentCustomerId	string	false	none	Parent of customer.
recordType	string	false	none	Type of customer.
autoRenew	string	false	none	Auto renew. Indicates if customer should be auto renewed or default to subscription configuration.
shippingStreet	string	false	none	Street of shipping address
shippingCity	string	false	none	City of shipping address
shippingState	string	false	none	State of shipping address
shippingCountry	string	false	none	Country of shipping address
shippingPostalCode	string	false	none	Postal code of shipping address
billingStreet	string	false	none	Street of billing address
billingCity	string	false	none	City of billing address
billingState	string	false	none	State of billing address
billingCountry	string	false	none	Country of billing address
billingPostalCode	string	false	none	Postal code of billing address
invoiceBalance	number	false	none	Invoice balance of customer
latestOrderDate	string	false	none	Latest order date
todayARR	number	false	none	Today's ARR
todayCMRR	number	false	none	Today's CMRR
totalTCV	number	false	none	Total TCV
contacts	[ContactReturnResponse]	false	none	Contacts of customer.

ApiDocsAssetChangeRequest

{
  "assetNumber": "string",
  "changeType": "Renew",
  "startDate": "2019-08-24",
  "endDate": "2019-08-24",
  "term": 0.1,
  "coTermDate": "2019-08-24",
  "cancellationDate": "2019-08-24",
  "renewalTerm": 0.1,
  "quantity": 0.1
}

List of assets to change

Properties

Name	Type	Required	Restrictions	Description
assetNumber	string	true	none	The Asset Number of the subscription to change.
changeType	string	true	none	The change type
startDate	string(date)	false	none	The start date of the change.
endDate	string(date)	false	none	The end date of the change.
term	number(double)	false	none	The subscription term to add or reduce.
coTermDate	string(date)	false	none	The co-termination date that the subscription(s) will be co-termed to.
cancellationDate	string(date)	false	none	The subscription cancellation date.
renewalTerm	number(double)	false	none	The subscription's renewal term.
quantity	number(double)	false	none	Quantity to add

Enumerated Values

Property	Value
changeType	Renew
changeType	UpdateQuantity
changeType	UpdateTerm
changeType	CoTerm
changeType	Cancel
changeType	Reconfigure
changeType	ConvertFreeTrial

ApiDocsChangeOrderRequest

{
  "options": {
    "calculateTax": false,
    "previewInvoice": false,
    "activateOrder": true,
    "calculatePrice": true,
    "generateInvoice": true,
    "activateInvoice": true,
    "cancelOnPaymentFail": true,
    "asyncPayment": true
  },
  "assetChanges": [
    {
      "assetNumber": "string",
      "changeType": "Renew",
      "startDate": "2019-08-24",
      "endDate": "2019-08-24",
      "term": 0.1,
      "coTermDate": "2019-08-24",
      "cancellationDate": "2019-08-24",
      "renewalTerm": 0.1,
      "quantity": 0.1
    }
  ],
  "customer": {
    "id": "string",
    "name": "string",
    "description": "string",
    "accountNumber": "string",
    "email": "string",
    "phone": "string",
    "fax": "string",
    "industry": "string",
    "parentCustomerId": "string",
    "recordType": "string",
    "autoRenew": "string",
    "shippingStreet": "string",
    "shippingCity": "string",
    "shippingState": "string",
    "shippingCountry": "string",
    "shippingPostalCode": "string",
    "billingStreet": "string",
    "billingCity": "string",
    "billingState": "string",
    "billingCountry": "string",
    "billingPostalCode": "string",
    "entityUseCode": "string",
    "customFields": {
      "property1": {},
      "property2": {}
    },
    "contacts": [
      {
        "id": "string",
        "billingCity": "string",
        "billingCountry": "string",
        "billingPostalCode": "string",
        "billingState": "string",
        "billingStreet": "string",
        "birthday": "2019-08-24",
        "createdBy": "string",
        "createdDate": "2019-08-24T14:15:22Z",
        "customerId": "string",
        "email": "string",
        "firstName": "string",
        "lastModifiedBy": "string",
        "lastModifiedDate": "2019-08-24T14:15:22Z",
        "lastName": "string",
        "middleName": "string",
        "mobilePhone": "string",
        "name": "string",
        "phone": "string",
        "shippingCity": "string",
        "shippingCountry": "string",
        "shippingPostalCode": "string",
        "shippingState": "string",
        "shippingStreet": "string",
        "suffix": "string",
        "title": "string",
        "externalId": "string",
        "customFields": {
          "property1": {},
          "property2": {}
        },
        "modelType": "AbstractAsset"
      }
    ],
    "orderPrimaryContactPhone": "string",
    "orderPrimaryContactName": "string",
    "orderPrimaryContact": "string",
    "taxExempt": "string",
    "entityId": "string",
    "legalEntityName": "string",
    "geteInvoicingSchemaId": "string",
    "geteInvoicingEndpointId": "string",
    "paymentMethod": {
      "apiName": "string",
      "name": "string",
      "orderNumber": 0
    },
    "paymentMethods": {
      "apiName": "string",
      "name": "string",
      "values": [
        {
          "apiName": "string",
          "name": "string",
          "orderNumber": 0
        }
      ],
      "defaultValue": "string",
      "alphabeticallyOrdered": true
    },
    "annualRevenue": 0,
    "companySize": "string",
    "numberOfEmployees": 0,
    "ownership": "string",
    "funding": 0,
    "imageSignedUrl": "string",
    "rollupTCV": 0,
    "todayRollupARR": 0,
    "todayRollupCMRR": 0,
    "type": "string",
    "website": "string",
    "currencyIsoCode": "string",
    "salesAccountId": "string",
    "billingPeriod": "string",
    "timezone": "string",
    "billCycleDay": "string",
    "todayCMRR": 0,
    "billingProrationEnabled": "string",
    "todayARR": 0,
    "customerSince": "2019-08-24",
    "invoiceBalance": 0,
    "site": "string",
    "latestOrderDate": "2019-08-24",
    "lastInvoiceDate": "2019-08-24",
    "totalTCV": 0,
    "billCycleStartMonth": "string",
    "accountSource": "string",
    "paymentTerm": "string",
    "externalId": "string",
    "einvoicingSchemaId": "string",
    "einvoicingEndpointId": "string",
    "modelType": "AbstractAsset"
  },
  "revenueContractId": "string",
  "shippingAddress": {
    "id": "string",
    "country": "string",
    "state": "string",
    "city": "string",
    "street": "string",
    "postalCode": "string"
  },
  "billingAddress": {
    "id": "string",
    "country": "string",
    "state": "string",
    "city": "string",
    "street": "string",
    "postalCode": "string"
  },
  "shippingAddressSameAsBilling": true
}

Properties

Name	Type	Required	Restrictions	Description
options	CreateOrderOptions	true	none	The check out options.
assetChanges	[ApiDocsAssetChangeRequest]	true	none	List of assets to change
customer	Customer	false	none	Customer information.
revenueContractId	string	false	none	Revenue contract Id
shippingAddress	CustomerAddress	false	none	Order billing address.
billingAddress	CustomerAddress	false	none	Order billing address.
shippingAddressSameAsBilling	boolean	false	none	Indicates if shipping address should be same as billing address.

Contact

{
  "id": "string",
  "billingCity": "string",
  "billingCountry": "string",
  "billingPostalCode": "string",
  "billingState": "string",
  "billingStreet": "string",
  "birthday": "2019-08-24",
  "createdBy": "string",
  "createdDate": "2019-08-24T14:15:22Z",
  "customerId": "string",
  "email": "string",
  "firstName": "string",
  "lastModifiedBy": "string",
  "lastModifiedDate": "2019-08-24T14:15:22Z",
  "lastName": "string",
  "middleName": "string",
  "mobilePhone": "string",
  "name": "string",
  "phone": "string",
  "shippingCity": "string",
  "shippingCountry": "string",
  "shippingPostalCode": "string",
  "shippingState": "string",
  "shippingStreet": "string",
  "suffix": "string",
  "title": "string",
  "externalId": "string",
  "customFields": {
    "property1": {},
    "property2": {}
  },
  "modelType": "AbstractAsset"
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
billingCity	string	false	none	none
billingCountry	string	false	none	none
billingPostalCode	string	false	none	none
billingState	string	false	none	none
billingStreet	string	false	none	none
birthday	string(date)	false	none	none
createdBy	string	false	none	none
createdDate	string(date-time)	false	none	none
customerId	string	false	none	none
email	string	false	none	none
firstName	string	false	none	none
lastModifiedBy	string	false	none	none
lastModifiedDate	string(date-time)	false	none	none
lastName	string	false	none	none
middleName	string	false	none	none
mobilePhone	string	false	none	none
name	string	false	none	none
phone	string	false	none	none
shippingCity	string	false	none	none
shippingCountry	string	false	none	none
shippingPostalCode	string	false	none	none
shippingState	string	false	none	none
shippingStreet	string	false	none	none
suffix	string	false	none	none
title	string	false	none	none
externalId	string	false	none	none
customFields	object	false	none	none
» additionalProperties	object	false	none	none
modelType	string	false	none	none

Enumerated Values

Property	Value
modelType	AbstractAsset
modelType	Order
modelType	OrderProduct
modelType	Asset
modelType	AssetOrderProduct
modelType	Contact
modelType	Customer
modelType	Subscription
modelType	UserProfile
modelType	Company
modelType	RelatedCustomer
modelType	BillingSchedule
modelType	BillingJob
modelType	Invoice
modelType	InvoiceItem
modelType	InvoiceItemDetail
modelType	CreditMemo
modelType	CreditMemoItem
modelType	CreditMemoItemDetail
modelType	Usage
modelType	PaymentApplication
modelType	PaymentApplicationItem
modelType	CreditType
modelType	CreditPool
modelType	AccountCreditPool
modelType	Credit
modelType	CreditFlow
modelType	DebitMemo
modelType	DebitMemoItem
modelType	BillingState
modelType	BillingAsset
modelType	PaymentRule
modelType	Entitlement
modelType	Entity
modelType	LinePriceDimension
modelType	PriceDimension
modelType	FeaturePriceDimension
modelType	PriceBook
modelType	PriceTier
modelType	ProductOptionPriceDimension
modelType	ProductPriceDimension
modelType	UOM
modelType	Feature
modelType	BundleSuite
modelType	PriceBookEntry
modelType	Product
modelType	ProductOption
modelType	ProductFeature
modelType	BundleSuiteBundle
modelType	CreditConversion
modelType	ProductOptionRelation
modelType	ChangeHistory
modelType	SsSubscription
modelType	SsAsset
modelType	SsEntitlement
modelType	FormTemplate

CreateOrderOptions

{
  "calculateTax": false,
  "previewInvoice": false,
  "activateOrder": true,
  "calculatePrice": true,
  "generateInvoice": true,
  "activateInvoice": true,
  "cancelOnPaymentFail": true,
  "asyncPayment": true
}

The check out options.

Properties

Name	Type	Required	Restrictions	Description
calculateTax	boolean	true	none	none
previewInvoice	boolean	true	none	none
activateOrder	boolean	false	none	none
calculatePrice	boolean	false	none	none
generateInvoice	boolean	false	none	none
activateInvoice	boolean	false	none	none
cancelOnPaymentFail	boolean	false	none	none
asyncPayment	boolean	false	none	none

Customer

{
  "id": "string",
  "name": "string",
  "description": "string",
  "accountNumber": "string",
  "email": "string",
  "phone": "string",
  "fax": "string",
  "industry": "string",
  "parentCustomerId": "string",
  "recordType": "string",
  "autoRenew": "string",
  "shippingStreet": "string",
  "shippingCity": "string",
  "shippingState": "string",
  "shippingCountry": "string",
  "shippingPostalCode": "string",
  "billingStreet": "string",
  "billingCity": "string",
  "billingState": "string",
  "billingCountry": "string",
  "billingPostalCode": "string",
  "entityUseCode": "string",
  "customFields": {
    "property1": {},
    "property2": {}
  },
  "contacts": [
    {
      "id": "string",
      "billingCity": "string",
      "billingCountry": "string",
      "billingPostalCode": "string",
      "billingState": "string",
      "billingStreet": "string",
      "birthday": "2019-08-24",
      "createdBy": "string",
      "createdDate": "2019-08-24T14:15:22Z",
      "customerId": "string",
      "email": "string",
      "firstName": "string",
      "lastModifiedBy": "string",
      "lastModifiedDate": "2019-08-24T14:15:22Z",
      "lastName": "string",
      "middleName": "string",
      "mobilePhone": "string",
      "name": "string",
      "phone": "string",
      "shippingCity": "string",
      "shippingCountry": "string",
      "shippingPostalCode": "string",
      "shippingState": "string",
      "shippingStreet": "string",
      "suffix": "string",
      "title": "string",
      "externalId": "string",
      "customFields": {
        "property1": {},
        "property2": {}
      },
      "modelType": "AbstractAsset"
    }
  ],
  "orderPrimaryContactPhone": "string",
  "orderPrimaryContactName": "string",
  "orderPrimaryContact": "string",
  "taxExempt": "string",
  "entityId": "string",
  "legalEntityName": "string",
  "geteInvoicingSchemaId": "string",
  "geteInvoicingEndpointId": "string",
  "paymentMethod": {
    "apiName": "string",
    "name": "string",
    "orderNumber": 0
  },
  "paymentMethods": {
    "apiName": "string",
    "name": "string",
    "values": [
      {
        "apiName": "string",
        "name": "string",
        "orderNumber": 0
      }
    ],
    "defaultValue": "string",
    "alphabeticallyOrdered": true
  },
  "annualRevenue": 0,
  "companySize": "string",
  "numberOfEmployees": 0,
  "ownership": "string",
  "funding": 0,
  "imageSignedUrl": "string",
  "rollupTCV": 0,
  "todayRollupARR": 0,
  "todayRollupCMRR": 0,
  "type": "string",
  "website": "string",
  "currencyIsoCode": "string",
  "salesAccountId": "string",
  "billingPeriod": "string",
  "timezone": "string",
  "billCycleDay": "string",
  "todayCMRR": 0,
  "billingProrationEnabled": "string",
  "todayARR": 0,
  "customerSince": "2019-08-24",
  "invoiceBalance": 0,
  "site": "string",
  "latestOrderDate": "2019-08-24",
  "lastInvoiceDate": "2019-08-24",
  "totalTCV": 0,
  "billCycleStartMonth": "string",
  "accountSource": "string",
  "paymentTerm": "string",
  "externalId": "string",
  "einvoicingSchemaId": "string",
  "einvoicingEndpointId": "string",
  "modelType": "AbstractAsset"
}

Customer information.

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
name	string	false	none	none
description	string	false	none	none
accountNumber	string	false	none	none
email	string	false	none	none
phone	string	false	none	none
fax	string	false	none	none
industry	string	false	none	none
parentCustomerId	string	false	none	none
recordType	string	false	none	none
autoRenew	string	false	none	none
shippingStreet	string	false	none	none
shippingCity	string	false	none	none
shippingState	string	false	none	none
shippingCountry	string	false	none	none
shippingPostalCode	string	false	none	none
billingStreet	string	false	none	none
billingCity	string	false	none	none
billingState	string	false	none	none
billingCountry	string	false	none	none
billingPostalCode	string	false	none	none
entityUseCode	string	false	none	none
customFields	object	false	none	none
» additionalProperties	object	false	none	none
contacts	[Contact]	false	none	none
orderPrimaryContactPhone	string	false	none	none
orderPrimaryContactName	string	false	none	none
orderPrimaryContact	string	false	none	none
taxExempt	string	false	none	none
entityId	string	false	none	none
legalEntityName	string	false	none	none
geteInvoicingSchemaId	string	false	none	none
geteInvoicingEndpointId	string	false	none	none
paymentMethod	ValuePair	false	none	none
paymentMethods	ValueSet	false	none	none
annualRevenue	number	false	none	none
companySize	string	false	none	none
numberOfEmployees	integer(int32)	false	none	none
ownership	string	false	none	none
funding	number	false	none	none
imageSignedUrl	string	false	none	none
rollupTCV	number	false	none	none
todayRollupARR	number	false	none	none
todayRollupCMRR	number	false	none	none
type	string	false	none	none
website	string	false	none	none
currencyIsoCode	string	false	none	none
salesAccountId	string	false	none	none
billingPeriod	string	false	none	none
timezone	string	false	none	none
billCycleDay	string	false	none	none
todayCMRR	number	false	none	none
billingProrationEnabled	string	false	none	none
todayARR	number	false	none	none
customerSince	string(date)	false	none	none
invoiceBalance	number	false	none	none
site	string	false	none	none
latestOrderDate	string(date)	false	none	none
lastInvoiceDate	string(date)	false	none	none
totalTCV	number	false	none	none
billCycleStartMonth	string	false	none	none
accountSource	string	false	none	none
paymentTerm	string	false	none	none
externalId	string	false	none	none
einvoicingSchemaId	string	false	none	none
einvoicingEndpointId	string	false	none	none
modelType	string	false	none	none

Enumerated Values

Property	Value
modelType	AbstractAsset
modelType	Order
modelType	OrderProduct
modelType	Asset
modelType	AssetOrderProduct
modelType	Contact
modelType	Customer
modelType	Subscription
modelType	UserProfile
modelType	Company
modelType	RelatedCustomer
modelType	BillingSchedule
modelType	BillingJob
modelType	Invoice
modelType	InvoiceItem
modelType	InvoiceItemDetail
modelType	CreditMemo
modelType	CreditMemoItem
modelType	CreditMemoItemDetail
modelType	Usage
modelType	PaymentApplication
modelType	PaymentApplicationItem
modelType	CreditType
modelType	CreditPool
modelType	AccountCreditPool
modelType	Credit
modelType	CreditFlow
modelType	DebitMemo
modelType	DebitMemoItem
modelType	BillingState
modelType	BillingAsset
modelType	PaymentRule
modelType	Entitlement
modelType	Entity
modelType	LinePriceDimension
modelType	PriceDimension
modelType	FeaturePriceDimension
modelType	PriceBook
modelType	PriceTier
modelType	ProductOptionPriceDimension
modelType	ProductPriceDimension
modelType	UOM
modelType	Feature
modelType	BundleSuite
modelType	PriceBookEntry
modelType	Product
modelType	ProductOption
modelType	ProductFeature
modelType	BundleSuiteBundle
modelType	CreditConversion
modelType	ProductOptionRelation
modelType	ChangeHistory
modelType	SsSubscription
modelType	SsAsset
modelType	SsEntitlement
modelType	FormTemplate

CustomerAddress

{
  "id": "string",
  "country": "string",
  "state": "string",
  "city": "string",
  "street": "string",
  "postalCode": "string"
}

Order billing address.

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
country	string	false	none	none
state	string	false	none	none
city	string	false	none	none
street	string	false	none	none
postalCode	string	false	none	none

ValuePair

{
  "apiName": "string",
  "name": "string",
  "orderNumber": 0
}

Properties

Name	Type	Required	Restrictions	Description
apiName	string	false	none	none
name	string	false	none	none
orderNumber	integer(int32)	false	none	none

ValueSet

{
  "apiName": "string",
  "name": "string",
  "values": [
    {
      "apiName": "string",
      "name": "string",
      "orderNumber": 0
    }
  ],
  "defaultValue": "string",
  "alphabeticallyOrdered": true
}

Properties

Name	Type	Required	Restrictions	Description
apiName	string	false	none	none
name	string	false	none	none
values	[ValuePair]	false	none	none
defaultValue	string	false	none	none
alphabeticallyOrdered	boolean	false	none	none

AssetPreviewOrderProduct

{
  "refId": "string",
  "independentPricing": true,
  "productOptionQuantity": 0,
  "quantity": 0,
  "startDate": "string",
  "endDate": "string",
  "term": 0,
  "listPrice": 0,
  "netSalesPrice": 0,
  "discountPercentage": 0,
  "discountAmount": 0,
  "product": {
    "id": "string",
    "name": "string",
    "sku": "string",
    "priceModel": "string",
    "recordType": "string",
    "productCategory": "string",
    "freeTrialUnit": 0,
    "freeTrialType": "string",
    "showIncludedProductOptions": true,
    "taxPercentage": 0,
    "creditType": "Credit",
    "creditConversion": {
      "quantityDimension": "string",
      "conversionRate": 0,
      "roundingMode": "string",
      "decimalScale": 0
    }
  },
  "productOption": {
    "id": "string",
    "bundled": true,
    "optionType": "string",
    "defaultQuantity": 0,
    "includedQuantity": 0,
    "quantityEditable": true,
    "optionProduct": {
      "id": "string",
      "name": "string",
      "sku": "string",
      "priceModel": "string",
      "recordType": "string",
      "productCategory": "string",
      "freeTrialUnit": 0,
      "freeTrialType": "string",
      "showIncludedProductOptions": true,
      "taxPercentage": 0,
      "creditType": "Credit",
      "creditConversion": {
        "quantityDimension": "string",
        "conversionRate": 0,
        "roundingMode": "string",
        "decimalScale": 0
      }
    }
  },
  "includedQuantity": 0,
  "customCalculateAttributes": {
    "property1": {},
    "property2": {}
  },
  "priceDimensions": [
    {
      "startTime": "2019-08-24T14:15:22Z",
      "endTime": "2019-08-24T14:15:22Z",
      "recordType": "string",
      "priceType": "string",
      "priceDimensionType": "string",
      "source": "string",
      "priceTiers": [
        {
          "tierNumber": 0,
          "startUnit": 0,
          "endUnit": 0,
          "chargeModel": "string",
          "amount": 0,
          "discountPercentage": 0
        }
      ],
      "active": true,
      "fromLastVersion": true
    }
  ],
  "rampItems": [
    {
      "refId": "string",
      "independentPricing": true,
      "productOptionQuantity": 0,
      "quantity": 0,
      "listPrice": 0,
      "startDate": "string",
      "term": 0,
      "product": {
        "id": "string",
        "name": "string",
        "sku": "string",
        "priceModel": "string",
        "recordType": "string",
        "productCategory": "string",
        "freeTrialUnit": 0,
        "freeTrialType": "string",
        "showIncludedProductOptions": true,
        "taxPercentage": 0,
        "creditType": "Credit",
        "creditConversion": {
          "quantityDimension": "string",
          "conversionRate": 0,
          "roundingMode": "string",
          "decimalScale": 0
        }
      },
      "includedUnits": 0,
      "uom": {
        "id": "string",
        "roundingMode": "string",
        "quantityDimension": "string",
        "termDimension": "string",
        "decimalScale": 0
      },
      "discountAmount": 0,
      "discountPercentage": 0,
      "priceDimensions": [
        {
          "id": "string",
          "serialNumber": 0,
          "recordType": "string",
          "priceDimensionType": "string",
          "priceType": "string",
          "active": true,
          "startTime": "2019-08-24T14:15:22Z",
          "endTime": "2019-08-24T14:15:22Z",
          "source": "string",
          "priceTiers": [
            {
              "tierNumber": 0,
              "startUnit": 0,
              "startUnitDimension": "string",
              "endUnit": 0,
              "endUnitDimension": "string",
              "chargeModel": "string",
              "amount": 0,
              "discountPercentage": 0
            }
          ]
        }
      ],
      "productOption": {
        "id": "string",
        "bundled": true,
        "optionType": "string",
        "defaultQuantity": 0,
        "includedQuantity": 0,
        "quantityEditable": true,
        "optionProduct": {
          "id": "string",
          "name": "string",
          "sku": "string",
          "priceModel": "string",
          "recordType": "string",
          "productCategory": "string",
          "freeTrialUnit": 0,
          "freeTrialType": "string",
          "showIncludedProductOptions": true,
          "taxPercentage": 0,
          "creditType": "Credit",
          "creditConversion": {
            "quantityDimension": "string",
            "conversionRate": 0,
            "roundingMode": "string",
            "decimalScale": 0
          }
        }
      },
      "evergreen": true,
      "bundled": true
    }
  ],
  "uom": {
    "id": "string",
    "roundingMode": "string",
    "quantityDimension": "string",
    "termDimension": "string",
    "decimalScale": 0
  },
  "bundled": true
}

Properties

Name	Type	Required	Restrictions	Description
refId	string	false	none	none
independentPricing	boolean	false	none	none
productOptionQuantity	number	false	none	none
quantity	number	false	none	none
startDate	string	false	none	none
endDate	string	false	none	none
term	number	false	none	none
listPrice	number	false	none	none
netSalesPrice	number	false	none	none
discountPercentage	number	false	none	none
discountAmount	number	false	none	none
product	PriceCalProduct	false	none	none
productOption	PriceCalProductOption	false	none	none
includedQuantity	number	false	none	none
customCalculateAttributes	object	false	none	none
» additionalProperties	object	false	none	none
priceDimensions	[AssetPreviewPricingTag]	false	none	none
rampItems	[PriceCalLineItem]	false	none	none
uom	PriceCalUom	false	none	none
bundled	boolean	false	none	none

AssetPreviewPricingTag

{
  "startTime": "2019-08-24T14:15:22Z",
  "endTime": "2019-08-24T14:15:22Z",
  "recordType": "string",
  "priceType": "string",
  "priceDimensionType": "string",
  "source": "string",
  "priceTiers": [
    {
      "tierNumber": 0,
      "startUnit": 0,
      "endUnit": 0,
      "chargeModel": "string",
      "amount": 0,
      "discountPercentage": 0
    }
  ],
  "active": true,
  "fromLastVersion": true
}

Properties

Name	Type	Required	Restrictions	Description
startTime	string(date-time)	false	none	none
endTime	string(date-time)	false	none	none
recordType	string	false	none	none
priceType	string	false	none	none
priceDimensionType	string	false	none	none
source	string	false	none	none
priceTiers	[AssetPreviewPricingTier]	false	none	none
active	boolean	false	none	none
fromLastVersion	boolean	false	none	none

AssetPreviewPricingTier

{
  "tierNumber": 0,
  "startUnit": 0,
  "endUnit": 0,
  "chargeModel": "string",
  "amount": 0,
  "discountPercentage": 0
}

Properties

Name	Type	Required	Restrictions	Description
tierNumber	integer(int32)	false	none	none
startUnit	number	false	none	none
endUnit	number	false	none	none
chargeModel	string	false	none	none
amount	number	false	none	none
discountPercentage	number	false	none	none

AssetPreviewRequest

{
  "assetNumber": "string",
  "version": 0,
  "term": 0,
  "quantity": 0,
  "listTotal": 0,
  "subtotal": 0,
  "totalAmount": 0,
  "totalPrice": 0,
  "netSalesPrice": 0,
  "startDate": "string",
  "endDate": "string",
  "changes": [
    {
      "refId": "string",
      "version": 0,
      "changeType": "string",
      "lineType": "string",
      "startDate": "string",
      "endDate": "string",
      "term": 0,
      "quantity": 0,
      "productOptionQuantity": 0,
      "listTotal": 0,
      "subtotal": 0,
      "totalAmount": 0,
      "totalPrice": 0,
      "netSalesPrice": 0
    }
  ],
  "orderProduct": {
    "refId": "string",
    "independentPricing": true,
    "productOptionQuantity": 0,
    "quantity": 0,
    "startDate": "string",
    "endDate": "string",
    "term": 0,
    "listPrice": 0,
    "netSalesPrice": 0,
    "discountPercentage": 0,
    "discountAmount": 0,
    "product": {
      "id": "string",
      "name": "string",
      "sku": "string",
      "priceModel": "string",
      "recordType": "string",
      "productCategory": "string",
      "freeTrialUnit": 0,
      "freeTrialType": "string",
      "showIncludedProductOptions": true,
      "taxPercentage": 0,
      "creditType": "Credit",
      "creditConversion": {
        "quantityDimension": "string",
        "conversionRate": 0,
        "roundingMode": "string",
        "decimalScale": 0
      }
    },
    "productOption": {
      "id": "string",
      "bundled": true,
      "optionType": "string",
      "defaultQuantity": 0,
      "includedQuantity": 0,
      "quantityEditable": true,
      "optionProduct": {
        "id": "string",
        "name": "string",
        "sku": "string",
        "priceModel": "string",
        "recordType": "string",
        "productCategory": "string",
        "freeTrialUnit": 0,
        "freeTrialType": "string",
        "showIncludedProductOptions": true,
        "taxPercentage": 0,
        "creditType": "Credit",
        "creditConversion": {
          "quantityDimension": "string",
          "conversionRate": 0,
          "roundingMode": "string",
          "decimalScale": 0
        }
      }
    },
    "includedQuantity": 0,
    "customCalculateAttributes": {
      "property1": {},
      "property2": {}
    },
    "priceDimensions": [
      {
        "startTime": "2019-08-24T14:15:22Z",
        "endTime": "2019-08-24T14:15:22Z",
        "recordType": "string",
        "priceType": "string",
        "priceDimensionType": "string",
        "source": "string",
        "priceTiers": [
          {
            "tierNumber": 0,
            "startUnit": 0,
            "endUnit": 0,
            "chargeModel": "string",
            "amount": 0,
            "discountPercentage": 0
          }
        ],
        "active": true,
        "fromLastVersion": true
      }
    ],
    "rampItems": [
      {
        "refId": "string",
        "independentPricing": true,
        "productOptionQuantity": 0,
        "quantity": 0,
        "listPrice": 0,
        "startDate": "string",
        "term": 0,
        "product": {
          "id": "string",
          "name": "string",
          "sku": "string",
          "priceModel": "string",
          "recordType": "string",
          "productCategory": "string",
          "freeTrialUnit": 0,
          "freeTrialType": "string",
          "showIncludedProductOptions": true,
          "taxPercentage": 0,
          "creditType": "Credit",
          "creditConversion": {
            "quantityDimension": "string",
            "conversionRate": 0,
            "roundingMode": "string",
            "decimalScale": 0
          }
        },
        "includedUnits": 0,
        "uom": {
          "id": "string",
          "roundingMode": "string",
          "quantityDimension": "string",
          "termDimension": "string",
          "decimalScale": 0
        },
        "discountAmount": 0,
        "discountPercentage": 0,
        "priceDimensions": [
          {
            "id": "string",
            "serialNumber": 0,
            "recordType": "string",
            "priceDimensionType": "string",
            "priceType": "string",
            "active": true,
            "startTime": "2019-08-24T14:15:22Z",
            "endTime": "2019-08-24T14:15:22Z",
            "source": "string",
            "priceTiers": [
              {
                "tierNumber": 0,
                "startUnit": 0,
                "startUnitDimension": "string",
                "endUnit": 0,
                "endUnitDimension": "string",
                "chargeModel": "string",
                "amount": 0,
                "discountPercentage": 0
              }
            ]
          }
        ],
        "productOption": {
          "id": "string",
          "bundled": true,
          "optionType": "string",
          "defaultQuantity": 0,
          "includedQuantity": 0,
          "quantityEditable": true,
          "optionProduct": {
            "id": "string",
            "name": "string",
            "sku": "string",
            "priceModel": "string",
            "recordType": "string",
            "productCategory": "string",
            "freeTrialUnit": 0,
            "freeTrialType": "string",
            "showIncludedProductOptions": true,
            "taxPercentage": 0,
            "creditType": "Credit",
            "creditConversion": {
              "quantityDimension": "string",
              "conversionRate": 0,
              "roundingMode": "string",
              "decimalScale": 0
            }
          }
        },
        "evergreen": true,
        "bundled": true
      }
    ],
    "uom": {
      "id": "string",
      "roundingMode": "string",
      "quantityDimension": "string",
      "termDimension": "string",
      "decimalScale": 0
    },
    "bundled": true
  },
  "childrenAssets": [
    {
      "assetNumber": "string",
      "version": 0,
      "term": 0,
      "quantity": 0,
      "listTotal": 0,
      "subtotal": 0,
      "totalAmount": 0,
      "totalPrice": 0,
      "netSalesPrice": 0,
      "startDate": "string",
      "endDate": "string",
      "changes": [
        {
          "refId": "string",
          "version": 0,
          "changeType": "string",
          "lineType": "string",
          "startDate": "string",
          "endDate": "string",
          "term": 0,
          "quantity": 0,
          "productOptionQuantity": 0,
          "listTotal": 0,
          "subtotal": 0,
          "totalAmount": 0,
          "totalPrice": 0,
          "netSalesPrice": 0
        }
      ],
      "orderProduct": {
        "refId": "string",
        "independentPricing": true,
        "productOptionQuantity": 0,
        "quantity": 0,
        "startDate": "string",
        "endDate": "string",
        "term": 0,
        "listPrice": 0,
        "netSalesPrice": 0,
        "discountPercentage": 0,
        "discountAmount": 0,
        "product": {
          "id": "string",
          "name": "string",
          "sku": "string",
          "priceModel": "string",
          "recordType": "string",
          "productCategory": "string",
          "freeTrialUnit": 0,
          "freeTrialType": "string",
          "showIncludedProductOptions": true,
          "taxPercentage": 0,
          "creditType": "Credit",
          "creditConversion": {
            "quantityDimension": "string",
            "conversionRate": 0,
            "roundingMode": "string",
            "decimalScale": 0
          }
        },
        "productOption": {
          "id": "string",
          "bundled": true,
          "optionType": "string",
          "defaultQuantity": 0,
          "includedQuantity": 0,
          "quantityEditable": true,
          "optionProduct": {
            "id": "string",
            "name": "string",
            "sku": "string",
            "priceModel": "string",
            "recordType": "string",
            "productCategory": "string",
            "freeTrialUnit": 0,
            "freeTrialType": "string",
            "showIncludedProductOptions": true,
            "taxPercentage": 0,
            "creditType": "Credit",
            "creditConversion": {
              "quantityDimension": "string",
              "conversionRate": 0,
              "roundingMode": "string",
              "decimalScale": 0
            }
          }
        },
        "includedQuantity": 0,
        "customCalculateAttributes": {
          "property1": {},
          "property2": {}
        },
        "priceDimensions": [
          {
            "startTime": "2019-08-24T14:15:22Z",
            "endTime": "2019-08-24T14:15:22Z",
            "recordType": "string",
            "priceType": "string",
            "priceDimensionType": "string",
            "source": "string",
            "priceTiers": [
              {
                "tierNumber": 0,
                "startUnit": 0,
                "endUnit": 0,
                "chargeModel": "string",
                "amount": 0,
                "discountPercentage": 0
              }
            ],
            "active": true,
            "fromLastVersion": true
          }
        ],
        "rampItems": [
          {
            "refId": "string",
            "independentPricing": true,
            "productOptionQuantity": 0,
            "quantity": 0,
            "listPrice": 0,
            "startDate": "string",
            "term": 0,
            "product": {
              "id": "string",
              "name": "string",
              "sku": "string",
              "priceModel": "string",
              "recordType": "string",
              "productCategory": "string",
              "freeTrialUnit": 0,
              "freeTrialType": "string",
              "showIncludedProductOptions": true,
              "taxPercentage": 0,
              "creditType": "Credit",
              "creditConversion": {
                "quantityDimension": "string",
                "conversionRate": 0,
                "roundingMode": "string",
                "decimalScale": 0
              }
            },
            "includedUnits": 0,
            "uom": {
              "id": "string",
              "roundingMode": "string",
              "quantityDimension": "string",
              "termDimension": "string",
              "decimalScale": 0
            },
            "discountAmount": 0,
            "discountPercentage": 0,
            "priceDimensions": [
              {
                "id": "string",
                "serialNumber": 0,
                "recordType": "string",
                "priceDimensionType": "string",
                "priceType": "string",
                "active": true,
                "startTime": "2019-08-24T14:15:22Z",
                "endTime": "2019-08-24T14:15:22Z",
                "source": "string",
                "priceTiers": [
                  {
                    "tierNumber": 0,
                    "startUnit": 0,
                    "startUnitDimension": "string",
                    "endUnit": 0,
                    "endUnitDimension": "string",
                    "chargeModel": "string",
                    "amount": 0,
                    "discountPercentage": 0
                  }
                ]
              }
            ],
            "productOption": {
              "id": "string",
              "bundled": true,
              "optionType": "string",
              "defaultQuantity": 0,
              "includedQuantity": 0,
              "quantityEditable": true,
              "optionProduct": {
                "id": "string",
                "name": "string",
                "sku": "string",
                "priceModel": "string",
                "recordType": "string",
                "productCategory": "string",
                "freeTrialUnit": 0,
                "freeTrialType": "string",
                "showIncludedProductOptions": true,
                "taxPercentage": 0,
                "creditType": "Credit",
                "creditConversion": {
                  "quantityDimension": "string",
                  "conversionRate": 0,
                  "roundingMode": "string",
                  "decimalScale": 0
                }
              }
            },
            "evergreen": true,
            "bundled": true
          }
        ],
        "uom": {
          "id": "string",
          "roundingMode": "string",
          "quantityDimension": "string",
          "termDimension": "string",
          "decimalScale": 0
        },
        "bundled": true
      },
      "childrenAssets": [],
      "previewPrice": {
        "totalPrice": 0,
        "totalAmount": 0,
        "todayChargePrice": 0,
        "todayChargeAmount": 0,
        "nextBillingPeriodPrice": 0,
        "nextBillingPeriodAmount": 0
      }
    }
  ],
  "previewPrice": {
    "totalPrice": 0,
    "totalAmount": 0,
    "todayChargePrice": 0,
    "todayChargeAmount": 0,
    "nextBillingPeriodPrice": 0,
    "nextBillingPeriodAmount": 0
  }
}

Properties

Name	Type	Required	Restrictions	Description
assetNumber	string	false	none	none
version	number	false	none	none
term	number	false	none	none
quantity	number	false	none	none
listTotal	number	false	none	none
subtotal	number	false	none	none
totalAmount	number	false	none	none
totalPrice	number	false	none	none
netSalesPrice	number	false	none	none
startDate	string	false	none	none
endDate	string	false	none	none
changes	[PriceCalSubscriptionChange]	false	none	none
orderProduct	AssetPreviewOrderProduct	false	none	none
childrenAssets	[AssetPreviewRequest]	false	none	none
previewPrice	CurrentPreviewPrice	false	none	none

AssetPreviewResponse

{
  "priceSummary": {
    "totalPrice": 0,
    "totalAmount": 0,
    "todayChargePrice": 0,
    "todayChargeAmount": 0,
    "nextBillingPeriodPrice": 0,
    "nextBillingPeriodAmount": 0,
    "nextBillingDate": "string"
  },
  "previewResult": {
    "assetNumber": "string",
    "quantity": 0,
    "term": 0,
    "endDate": "string",
    "startDate": "string",
    "cancellationDate": "string",
    "reconfigureStartDate": "string",
    "convertFreeTrialStartDate": "string",
    "orderPrice": {
      "salesPrice": 0,
      "netSalesPrice": 0,
      "subtotal": 0,
      "listTotal": 0,
      "totalPrice": 0,
      "totalAmount": 0,
      "deltaCMRR": 0,
      "deltaARR": 0,
      "deltaACV": 0,
      "deltaTCV": 0,
      "discountAmount": 0,
      "discountPercentage": 0,
      "systemDiscount": 0,
      "systemDiscountAmount": 0,
      "priceImpacts": [
        {
          "priceDimension": {
            "id": "string",
            "name": "string",
            "description": "string",
            "recordType": "string",
            "priceTagType": "string",
            "startTime": "string",
            "endTime": "string",
            "priceType": "string",
            "active": true,
            "objectId": "string",
            "objectType": "string",
            "code": "string",
            "uomDimension": "string",
            "priceBook": {
              "id": "string",
              "name": "string",
              "description": "string",
              "standard": true,
              "active": true,
              "archived": true,
              "selfServiceEnabled": true,
              "priceAttributes": [
                "Currency"
              ]
            },
            "uom": {
              "id": "string",
              "name": "string",
              "decimalScale": 0,
              "roundingMode": "Up",
              "quantityDimension": "string",
              "termDimension": "string",
              "unitCode": "string"
            },
            "priceTiers": [
              {
                "id": "string",
                "name": "string",
                "amount": 0,
                "chargeModel": "string",
                "discountPercentage": 0,
                "endUnit": 0,
                "endUnitDimension": "string",
                "startUnit": 0,
                "startUnitDimension": "string",
                "tierNumber": 0
              }
            ],
            "publishStatus": "Unpublished",
            "lastPublishedById": "string",
            "lastPublishedDate": "string"
          },
          "priceImpact": 0
        }
      ],
      "refId": "string",
      "rampItems": [
        {
          "salesPrice": 0,
          "netSalesPrice": 0,
          "subtotal": 0,
          "listTotal": 0,
          "totalPrice": 0,
          "totalAmount": 0,
          "deltaCMRR": 0,
          "deltaARR": 0,
          "deltaACV": 0,
          "deltaTCV": 0,
          "discountAmount": 0,
          "discountPercentage": 0,
          "systemDiscount": 0,
          "systemDiscountAmount": 0,
          "priceImpacts": [
            {
              "priceDimension": {
                "id": "string",
                "name": "string",
                "description": "string",
                "recordType": "string",
                "priceTagType": "string",
                "startTime": "string",
                "endTime": "string",
                "priceType": "string",
                "active": true,
                "objectId": "string",
                "objectType": "string",
                "code": "string",
                "uomDimension": "string",
                "priceBook": {
                  "id": "string",
                  "name": "string",
                  "description": "string",
                  "standard": true,
                  "active": true,
                  "archived": true,
                  "selfServiceEnabled": true,
                  "priceAttributes": [
                    "Currency"
                  ]
                },
                "uom": {
                  "id": "string",
                  "name": "string",
                  "decimalScale": 0,
                  "roundingMode": "Up",
                  "quantityDimension": "string",
                  "termDimension": "string",
                  "unitCode": "string"
                },
                "priceTiers": [
                  {
                    "id": "string",
                    "name": "string",
                    "amount": 0,
                    "chargeModel": "string",
                    "discountPercentage": 0,
                    "endUnit": 0,
                    "endUnitDimension": "string",
                    "startUnit": 0,
                    "startUnitDimension": "string",
                    "tierNumber": 0
                  }
                ],
                "publishStatus": "Unpublished",
                "lastPublishedById": "string",
                "lastPublishedDate": "string"
              },
              "priceImpact": 0
            }
          ],
          "endDate": "string",
          "startDate": "string",
          "term": 0,
          "quantity": 0,
          "sortOrder": 0,
          "change": true
        }
      ]
    },
    "billingPrice": {
      "todayChargePrice": 0,
      "todayChargeAmount": 0,
      "nextBillingPeriodPrice": 0,
      "nextBillingPeriodAmount": 0,
      "nextBillingDate": "string"
    },
    "changes": [
      {
        "salesPrice": 0,
        "netSalesPrice": 0,
        "subtotal": 0,
        "listTotal": 0,
        "totalPrice": 0,
        "totalAmount": 0,
        "deltaCMRR": 0,
        "deltaARR": 0,
        "deltaACV": 0,
        "deltaTCV": 0,
        "discountAmount": 0,
        "discountPercentage": 0,
        "systemDiscount": 0,
        "systemDiscountAmount": 0,
        "priceImpacts": [
          {
            "priceDimension": {
              "id": "string",
              "name": "string",
              "description": "string",
              "recordType": "string",
              "priceTagType": "string",
              "startTime": "string",
              "endTime": "string",
              "priceType": "string",
              "active": true,
              "objectId": "string",
              "objectType": "string",
              "code": "string",
              "uomDimension": "string",
              "priceBook": {
                "id": "string",
                "name": "string",
                "description": "string",
                "standard": true,
                "active": true,
                "archived": true,
                "selfServiceEnabled": true,
                "priceAttributes": [
                  "Currency"
                ]
              },
              "uom": {
                "id": "string",
                "name": "string",
                "decimalScale": 0,
                "roundingMode": "Up",
                "quantityDimension": "string",
                "termDimension": "string",
                "unitCode": "string"
              },
              "priceTiers": [
                {
                  "id": "string",
                  "name": "string",
                  "amount": 0,
                  "chargeModel": "string",
                  "discountPercentage": 0,
                  "endUnit": 0,
                  "endUnitDimension": "string",
                  "startUnit": 0,
                  "startUnitDimension": "string",
                  "tierNumber": 0
                }
              ],
              "publishStatus": "Unpublished",
              "lastPublishedById": "string",
              "lastPublishedDate": "string"
            },
            "priceImpact": 0
          }
        ],
        "refId": "string",
        "endDate": "string",
        "startDate": "string",
        "term": 0,
        "quantity": 0,
        "lineType": "string",
        "changeType": "string",
        "changeReferenceId": "string",
        "sortOrder": 0
      }
    ],
    "childrenAssets": [
      {}
    ]
  },
  "previewRequest": {
    "assetNumber": "string",
    "version": 0,
    "term": 0,
    "quantity": 0,
    "listTotal": 0,
    "subtotal": 0,
    "totalAmount": 0,
    "totalPrice": 0,
    "netSalesPrice": 0,
    "startDate": "string",
    "endDate": "string",
    "changes": [
      {
        "refId": "string",
        "version": 0,
        "changeType": "string",
        "lineType": "string",
        "startDate": "string",
        "endDate": "string",
        "term": 0,
        "quantity": 0,
        "productOptionQuantity": 0,
        "listTotal": 0,
        "subtotal": 0,
        "totalAmount": 0,
        "totalPrice": 0,
        "netSalesPrice": 0
      }
    ],
    "orderProduct": {
      "refId": "string",
      "independentPricing": true,
      "productOptionQuantity": 0,
      "quantity": 0,
      "startDate": "string",
      "endDate": "string",
      "term": 0,
      "listPrice": 0,
      "netSalesPrice": 0,
      "discountPercentage": 0,
      "discountAmount": 0,
      "product": {
        "id": "string",
        "name": "string",
        "sku": "string",
        "priceModel": "string",
        "recordType": "string",
        "productCategory": "string",
        "freeTrialUnit": 0,
        "freeTrialType": "string",
        "showIncludedProductOptions": true,
        "taxPercentage": 0,
        "creditType": "Credit",
        "creditConversion": {
          "quantityDimension": "string",
          "conversionRate": 0,
          "roundingMode": "string",
          "decimalScale": 0
        }
      },
      "productOption": {
        "id": "string",
        "bundled": true,
        "optionType": "string",
        "defaultQuantity": 0,
        "includedQuantity": 0,
        "quantityEditable": true,
        "optionProduct": {
          "id": "string",
          "name": "string",
          "sku": "string",
          "priceModel": "string",
          "recordType": "string",
          "productCategory": "string",
          "freeTrialUnit": 0,
          "freeTrialType": "string",
          "showIncludedProductOptions": true,
          "taxPercentage": 0,
          "creditType": "Credit",
          "creditConversion": {
            "quantityDimension": "string",
            "conversionRate": 0,
            "roundingMode": "string",
            "decimalScale": 0
          }
        }
      },
      "includedQuantity": 0,
      "customCalculateAttributes": {
        "property1": {},
        "property2": {}
      },
      "priceDimensions": [
        {
          "startTime": "2019-08-24T14:15:22Z",
          "endTime": "2019-08-24T14:15:22Z",
          "recordType": "string",
          "priceType": "string",
          "priceDimensionType": "string",
          "source": "string",
          "priceTiers": [
            {
              "tierNumber": 0,
              "startUnit": 0,
              "endUnit": 0,
              "chargeModel": "string",
              "amount": 0,
              "discountPercentage": 0
            }
          ],
          "active": true,
          "fromLastVersion": true
        }
      ],
      "rampItems": [
        {
          "refId": "string",
          "independentPricing": true,
          "productOptionQuantity": 0,
          "quantity": 0,
          "listPrice": 0,
          "startDate": "string",
          "term": 0,
          "product": {
            "id": "string",
            "name": "string",
            "sku": "string",
            "priceModel": "string",
            "recordType": "string",
            "productCategory": "string",
            "freeTrialUnit": 0,
            "freeTrialType": "string",
            "showIncludedProductOptions": true,
            "taxPercentage": 0,
            "creditType": "Credit",
            "creditConversion": {
              "quantityDimension": "string",
              "conversionRate": 0,
              "roundingMode": "string",
              "decimalScale": 0
            }
          },
          "includedUnits": 0,
          "uom": {
            "id": "string",
            "roundingMode": "string",
            "quantityDimension": "string",
            "termDimension": "string",
            "decimalScale": 0
          },
          "discountAmount": 0,
          "discountPercentage": 0,
          "priceDimensions": [
            {
              "id": "string",
              "serialNumber": 0,
              "recordType": "string",
              "priceDimensionType": "string",
              "priceType": "string",
              "active": true,
              "startTime": "2019-08-24T14:15:22Z",
              "endTime": "2019-08-24T14:15:22Z",
              "source": "string",
              "priceTiers": [
                {
                  "tierNumber": 0,
                  "startUnit": 0,
                  "startUnitDimension": "string",
                  "endUnit": 0,
                  "endUnitDimension": "string",
                  "chargeModel": "string",
                  "amount": 0,
                  "discountPercentage": 0
                }
              ]
            }
          ],
          "productOption": {
            "id": "string",
            "bundled": true,
            "optionType": "string",
            "defaultQuantity": 0,
            "includedQuantity": 0,
            "quantityEditable": true,
            "optionProduct": {
              "id": "string",
              "name": "string",
              "sku": "string",
              "priceModel": "string",
              "recordType": "string",
              "productCategory": "string",
              "freeTrialUnit": 0,
              "freeTrialType": "string",
              "showIncludedProductOptions": true,
              "taxPercentage": 0,
              "creditType": "Credit",
              "creditConversion": {
                "quantityDimension": "string",
                "conversionRate": 0,
                "roundingMode": "string",
                "decimalScale": 0
              }
            }
          },
          "evergreen": true,
          "bundled": true
        }
      ],
      "uom": {
        "id": "string",
        "roundingMode": "string",
        "quantityDimension": "string",
        "termDimension": "string",
        "decimalScale": 0
      },
      "bundled": true
    },
    "childrenAssets": [
      {}
    ],
    "previewPrice": {
      "totalPrice": 0,
      "totalAmount": 0,
      "todayChargePrice": 0,
      "todayChargeAmount": 0,
      "nextBillingPeriodPrice": 0,
      "nextBillingPeriodAmount": 0
    }
  },
  "assetNumber": "string"
}

Changes preview.

Properties

Name	Type	Required	Restrictions	Description
priceSummary	PreviewPriceSummary	false	none	none
previewResult	AssetPreviewResult	false	none	none
previewRequest	AssetPreviewRequest	false	none	none
assetNumber	string	false	none	none

AssetPreviewResult

{
  "assetNumber": "string",
  "quantity": 0,
  "term": 0,
  "endDate": "string",
  "startDate": "string",
  "cancellationDate": "string",
  "reconfigureStartDate": "string",
  "convertFreeTrialStartDate": "string",
  "orderPrice": {
    "salesPrice": 0,
    "netSalesPrice": 0,
    "subtotal": 0,
    "listTotal": 0,
    "totalPrice": 0,
    "totalAmount": 0,
    "deltaCMRR": 0,
    "deltaARR": 0,
    "deltaACV": 0,
    "deltaTCV": 0,
    "discountAmount": 0,
    "discountPercentage": 0,
    "systemDiscount": 0,
    "systemDiscountAmount": 0,
    "priceImpacts": [
      {
        "priceDimension": {
          "id": "string",
          "name": "string",
          "description": "string",
          "recordType": "string",
          "priceTagType": "string",
          "startTime": "string",
          "endTime": "string",
          "priceType": "string",
          "active": true,
          "objectId": "string",
          "objectType": "string",
          "code": "string",
          "uomDimension": "string",
          "priceBook": {
            "id": "string",
            "name": "string",
            "description": "string",
            "standard": true,
            "active": true,
            "archived": true,
            "selfServiceEnabled": true,
            "priceAttributes": [
              "Currency"
            ]
          },
          "uom": {
            "id": "string",
            "name": "string",
            "decimalScale": 0,
            "roundingMode": "Up",
            "quantityDimension": "string",
            "termDimension": "string",
            "unitCode": "string"
          },
          "priceTiers": [
            {
              "id": "string",
              "name": "string",
              "amount": 0,
              "chargeModel": "string",
              "discountPercentage": 0,
              "endUnit": 0,
              "endUnitDimension": "string",
              "startUnit": 0,
              "startUnitDimension": "string",
              "tierNumber": 0
            }
          ],
          "publishStatus": "Unpublished",
          "lastPublishedById": "string",
          "lastPublishedDate": "string"
        },
        "priceImpact": 0
      }
    ],
    "refId": "string",
    "rampItems": [
      {
        "salesPrice": 0,
        "netSalesPrice": 0,
        "subtotal": 0,
        "listTotal": 0,
        "totalPrice": 0,
        "totalAmount": 0,
        "deltaCMRR": 0,
        "deltaARR": 0,
        "deltaACV": 0,
        "deltaTCV": 0,
        "discountAmount": 0,
        "discountPercentage": 0,
        "systemDiscount": 0,
        "systemDiscountAmount": 0,
        "priceImpacts": [
          {
            "priceDimension": {
              "id": "string",
              "name": "string",
              "description": "string",
              "recordType": "string",
              "priceTagType": "string",
              "startTime": "string",
              "endTime": "string",
              "priceType": "string",
              "active": true,
              "objectId": "string",
              "objectType": "string",
              "code": "string",
              "uomDimension": "string",
              "priceBook": {
                "id": "string",
                "name": "string",
                "description": "string",
                "standard": true,
                "active": true,
                "archived": true,
                "selfServiceEnabled": true,
                "priceAttributes": [
                  "Currency"
                ]
              },
              "uom": {
                "id": "string",
                "name": "string",
                "decimalScale": 0,
                "roundingMode": "Up",
                "quantityDimension": "string",
                "termDimension": "string",
                "unitCode": "string"
              },
              "priceTiers": [
                {
                  "id": "string",
                  "name": "string",
                  "amount": 0,
                  "chargeModel": "string",
                  "discountPercentage": 0,
                  "endUnit": 0,
                  "endUnitDimension": "string",
                  "startUnit": 0,
                  "startUnitDimension": "string",
                  "tierNumber": 0
                }
              ],
              "publishStatus": "Unpublished",
              "lastPublishedById": "string",
              "lastPublishedDate": "string"
            },
            "priceImpact": 0
          }
        ],
        "endDate": "string",
        "startDate": "string",
        "term": 0,
        "quantity": 0,
        "sortOrder": 0,
        "change": true
      }
    ]
  },
  "billingPrice": {
    "todayChargePrice": 0,
    "todayChargeAmount": 0,
    "nextBillingPeriodPrice": 0,
    "nextBillingPeriodAmount": 0,
    "nextBillingDate": "string"
  },
  "changes": [
    {
      "salesPrice": 0,
      "netSalesPrice": 0,
      "subtotal": 0,
      "listTotal": 0,
      "totalPrice": 0,
      "totalAmount": 0,
      "deltaCMRR": 0,
      "deltaARR": 0,
      "deltaACV": 0,
      "deltaTCV": 0,
      "discountAmount": 0,
      "discountPercentage": 0,
      "systemDiscount": 0,
      "systemDiscountAmount": 0,
      "priceImpacts": [
        {
          "priceDimension": {
            "id": "string",
            "name": "string",
            "description": "string",
            "recordType": "string",
            "priceTagType": "string",
            "startTime": "string",
            "endTime": "string",
            "priceType": "string",
            "active": true,
            "objectId": "string",
            "objectType": "string",
            "code": "string",
            "uomDimension": "string",
            "priceBook": {
              "id": "string",
              "name": "string",
              "description": "string",
              "standard": true,
              "active": true,
              "archived": true,
              "selfServiceEnabled": true,
              "priceAttributes": [
                "Currency"
              ]
            },
            "uom": {
              "id": "string",
              "name": "string",
              "decimalScale": 0,
              "roundingMode": "Up",
              "quantityDimension": "string",
              "termDimension": "string",
              "unitCode": "string"
            },
            "priceTiers": [
              {
                "id": "string",
                "name": "string",
                "amount": 0,
                "chargeModel": "string",
                "discountPercentage": 0,
                "endUnit": 0,
                "endUnitDimension": "string",
                "startUnit": 0,
                "startUnitDimension": "string",
                "tierNumber": 0
              }
            ],
            "publishStatus": "Unpublished",
            "lastPublishedById": "string",
            "lastPublishedDate": "string"
          },
          "priceImpact": 0
        }
      ],
      "refId": "string",
      "endDate": "string",
      "startDate": "string",
      "term": 0,
      "quantity": 0,
      "lineType": "string",
      "changeType": "string",
      "changeReferenceId": "string",
      "sortOrder": 0
    }
  ],
  "childrenAssets": [
    {
      "assetNumber": "string",
      "quantity": 0,
      "term": 0,
      "endDate": "string",
      "startDate": "string",
      "cancellationDate": "string",
      "reconfigureStartDate": "string",
      "convertFreeTrialStartDate": "string",
      "orderPrice": {
        "salesPrice": 0,
        "netSalesPrice": 0,
        "subtotal": 0,
        "listTotal": 0,
        "totalPrice": 0,
        "totalAmount": 0,
        "deltaCMRR": 0,
        "deltaARR": 0,
        "deltaACV": 0,
        "deltaTCV": 0,
        "discountAmount": 0,
        "discountPercentage": 0,
        "systemDiscount": 0,
        "systemDiscountAmount": 0,
        "priceImpacts": [
          {
            "priceDimension": {
              "id": "string",
              "name": "string",
              "description": "string",
              "recordType": "string",
              "priceTagType": "string",
              "startTime": "string",
              "endTime": "string",
              "priceType": "string",
              "active": true,
              "objectId": "string",
              "objectType": "string",
              "code": "string",
              "uomDimension": "string",
              "priceBook": {
                "id": "string",
                "name": "string",
                "description": "string",
                "standard": true,
                "active": true,
                "archived": true,
                "selfServiceEnabled": true,
                "priceAttributes": [
                  "Currency"
                ]
              },
              "uom": {
                "id": "string",
                "name": "string",
                "decimalScale": 0,
                "roundingMode": "Up",
                "quantityDimension": "string",
                "termDimension": "string",
                "unitCode": "string"
              },
              "priceTiers": [
                {
                  "id": "string",
                  "name": "string",
                  "amount": 0,
                  "chargeModel": "string",
                  "discountPercentage": 0,
                  "endUnit": 0,
                  "endUnitDimension": "string",
                  "startUnit": 0,
                  "startUnitDimension": "string",
                  "tierNumber": 0
                }
              ],
              "publishStatus": "Unpublished",
              "lastPublishedById": "string",
              "lastPublishedDate": "string"
            },
            "priceImpact": 0
          }
        ],
        "refId": "string",
        "rampItems": [
          {
            "salesPrice": 0,
            "netSalesPrice": 0,
            "subtotal": 0,
            "listTotal": 0,
            "totalPrice": 0,
            "totalAmount": 0,
            "deltaCMRR": 0,
            "deltaARR": 0,
            "deltaACV": 0,
            "deltaTCV": 0,
            "discountAmount": 0,
            "discountPercentage": 0,
            "systemDiscount": 0,
            "systemDiscountAmount": 0,
            "priceImpacts": [
              {
                "priceDimension": {
                  "id": "string",
                  "name": "string",
                  "description": "string",
                  "recordType": "string",
                  "priceTagType": "string",
                  "startTime": "string",
                  "endTime": "string",
                  "priceType": "string",
                  "active": true,
                  "objectId": "string",
                  "objectType": "string",
                  "code": "string",
                  "uomDimension": "string",
                  "priceBook": {
                    "id": "string",
                    "name": "string",
                    "description": "string",
                    "standard": true,
                    "active": true,
                    "archived": true,
                    "selfServiceEnabled": true,
                    "priceAttributes": []
                  },
                  "uom": {
                    "id": "string",
                    "name": "string",
                    "decimalScale": 0,
                    "roundingMode": "Up",
                    "quantityDimension": "string",
                    "termDimension": "string",
                    "unitCode": "string"
                  },
                  "priceTiers": [
                    {}
                  ],
                  "publishStatus": "Unpublished",
                  "lastPublishedById": "string",
                  "lastPublishedDate": "string"
                },
                "priceImpact": 0
              }
            ],
            "endDate": "string",
            "startDate": "string",
            "term": 0,
            "quantity": 0,
            "sortOrder": 0,
            "change": true
          }
        ]
      },
      "billingPrice": {
        "todayChargePrice": 0,
        "todayChargeAmount": 0,
        "nextBillingPeriodPrice": 0,
        "nextBillingPeriodAmount": 0,
        "nextBillingDate": "string"
      },
      "changes": [
        {
          "salesPrice": 0,
          "netSalesPrice": 0,
          "subtotal": 0,
          "listTotal": 0,
          "totalPrice": 0,
          "totalAmount": 0,
          "deltaCMRR": 0,
          "deltaARR": 0,
          "deltaACV": 0,
          "deltaTCV": 0,
          "discountAmount": 0,
          "discountPercentage": 0,
          "systemDiscount": 0,
          "systemDiscountAmount": 0,
          "priceImpacts": [
            {
              "priceDimension": {
                "id": "string",
                "name": "string",
                "description": "string",
                "recordType": "string",
                "priceTagType": "string",
                "startTime": "string",
                "endTime": "string",
                "priceType": "string",
                "active": true,
                "objectId": "string",
                "objectType": "string",
                "code": "string",
                "uomDimension": "string",
                "priceBook": {
                  "id": "string",
                  "name": "string",
                  "description": "string",
                  "standard": true,
                  "active": true,
                  "archived": true,
                  "selfServiceEnabled": true,
                  "priceAttributes": [
                    "Currency"
                  ]
                },
                "uom": {
                  "id": "string",
                  "name": "string",
                  "decimalScale": 0,
                  "roundingMode": "Up",
                  "quantityDimension": "string",
                  "termDimension": "string",
                  "unitCode": "string"
                },
                "priceTiers": [
                  {
                    "id": "string",
                    "name": "string",
                    "amount": 0,
                    "chargeModel": "string",
                    "discountPercentage": 0,
                    "endUnit": 0,
                    "endUnitDimension": "string",
                    "startUnit": 0,
                    "startUnitDimension": "string",
                    "tierNumber": 0
                  }
                ],
                "publishStatus": "Unpublished",
                "lastPublishedById": "string",
                "lastPublishedDate": "string"
              },
              "priceImpact": 0
            }
          ],
          "refId": "string",
          "endDate": "string",
          "startDate": "string",
          "term": 0,
          "quantity": 0,
          "lineType": "string",
          "changeType": "string",
          "changeReferenceId": "string",
          "sortOrder": 0
        }
      ],
      "childrenAssets": []
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
assetNumber	string	false	none	none
quantity	number	false	none	none
term	number	false	none	none
endDate	string	false	none	none
startDate	string	false	none	none
cancellationDate	string	false	none	none
reconfigureStartDate	string	false	none	none
convertFreeTrialStartDate	string	false	none	none
orderPrice	PriceCalChangeOrderResultLineItemPrice	false	none	none
billingPrice	BillingPreviewPrice	false	none	none
changes	[PriceCalChangeOrderResultChangeItem]	false	none	none
childrenAssets	[AssetPreviewResult]	false	none	none

BillingPreviewPrice

{
  "todayChargePrice": 0,
  "todayChargeAmount": 0,
  "nextBillingPeriodPrice": 0,
  "nextBillingPeriodAmount": 0,
  "nextBillingDate": "string"
}

Properties

Name	Type	Required	Restrictions	Description
todayChargePrice	number	false	none	none
todayChargeAmount	number	false	none	none
nextBillingPeriodPrice	number	false	none	none
nextBillingPeriodAmount	number	false	none	none
nextBillingDate	string	false	none	none

ChangeOrderCreateResponse

{
  "order": {
    "billToContactId": "string",
    "customerId": "string",
    "discountAmount": 0,
    "discountPercentage": 0,
    "effectiveDate": "string",
    "id": "string",
    "listTotal": 0,
    "name": "string",
    "poDate": "2019-08-24",
    "poNumber": "string",
    "priceBookId": "string",
    "shipToContactId": "string",
    "status": "string",
    "subtotal": 0,
    "systemDiscount": 0,
    "systemDiscountAmount": 0,
    "taxAmount": 0,
    "totalAmount": 0,
    "totalPrice": 0
  },
  "orderProducts": [
    {
      "actualQuantity": 0,
      "autoRenew": true,
      "billCycleDay": "string",
      "billCycleStartMonth": "string",
      "billingPeriod": "string",
      "billingTiming": "In Advance",
      "carvesEligible": true,
      "carvesLiabilitySegment": "string",
      "carvesRevenueSegment": "string",
      "change": true,
      "contractLiabilitySegment": "string",
      "contractRevenueSegment": "string",
      "currencyIsoCode": "string",
      "customerId": "string",
      "deltaACV": 0,
      "deltaARR": 0,
      "deltaCMRR": 0,
      "deltaTCV": 0,
      "description": "string",
      "discount": 0,
      "discountAmount": 0,
      "entity": {},
      "entityId": "string",
      "evergreen": true,
      "id": "string",
      "includedUnits": 0,
      "isChange": true,

Introduction

Authentication

JWT

Responses

Basic

Errors

Tenants and Users v1.0

Authentication

Login History

Get Login History

Parameters

Responses

Response Schema

Enumerated Values

Get User Login History

Parameters

Responses

Response Schema

Enumerated Values

Users and Roles

Get User Roles

Parameters

Responses

Response Schema

Get Connected Salesforce User

Responses

Get User Profile

Parameters

Responses

Get Function Policies

Responses

Response Schema

Get Roles

Responses

Response Schema

Get Role

Parameters

Responses

Access Tokens

Verify Token

Parameters

Responses

Response Schema

Get Access Token

Parameters

Responses

Response Schema

Revoke refresh token

Parameters

Responses

Refresh Token

Parameters

Responses

Response Schema

Schemas

TokenVerificationRequest

Properties

AuthenticationResult

Properties

Challenge

Properties

UserMappedTenantResponse

Properties

AuthenticationRequest

Properties

RevokeTokenRequest

Properties

TokenRefreshRequest

Properties

Function

Properties

FunctionPolicy

Properties

UserRole

Properties

SalesforceUserIntegration

Properties

Address

Properties

GetUserResult