Attribute Naming Convention, Data Types and Formats

Attribute names are case sensitive and use camelCase, a naming convention in which each word within a compound word is capitalized except for the first word. Attribute names do not include dash and underscore characters. For example, note the initial lowercase t and the uppercase L and I for the taxLocationId ExpenseReport attribute, which corresponds to the tax_location_id field in the Envelope table described in the SuiteProjects Pro Data Dictionary, or tax_locationid in the oaEnvelope SOAP API complex type and <Envelope> XML API data type.

The REST API uses data types and formats defined by the OpenAPI Specification (OAS). The OAS identifies four primitive data types: Boolean, integer, number, and string. Primitive data types have an optional modifier property: format. The REST API uses several known formats to define the data type used for each attribute in the JSON-encoded requests and responses. In this guide and in the generated API reference documentation, the following notation is used to indicate the data type and format: type($format).

The following tables shows the data types and formats used by the REST API:

type	format	Notation	Description
Boolean		`Boolean`	true / false
integer	int64	`integer($int64)`	long integer
number	double	`number($double)`	double precision floating point number
number	float	`number($float)`	single precision floating point number
string		`string`	string of unicode code points Note: Some SuiteProjects Pro accounts may be configured to use UTF-8 character encoding instead of Latin1. The REST API supports both Latin1 and UTF-8 encoded characters in the response.
string	date	`string($date)`	string using the date format `YYYY-MM-DD`, where `YYYY` is the four-digit year, `MM` the two-digit month, and `DD` the two-digit day of the month — Example: `2020–09–19`
string	date-time	`string($date-time)`	string using the date-time format `YYYY-MM-DD hh:mm:ss`, where `hh` is the two-digit hours, `mm` the two-digit minutes, and `ss` the two-digit seconds — Example: `2020–09–19 17:56:38` Note: This format is used for system-generated and read-only fields. The format applies to the following attributes in the data returned: `created`, `updated`, and `exported`. Note however that the `date-time` format is not supported in query expressions used for Filtering.

type

format

Notation

Description

Boolean

Boolean

true / false

integer

int64

integer($int64)

long integer

number

double

number($double)

double precision floating point number

number

float

number($float)

single precision floating point number

string

string

string of unicode code points

Note:

Some SuiteProjects Pro accounts may be configured to use UTF-8 character encoding instead of Latin1. The REST API supports both Latin1 and UTF-8 encoded characters in the response.

string

date

string($date)

string using the date format YYYY-MM-DD, where YYYY is the four-digit year, MM the two-digit month, and DD the two-digit day of the month — Example: 2020–09–19

string

date-time

string($date-time)

string using the date-time format YYYY-MM-DD hh:mm:ss, where hh is the two-digit hours, mm the two-digit minutes, and ss the two-digit seconds — Example: 2020–09–19 17:56:38

Note:

This format is used for system-generated and read-only fields. The format applies to the following attributes in the data returned: created, updated, and exported.

Note however that the date-time format is not supported in query expressions used for Filtering.