NetSuite REST API Browser: Record API v1
https://[accountid].suitetalk.api.netsuite.com/services/rest/record/v1
account
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
accountingBook
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
accountingContext
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
accountingPeriod
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
advIntercompanyJournalEntry
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
allocationSchedule
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
amortizationSchedule
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
amortizationTemplate
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
assemblyBuild
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
Transform to assemblyUnbuild.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Internal identifier.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Transformed record.
Error response.
assemblyItem
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
Transform to assemblyBuild.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Internal identifier.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Transformed record.
Error response.
Transform to workOrder.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Internal identifier.
assemblyUnbuild
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
billingAccount
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
billingClass
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
billingRateCard
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
billingRevenueEvent
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
billingSchedule
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
bin
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
binTransfer
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
binWorksheet
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
blanketPurchaseOrder
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
bom
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
bomRevision
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
bonus
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
budgetExchangeRate
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
bulkOwnershipTransfer
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
calendarEvent
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
campaign
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
campaignResponse
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
campaignTemplate
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
cardholderAuthentication
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
cashRefund
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
Transform to creditMemo.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Internal identifier.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Transformed record.
Error response.
cashSale
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
Transform to cashRefund.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Internal identifier.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Transformed record.
Error response.
Transform to returnAuthorization.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Internal identifier.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Transformed record.
Error response.
charge
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
chargeRule
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
check
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
classification
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
cmscontent
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
cmscontenttype
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
commerceCategory
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
competitor
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
consolidatedExchangeRate
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
contact
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
contactCategory
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
contactRole
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
costCategory
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
couponCode
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
creditCardCharge
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
creditCardRefund
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
creditMemo
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
currency
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
customer
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
Transform to cashSale.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Internal identifier.
Transform to customerPayment.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Internal identifier.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Transformed record.
Error response.
Transform to estimate.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Internal identifier.
Transform to invoice.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Internal identifier.
Transform to opportunity.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Internal identifier.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Transformed record.
Error response.
Transform to salesOrder.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Internal identifier.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Transformed record.
Error response.
Transform to vendor.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Internal identifier.
customerCategory
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
customerDeposit
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
Transform to customerRefund.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Internal identifier.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Transformed record.
Error response.
Transform to depositApplication.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Internal identifier.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Transformed record.
Error response.
customerMessage
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
customerPayment
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
Transform to customerRefund.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Internal identifier.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Transformed record.
Error response.
customerPaymentAuthorization
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
Transform to customerDeposit.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Internal identifier.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Transformed record.
Error response.
Transform to customerPayment.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Internal identifier.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Transformed record.
Error response.
customerRefund
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
customerStatus
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
customerSubsidiaryRelationship
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
department
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
deposit
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
depositApplication
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
descriptionItem
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
discountItem
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
downloadItem
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
emailTemplate
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
employee
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
Transform to expenseReport.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Internal identifier.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Transformed record.
Error response.
Transform to timeBill.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Internal identifier.
employeeExpenseSourceType
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
entityAccountMapping
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
estimate
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
Transform to cashSale.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Internal identifier.
Transform to invoice.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Internal identifier.
Transform to salesOrder.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Internal identifier.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Transformed record.
Error response.
expenseCategory
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
expenseReport
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
expenseReportPolicy
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
fairValuePrice
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
fixedAmountProjectRevenueRule
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
fulfillmentRequest
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
genericResource
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
giftCertificate
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
giftCertificateItem
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
globalAccountMapping
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
globalInventoryRelationship
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
importedEmployeeExpense
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
inboundShipment
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
intercompanyJournalEntry
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
intercompanyTransferOrder
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
Transform to itemFulfillment.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Internal identifier.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Transformed record.
Error response.
Transform to itemReceipt.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Internal identifier.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Transformed record.
Error response.
inventoryAdjustment
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
inventoryCostRevaluation
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
inventoryCount
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
inventoryItem
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
inventoryNumber
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
inventoryStatus
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
inventoryStatusChange
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
inventoryTransfer
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
invoice
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
Transform to creditMemo.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Internal identifier.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Transformed record.
Error response.
Transform to customerPayment.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Internal identifier.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Transformed record.
Error response.
Transform to returnAuthorization.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Internal identifier.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Transformed record.
Error response.
issue
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
issueProduct
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
itemAccountMapping
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
itemDemandPlan
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
itemFulfillment
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
itemGroup
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
itemLocationConfiguration
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
itemReceipt
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
itemRevision
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
itemSupplyPlan
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
job
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
Transform to cashSale.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Internal identifier.
Transform to estimate.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Internal identifier.
Transform to invoice.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Internal identifier.
Transform to salesOrder.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Internal identifier.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Transformed record.
Error response.
jobStatus
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
jobType
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
journalEntry
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
kitItem
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
laborBasedProjectRevenueRule
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
location
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
manufacturingCostTemplate
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
manufacturingOperationTask
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
manufacturingRouting
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
markupItem
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
merchandiseHierarchyLevel
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
merchandiseHierarchyNode
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
merchandiseHierarchyVersion
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
message
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
nexus
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
nonInventoryPurchaseItem
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
nonInventoryResaleItem
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
nonInventorySaleItem
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
note
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
noteType
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
opportunity
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
Transform to cashSale.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Internal identifier.
Transform to estimate.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Internal identifier.
Transform to invoice.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Internal identifier.
Transform to salesOrder.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Internal identifier.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Transformed record.
Error response.
orderReservation
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
otherChargePurchaseItem
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
otherChargeResaleItem
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
otherChargeSaleItem
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
otherName
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
otherNameCategory
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
partner
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
partnerCategory
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
paycheck
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
paycheckJournal
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
paymentItem
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
paymentMethod
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
payrollItem
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
pctCompleteProjectRevenueRule
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
periodEndJournal
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
phoneCall
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
plannedOrder
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
planningItemCategory
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
planningItemGroup
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
planningRuleGroup
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
planningView
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
priceBook
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
priceLevel
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
pricePlan
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
pricingGroup
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
projectExpenseType
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
projectIcChargeRequest
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
projectTask
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
projectTemplate
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
promotionCode
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
purchaseContract
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
purchaseOrder
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
Transform to itemReceipt.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Internal identifier.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Transformed record.
Error response.
Transform to vendorBill.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Internal identifier.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Transformed record.
Error response.
Transform to vendorReturnAuthorization.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Internal identifier.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Transformed record.
Error response.
purchaseRequisition
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
Transform to purchaseOrder.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Internal identifier.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Transformed record.
Error response.
receiveInboundShipment
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
resourceAllocation
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
returnAuthorization
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
Transform to cashRefund.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Internal identifier.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Transformed record.
Error response.
Transform to creditMemo.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Internal identifier.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Transformed record.
Error response.
Transform to itemReceipt.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Internal identifier.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Transformed record.
Error response.
Transform to revenueCommitmentReversal.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Internal identifier.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Transformed record.
Error response.
revRecSchedule
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
revRecTemplate
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
revenueArrangement
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
revenueCommitment
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
revenueCommitmentReversal
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
revenuePlan
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
salesChannel
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
salesOrder
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
Transform to cashSale.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Internal identifier.
Transform to fulfillmentRequest.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Internal identifier.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Transformed record.
Error response.
Transform to invoice.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Internal identifier.
Transform to itemFulfillment.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Internal identifier.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Transformed record.
Error response.
Transform to returnAuthorization.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Internal identifier.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Transformed record.
Error response.
Transform to revenueCommitment.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Internal identifier.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Transformed record.
Error response.
Transform to storePickupFulfillment.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Internal identifier.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Transformed record.
Error response.
salesRole
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
salesTaxItem
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
servicePurchaseItem
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
serviceResaleItem
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
serviceSaleItem
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
shipItem
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
solution
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
statisticalJournalEntry
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
storePickupFulfillment
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
subscription
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
subscriptionChangeOrder
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
subscriptionLine
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
subscriptionPlan
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
subscriptionTerm
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
subsidiary
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
subtotalItem
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
supplyChainSnapshot
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
supplyChainSnapshotSimulation
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
supplyChangeOrder
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
supplyPlanDefinition
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
supportCase
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
task
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
taxAcct
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
taxGroup
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
taxPeriod
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
taxType
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
term
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
timeBill
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
timeEntry
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
timeSheet
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
topic
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
transferOrder
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
Transform to itemFulfillment.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Internal identifier.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Transformed record.
Error response.
Transform to itemReceipt.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Internal identifier.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Transformed record.
Error response.
unitsType
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
usage
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
vendor
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
Transform to customer.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Internal identifier.
Transform to purchaseOrder.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Internal identifier.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Transformed record.
Error response.
Transform to vendorBill.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Internal identifier.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Transformed record.
Error response.
Transform to vendorPayment.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Internal identifier.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Transformed record.
Error response.
vendorBill
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
Transform to vendorCredit.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Internal identifier.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Transformed record.
Error response.
Transform to vendorPayment.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Internal identifier.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Transformed record.
Error response.
Transform to vendorReturnAuthorization.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Internal identifier.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Transformed record.
Error response.
vendorCategory
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
vendorCredit
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
vendorPayment
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
vendorReturnAuthorization
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
Transform to itemFulfillment.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Internal identifier.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Transformed record.
Error response.
Transform to vendorCredit.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Internal identifier.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Transformed record.
Error response.
vendorSubsidiaryRelationship
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
webSite
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
workOrder
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
Transform to assemblyBuild.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Internal identifier.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Transformed record.
Error response.
Transform to workOrderClose.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Internal identifier.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Transformed record.
Error response.
Transform to workOrderCompletion.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Internal identifier.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Transformed record.
Error response.
Transform to workOrderIssue.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Internal identifier.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Transformed record.
Error response.
workOrderClose
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
workOrderCompletion
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
workOrderIssue
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
application/vnd.oracle.resource+json; type=singular application/vnd.oracle.resource+json; type=error
Retrieved record.
Error response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
workplace
Get list of records.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The search query that is used to filter results.
The limit used to specify the number of results on a single page.
The offset used for selecting a specific page of results.
application/vnd.oracle.resource+json; type=collection application/vnd.oracle.resource+json; type=error
List of records.
Error response.
Insert record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
application/vnd.oracle.resource+json; type=error
Inserted record.
Error response.
Remove record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
application/vnd.oracle.resource+json; type=error
Removed record.
Error response.
Get record.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record.
Set to true to return enumeration values in a format that only shows the internal ID value.
The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response.
Update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
Internal identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Updated record.
Error response.
Insert or update record.
Request body.
The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response.
A user-defined unique idempotency key that is applied to every asynchronous requests to ensure that the request is executed only once. Only one request can be executed with every unique idempotency key. Use UUID in string format as defined by RFC 4122. If the request is executed synchronously, this value is ignored.
External identifier.
Sets the strictness of property name validation.
Sets the strictness of property value validation.
The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The sublists not specified here will have lines added to the record. The names are delimited by comma.
If set to 'true', all fields that should be deleted in the update request, including body fields, must be included in the 'replace' query parameter.
application/vnd.oracle.resource+json; type=error
Upserted record.
Error response.
Schema Definitions
account
This record is available as a beta record.
- accountContextSearch: account-accountContextSearchCollection
- accountSearchDisplayName Display Name: string
- accountSearchDisplayNameCopy Name: string
- acctName Name: string
-
Enter up to 31 characters for an account name that will appear on all reports. If you want to use GL account numbers and do not see a Number field above the Name field, go to Setup > Accounting > Preferences > Accounting Preferences, and check the Use Account Numbers box. Save the preference, and return to this page.
- acctNumber Number: string
-
Enter the number to identify this account. The number can be alphanumeric. The maximum number of characters is 60.
- acctType: object
-
- id Internal identifier.: string
- refName Reference Name: string
- availableBalance Available Balance: number (double)
- bach Use ACH: boolean
-
Check this box to signify this is an account used with ACH processing. ACH processing is used for the Electronic Funds Transfer (EFT) and Direct Deposit features.
- balance Balance: number (double)
- billableExpensesAcct: account
- cashFlowRate: object
-
- id Internal identifier.: string AVERAGE , HISTORICAL , CURRENT
- refName Reference Name: string
- category1099Misc: nsResource
- class: classification
- curDocNum Next Check Number: integer (int64)
-
Enter a number to reset the default check number that appears on transactions such as checks and bill payments. By default, this field shows the highest check number in the account plus one. The number you enter in the Next Check Number field of the account record determines the number that appears in the Check Number field on transactions linked to that account.
- currency: currency
- deferralAcct: account
- department: department
- description Description: string
-
Enter a description for this account.
- displayNameWithHierarchy Display Name (with hierarchy): string
- eliminate Eliminate Intercompany Transactions: boolean
-
Check this box to make this account an intercompany account. Intercompany accounts are used to record transactions between subsidiaries. You can post both intercompany transactions and non-intercompany transactions to most intercompany accounts. Intercompany Accounts Receivable and Intercompany Accounts Payable, however, can be used only for recording amounts that are candidates for eliminations. For details, see the help topic Intercompany Accounts.
- externalId External ID: string
- fullName Full Name: string
- generalRate: object
-
- id Internal identifier.: string AVERAGE , HISTORICAL , CURRENT
- refName Reference Name: string
- id Internal ID: string
- includeChildren Include Children: boolean
-
Check the Include Children box to share the account with all the sub-subsidiaries associated with each subsidiary selected in the Subsidiary field.
- inventory Inventory: boolean
-
If this will be an Other Current Asset account and you want the balance of this account included in the total balance of the Inventory KPI, select the Inventory box.
- isInactive Inactive: boolean
-
Check this box to inactivate this account. Inactive accounts do not show in lists on transactions and records.
- issummary Summary: boolean
-
Check this box to make this account record solely for reporting purposes. Summary accounts are useful when you want to create a non-posting, inactive parent account that has active child accounts. If you do not have a OneWorld account, new summary accounts cannot have an opening balance, but you can convert an existing account with a transaction balance into a summary account. In this case, you cannot post additional transactions to the account. Summary accounts appear with their children in the chart of accounts list. You cannot merge a summary account into another account.
- lastModifiedDate Last Modified Date: string (date-time)
- legalName Legal Name: string
-
If the Use Legal Name in Account accounting preference is enabled at Setup > Accounting > Preferences > Accounting Preferences, the Legal Name field appears. You can enter up to 400 characters in this field including special characters such as colon and semi colon. You can also enter characters such as Éé,Çç, and 2 byte characters such as 会計、科目. This field is useful in countries where the legal name of an entity is required by law. The Legal Name field can be added to financial reports where account is an available component. It is also available in advanced searches, SuiteScript, and ODBC. System notes maintains an audit trail specific to the activity on the Legal Name field.
- links Links: nsLink
-
nsLink - localizations: account-localizationsCollection
- location: location
- mmaxamtpertran Maximum Amount Per Transaction: number (double)
-
Enter the dollar amount limit per transaction with this account.
- openingBalance Opening Balance: number (double)
-
Enter an opening balance for this account.
- parent: account
- reconcilewithmatching Use Match Bank Data and Reconcile Account Statement Pages: boolean
-
Check this box if you want to use the Confirm Transaction Matches and Reconcile Account Statement pages for this account. The original reconciliation pages are still available. To use the original pages, clear the box.
- refName Reference Name: string
- restricttoaccountingbook: accountingBookCollection
- revalue Revalue Open Balance for Foreign Currency Transactions: boolean
-
Check this box to select this account for open balance currency revaluation.
- sBankCompanyId Bank Account Number: string
-
Enter the bank account number, up to 20 digits.
- sBankName Bank Name: string
-
Enter the name of your bank.
- sBankRoutingNumber Bank Routing Number: string
-
Enter the 9-digit routing number for this bank account.
- sSpecAcct: object
-
- id Internal identifier.: string CommPay , DeferExpense , UnbilledRec , SalesTaxPay , Tax , PSTPay , CumulTransAdj , RevArrng , DefRevClearing , Opprtnty , PSTExp , PayUnemp , RefundPay , TrnfrOrd , FailedACH , AccumDeprec , OpeningBalEquity , PayWage , RecvNotBill , SalesOrd , PayrollLiab , UnrERV , PayrollFloat , DirectLabor , UnappvPymt , InterCoPayRec , IndirectLabor , PurchOrd , MbHtpOffsetAcct , PayLocal , PayState , PayMed , InvInTransit , RealizedERV , RetEarnings , ClearingPymt , PayrollExp , TaxLiability , AdvPaid , GSTPay , Estimate , FxRateVariance , COGS , MatchingUnrERV , RtnAuth , InvtAsset , Tegata , PayFed , AcctRec , DeferRevenue , UncatExpense , WorkOrd , UnappvExpRept , CustAuth , JobCostVariance , VendAuth , RndERV , PayrollWage , CustDep , UncatIncome , PurchReq , RtnNotCredit , Netting , PayComm , PayAdjst , AcctPay , InvInTransitExt , PaySS , UndepFunds , CTA-E
- refName Reference Name: string
- sachmsg ACH Message: string
-
Enter a default ACH message for this account.
- subsidiary: subsidiaryCollection
- tranDate Date: string (date)
-
Enter the date of the opening balance of this account.
- unit Default Unit: string
-
This field displays the base unit assigned to the Unit Type. The default unit cannot be changed.
- unitsType: unitsType
account-accountContextSearchCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: account-accountContextSearchElement
-
account-accountContextSearchElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
account-accountContextSearchElement
This record is available as a beta record.
- accountingcontext: accountingContext
- acctname Name: string
- acctnumber Number: string
- legalName Legal Name: string
- links Links: nsLink
-
nsLink - locale: object
-
- id Internal identifier.: string it_CH , en_TC , af_ZA , es_EA , es_EC , pt_BR , en_CY , fr_LU , nl_AN , es_UY , en_TT , es_ES , pt_ST , en_DM , en_TZ , es_ES_EURO , fr_ML , de_DE_onLQA , es_VE , nl_BE , da_DK , pt_AO , to_TO , en_UG , am_ET , ss_SZ , nl_BQ , ar , pt_AW , ko_KR , en_US , fr_BE_EURO , ko_KP , si_AQ , fr_MG , el_GR , be_BY , en_AU , he_IL , en_AW , es_SV , en_BB , ar_YE , es_CO , es_CL , en_BM , es_CR , pa_IN , en_SC , en_BS , sm_WS , it_IT_EURO , fr_KM , es_CU , en_SB , en_SG , en_BW , en_SH , en_BZ , en_SL , az_AZ , fi_FI , en_SS , sr_YU , en_CD , en_CA , ka_GE , lv_LV , uk_UA , es_DO , ur_PK , ar_IQ , fr_LU_EURO , pt_PT , fr_FR_EURO , en_PH , th_TH , bn_BD , si_LK , en_PG , hu_HU , ar_SA , ar_SD , ru_KZ , ar_BH , nl_BE_EURO , ro_MD , en_QA , ru_KG , es_AR , ta_IN , sr_RS , aa_ER , en , de_DE_EURO , zh_MO , en_AE , ar_SY , es_BO , en_AI , no_NO , en_AG , nl_SR , fr_VU , en_MW , gu_AQ , ar_TN , nl_SX , hi_IN , en_NA , mn_MN , en_NG , fr_FR , ms_MY , nl_CW , uz_UZ , ar_DJ , sr_CS , de_AT_EURO , en_NZ , es_PE , es_PA , fa_IR , ar_DZ , fr_GN , lb_LU , xx_US , pt_CV , sh_RS , ht_HT , fr_WF , es_AR_onLQA , es_PR , ar_EG , es_PY , fr_GA , en_KW , de_AT , ro_RO , en_KY , fr_FR_onLQA , fr_DJ , ca_ES_EURO , cs_CZ , en_LC , pl_AQ , fr_TD , fr_TG , es_MX , sv_AX , sk_SK , en_LR , en_LS , ar_OM , dz_BT , te_IN , de_LU_EURO , sq_AL , sv_SE , sn_ZW , es_NI , en_IE_EURO , my_MM , en_MF , en_MU , it_IT , pl_PL , fr_BE , fr_BF , tr_TR , fr_BI , fr_BJ , id_ID , fr_RW , en_ZM , km_KH , ja_JP , de_DE , fr_BL , tg_TJ , ar_QA , de_CH , zh_HK , pt_PT_EURO , en_JO , en_JM , fr_CA , nl_NL_EURO , fr_CF , fr_CG , fr_CD , pa_AQ , fr_CH , xx_US_wthId , fr_CI , pt_GW , vi_VN , ru_MD , fr_CM , fr_SC , en_KE , ne_NP , bs_BA , sl_SI , en_KN , fr_SN , ar_AE , en_GY , tl_PH , ca_ES , es_IC , lo_LA , kn_IN , so_SO , fr_PF , ar_JO , nl_NL , is_IS , fi_FI_EURO , pt_MZ , sk_SK_EURO , sl_SI_EURO , en_IE , ms_BN , hr_HR , ar_KW , de_LU , lt_LT , en_IN , ps_AF , en_ZA , en_VC , ru_RU , sh_YU , ar_LB , mr_IN , dv_MV , fj_FJ , zh_TW , tk_TM , ar_LY , en_VU , fr_NE , en_FK , es_GT , fr_NC , es_GQ , fa_AF , bg_BG , hy_AM , en_CY_EURO , mk_MK , ar_MA , en_GD , en_GB , es_HN , gu_IN , en_GH , et_EE , en_GI , zh_CN , en_GM , ar_MR
- refName Reference Name: string
- refName Reference Name: string
account-localizationsCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: account-localizationsElement
-
account-localizationsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
account-localizationsElement
This record is available as a beta record.
- accountingcontext: accountingContext
- acctname Name: string
- acctnumber Number: string
- legalName Legal Name: string
- links Links: nsLink
-
nsLink - locale: object
-
- id Internal identifier.: string it_CH , en_TC , af_ZA , es_EA , es_EC , pt_BR , en_CY , fr_LU , nl_AN , es_UY , en_TT , es_ES , pt_ST , en_DM , en_TZ , es_ES_EURO , fr_ML , de_DE_onLQA , es_VE , nl_BE , da_DK , pt_AO , to_TO , en_UG , am_ET , ss_SZ , nl_BQ , ar , pt_AW , ko_KR , en_US , fr_BE_EURO , ko_KP , si_AQ , fr_MG , el_GR , be_BY , en_AU , he_IL , en_AW , es_SV , en_BB , ar_YE , es_CO , es_CL , en_BM , es_CR , pa_IN , en_SC , en_BS , sm_WS , it_IT_EURO , fr_KM , es_CU , en_SB , en_SG , en_BW , en_SH , en_BZ , en_SL , az_AZ , fi_FI , en_SS , sr_YU , en_CD , en_CA , ka_GE , lv_LV , uk_UA , es_DO , ur_PK , ar_IQ , fr_LU_EURO , pt_PT , fr_FR_EURO , en_PH , th_TH , bn_BD , si_LK , en_PG , hu_HU , ar_SA , ar_SD , ru_KZ , ar_BH , nl_BE_EURO , ro_MD , en_QA , ru_KG , es_AR , ta_IN , sr_RS , aa_ER , en , de_DE_EURO , zh_MO , en_AE , ar_SY , es_BO , en_AI , no_NO , en_AG , nl_SR , fr_VU , en_MW , gu_AQ , ar_TN , nl_SX , hi_IN , en_NA , mn_MN , en_NG , fr_FR , ms_MY , nl_CW , uz_UZ , ar_DJ , sr_CS , de_AT_EURO , en_NZ , es_PE , es_PA , fa_IR , ar_DZ , fr_GN , lb_LU , xx_US , pt_CV , sh_RS , ht_HT , fr_WF , es_AR_onLQA , es_PR , ar_EG , es_PY , fr_GA , en_KW , de_AT , ro_RO , en_KY , fr_FR_onLQA , fr_DJ , ca_ES_EURO , cs_CZ , en_LC , pl_AQ , fr_TD , fr_TG , es_MX , sv_AX , sk_SK , en_LR , en_LS , ar_OM , dz_BT , te_IN , de_LU_EURO , sq_AL , sv_SE , sn_ZW , es_NI , en_IE_EURO , my_MM , en_MF , en_MU , it_IT , pl_PL , fr_BE , fr_BF , tr_TR , fr_BI , fr_BJ , id_ID , fr_RW , en_ZM , km_KH , ja_JP , de_DE , fr_BL , tg_TJ , ar_QA , de_CH , zh_HK , pt_PT_EURO , en_JO , en_JM , fr_CA , nl_NL_EURO , fr_CF , fr_CG , fr_CD , pa_AQ , fr_CH , xx_US_wthId , fr_CI , pt_GW , vi_VN , ru_MD , fr_CM , fr_SC , en_KE , ne_NP , bs_BA , sl_SI , en_KN , fr_SN , ar_AE , en_GY , tl_PH , ca_ES , es_IC , lo_LA , kn_IN , so_SO , fr_PF , ar_JO , nl_NL , is_IS , fi_FI_EURO , pt_MZ , sk_SK_EURO , sl_SI_EURO , en_IE , ms_BN , hr_HR , ar_KW , de_LU , lt_LT , en_IN , ps_AF , en_ZA , en_VC , ru_RU , sh_YU , ar_LB , mr_IN , dv_MV , fj_FJ , zh_TW , tk_TM , ar_LY , en_VU , fr_NE , en_FK , es_GT , fr_NC , es_GQ , fa_AF , bg_BG , hy_AM , en_CY_EURO , mk_MK , ar_MA , en_GD , en_GB , es_HN , gu_IN , en_GH , et_EE , en_GI , zh_CN , en_GM , ar_MR
- refName Reference Name: string
- refName Reference Name: string
accountCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: account
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
account - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
accountingBook
This record is available as a beta record.
- accountingBookSubsidiaries: accountingBook-accountingBookSubsidiariesCollection
- baseBook: accountingBook
- contingentrevenuehandling Enable contingent revenue handling: boolean
-
Check this box to enable contingent revenue handling. When enabled, fields are added to item records and revenue elements for contingent revenue.
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- effectivePeriod: accountingPeriod
- externalId External ID: string
- firstBasePeriod: accountingPeriod
- id Internal ID: string
- includeChildren Include Children: boolean
-
This check box is for display purposes only. Any child subsidiaries of the subsidiaries you select are automatically associated with this accounting book. You cannot select a parent and only one of its children.
- isAdjustmentOnly Adjustment Only: boolean
-
When this box is checked, your secondary accounting book is created as an adjustment-only book. Adjustment-only books differ from standard secondary books in that they do not duplicate the data in the primary book. Instead, adjustments to data from the primary book are made in the adjustment book. You can display financial reports on the data combined from both the primary book and adjustment book in reports and searches. You can also create budgets for adjustment-only books. Adjustment-only books do not count against the accounting book limit.
- isConsolidated Enable Consolidation: boolean
-
Check this box to enable this secondary accounting book for consolidation. Secondary books enabled for consolidation have access to all OneWorld consolidation including all tasks on the period close check list, consolidated reporting, auto-elimination, and book specific consolidated exchange rates. Primary accounting books are enabled for consolidation by default.
- isPrimary Is Primary: boolean
-
This box is for display purposes only. It cannot be checked for secondary accounting books. It cannot be cleared for the primary accounting book.
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - name Name: string
-
Enter a unique name for the accounting book. This name appears in fields and lists when a choice of accounting book is available.
- refName Reference Name: string
- subsidiariesString Subsidiaries: string
- subsidiary: subsidiaryCollection
- twosteprevenueallocation Enable two step revenue allocation: boolean
-
Clear this box to turn off two-step allocation. When this box is checked, two-step allocation is used only when the Allocation Type is Software. When the conditions are met that trigger the residual method, the second step of allocation takes place.
- unbilledreceivablegrouping: object
-
- id Internal identifier.: string SUBARRANGEMENTGROUP , ELEMENT , ARRANGEMENT
- refName Reference Name: string
accountingBook-accountingBookSubsidiariesCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: accountingBook-accountingBookSubsidiariesElement
-
accountingBook-accountingBookSubsidiariesElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
accountingBook-accountingBookSubsidiariesElement
This record is available as a beta record.
- currency: currency
- effectiveDate Effective Date: string (date)
- elimination Elimination: boolean
- enablePeriodEndJournals Enable Period End Journal Entries: boolean
- exchangeRate Translation Exchange Rate: number (double)
- links Links: nsLink
-
nsLink - parentSubsidiary Parent Subsidiary: string
- primaryBookCurrency: currency
- primaryBookCurrencySelect: currency
- refName Reference Name: string
- status: object
-
- id Internal identifier.: string ACTIVE , INACTIVE , PENDING
- refName Reference Name: string
- statusOrd Order: integer (int64)
- subsidiary: subsidiary
- subsidiaryName Subsidiary Name: string
accountingBookCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: accountingBook
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
accountingBook - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
accountingContext
This record is available as a beta record.
- externalId External ID: string
- id Internal ID: string
- links Links: nsLink
-
nsLink - name Name: string
-
A name that identifies the region. A region represents a geographical area - based on country, state, or postal code - in which a shipping address is located.
- refName Reference Name: string
- translations: accountingContext-translationsCollection
accountingContext-translationsCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: accountingContext-translationsElement
-
accountingContext-translationsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
accountingContext-translationsElement
This record is available as a beta record.
- language Language: string
- links Links: nsLink
-
nsLink - locale: object
-
- id Internal identifier.: string it_CH , en_TC , af_ZA , es_EA , es_EC , pt_BR , en_CY , fr_LU , nl_AN , es_UY , en_TT , es_ES , pt_ST , en_DM , en_TZ , es_ES_EURO , fr_ML , de_DE_onLQA , es_VE , nl_BE , da_DK , pt_AO , to_TO , en_UG , am_ET , ss_SZ , nl_BQ , ar , pt_AW , ko_KR , en_US , fr_BE_EURO , ko_KP , si_AQ , fr_MG , el_GR , be_BY , en_AU , he_IL , en_AW , es_SV , en_BB , ar_YE , es_CO , es_CL , en_BM , es_CR , pa_IN , en_SC , en_BS , sm_WS , it_IT_EURO , fr_KM , es_CU , en_SB , en_SG , en_BW , en_SH , en_BZ , en_SL , az_AZ , fi_FI , en_SS , sr_YU , en_CD , en_CA , ka_GE , lv_LV , uk_UA , es_DO , ur_PK , ar_IQ , fr_LU_EURO , pt_PT , fr_FR_EURO , en_PH , th_TH , bn_BD , si_LK , en_PG , hu_HU , ar_SA , ar_SD , ru_KZ , ar_BH , nl_BE_EURO , ro_MD , en_QA , ru_KG , es_AR , ta_IN , sr_RS , aa_ER , en , de_DE_EURO , zh_MO , en_AE , ar_SY , es_BO , en_AI , no_NO , en_AG , nl_SR , fr_VU , en_MW , gu_AQ , ar_TN , nl_SX , hi_IN , en_NA , mn_MN , en_NG , fr_FR , ms_MY , nl_CW , uz_UZ , ar_DJ , sr_CS , de_AT_EURO , en_NZ , es_PE , es_PA , fa_IR , ar_DZ , fr_GN , lb_LU , xx_US , pt_CV , sh_RS , ht_HT , fr_WF , es_AR_onLQA , es_PR , ar_EG , es_PY , fr_GA , en_KW , de_AT , ro_RO , en_KY , fr_FR_onLQA , fr_DJ , ca_ES_EURO , cs_CZ , en_LC , pl_AQ , fr_TD , fr_TG , es_MX , sv_AX , sk_SK , en_LR , en_LS , ar_OM , dz_BT , te_IN , de_LU_EURO , sq_AL , sv_SE , sn_ZW , es_NI , en_IE_EURO , my_MM , en_MF , en_MU , it_IT , pl_PL , fr_BE , fr_BF , tr_TR , fr_BI , fr_BJ , id_ID , fr_RW , en_ZM , km_KH , ja_JP , de_DE , fr_BL , tg_TJ , ar_QA , de_CH , zh_HK , pt_PT_EURO , en_JO , en_JM , fr_CA , nl_NL_EURO , fr_CF , fr_CG , fr_CD , pa_AQ , fr_CH , xx_US_wthId , fr_CI , pt_GW , vi_VN , ru_MD , fr_CM , fr_SC , en_KE , ne_NP , bs_BA , sl_SI , en_KN , fr_SN , ar_AE , en_GY , tl_PH , ca_ES , es_IC , lo_LA , kn_IN , so_SO , fr_PF , ar_JO , nl_NL , is_IS , fi_FI_EURO , pt_MZ , sk_SK_EURO , sl_SI_EURO , en_IE , ms_BN , hr_HR , ar_KW , de_LU , lt_LT , en_IN , ps_AF , en_ZA , en_VC , ru_RU , sh_YU , ar_LB , mr_IN , dv_MV , fj_FJ , zh_TW , tk_TM , ar_LY , en_VU , fr_NE , en_FK , es_GT , fr_NC , es_GQ , fa_AF , bg_BG , hy_AM , en_CY_EURO , mk_MK , ar_MA , en_GD , en_GB , es_HN , gu_IN , en_GH , et_EE , en_GI , zh_CN , en_GM , ar_MR
- refName Reference Name: string
- name Name: string
- refName Reference Name: string
accountingContextCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: accountingContext
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
accountingContext - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
accountingPeriod
This record is available as a beta record.
- allLocked All Locked: boolean
- allowNonGLChanges Allow Non-G/L Changes: boolean
-
Check this box to allow users with the Allow Non-G/L Changes permission to enter non-posting transactions to this period after it has been closed. Users who do not have the Allow Non-G/L Changes permission cannot enter non-posting transactions to a period even if the Allow Non-G/L Changes option for a period is checked.
- apLocked A/P Locked: boolean
- arLocked A/R Locked: boolean
- closed Closed: boolean
- closedOnDate Date Closed: string (date)
- endDate End Date: string (date)
-
Enter or pick this period's end date here. This is a required field.
- firstPeriodStartDate: string (date)
- fiscalCalendar: nsResource
- fiscalCalendars: accountingPeriod-fiscalCalendarsCollection
- id Internal ID: string
- isAdjust Period is Adjustment: boolean
-
Check this box if this period is an adjustment period to adjust the difference between 365 days in a calendar year and 364 days in a fiscal year that consists of 52 weeks x 7 days per week.
- isInactive Inactive: boolean
-
Check this box to inactivate this numbering sequence.
- isPosting Is Posting: boolean
- isQuarter Period is a Quarter: boolean
-
Check this box if this period is a quarter.
- isYear Period is a Year: boolean
-
Check this box if this period is a year.
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - parent: accountingPeriod
- payrollLocked Payroll Locked: boolean
- perBookPeriodClosing: accountingPeriod-perBookPeriodClosingCollection
- periodName Period Name: string
-
The name of the selected period. You can enter this name when you first set up the period. Period names should be unique within a fiscal calendar. Since base periods are shared across all fiscal calendars, base period names must all be unique across all periods in all fiscal calendars If you accessed the page from Transactions > Management > GL Audit Numbering > Setup, you can select the open period. This is a required field.
- prependToAllBooks: boolean
- refName Reference Name: string
- startDate Start Date: string (date)
-
Enter or pick the date this period starts here. This is a required field.
- userNotes: accountingPeriod-userNotesCollection
accountingPeriod-fiscalCalendarsCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: accountingPeriod-fiscalCalendarsElement
-
accountingPeriod-fiscalCalendarsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
accountingPeriod-fiscalCalendarsElement
This record is available as a beta record.
- fiscalCalendar: nsResource
- links Links: nsLink
-
nsLink - parent: accountingPeriod
- refName Reference Name: string
accountingPeriod-perBookPeriodClosingCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: accountingPeriod-perBookPeriodClosingElement
-
accountingPeriod-perBookPeriodClosingElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
accountingPeriod-perBookPeriodClosingElement
This record is available as a beta record.
- accountingBook: accountingBook
- links Links: nsLink
-
nsLink - periodClosed Closed: boolean
- refName Reference Name: string
accountingPeriod-userNotesCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: accountingPeriod-userNotesElement
-
accountingPeriod-userNotesElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
accountingPeriodCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: accountingPeriod
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
accountingPeriod - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
advIntercompanyJournalEntry
This record is available as a beta record.
- accountingBook: accountingBook
- accountingBookDetail: advIntercompanyJournalEntry-accountingBookDetailCollection
- appliedRules: advIntercompanyJournalEntry-appliedRulesCollection
- approvalStatus: object
-
- id Internal identifier.: string 11 , 1 , 2 , 3
- refName Reference Name: string
- approved Approved: boolean
-
Check this box to indicate that this journal entry is approved. If you check this box, this journal entry will post immediately. If you do not check this box, this journal entry must be approved before it posts.
- class: classification
- createdDate Date Created: string (date-time)
- createdFrom: nsResource
- currency: currency
- customForm: object
-
- id Internal identifier.: string -9970 , 30
- refName Reference Name: string
- department: department
- excludeFromGLNumbering Exclude from GL Audit Numbering: boolean
- externalId External ID: string
- id Internal ID: string
- isReversal Is Reversal: boolean
- lastModifiedDate Date Last Modified: string (date-time)
- line: advIntercompanyJournalEntry-lineCollection
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
-
If you wish, enter a memo to describe this journal entry. It will appear on this transaction detail as well as reports such as a 2-line account register.
- nextApprover: employee
- nexus: nexus
- parentExpenseAlloc: nsResource
- performautobalance Perform Auto Balance: boolean
- postingPeriod: accountingPeriod
- prevDate Previous Effective Date: string (date)
- refName Reference Name: string
- reversalDate Reversal Date: string (date)
-
If this journal entry is intended to be reversed, enter the date for the reversing entry to be posted. If Defer Entry is checked, this field is mandatory.
- reversalDefer Defer Entry: boolean
-
Check this box to make the reversal a memorized transaction that automatically occurs on the date entered in the required Reversal Date field. Clear this box to make the reversal an immediately entered transaction with the date in the Reversal Date field.
- subsidiary: subsidiary
- tosubsidiaries: string
- tranDate Date: string (date)
-
NetSuite inserts today's date as the date of this journal entry. You can enter or select another date.
- tranId Entry No.: string
-
NetSuite increases the largest journal entry number by one. If you wish, you can type another number. The next journal entry number will revert to the standard pattern. You can enter a maximum of 45 characters in this field.
advIntercompanyJournalEntry-accountingBookDetailCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: advIntercompanyJournalEntry-accountingBookDetailElement
-
advIntercompanyJournalEntry-accountingBookDetailElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
advIntercompanyJournalEntry-accountingBookDetailElement
This record is available as a beta record.
- accountingBook: accountingBook
- exchangeRate Exchange Rate: number (double)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- revRecOnRevCommitment Rev Rec on Rev Commit.: boolean
- subsidiary: subsidiary
- tranIsVsoeBundle Transaction Is VSOE Bundle: boolean
advIntercompanyJournalEntry-appliedRulesCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: advIntercompanyJournalEntry-appliedRulesElement
-
advIntercompanyJournalEntry-appliedRulesElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
advIntercompanyJournalEntry-lineCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: advIntercompanyJournalEntry-lineElement
-
advIntercompanyJournalEntry-lineElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
advIntercompanyJournalEntry-lineElement
This record is available as a beta record.
- account: account
- amortizationType Type: string
- class: classification
- cleared Cleared: boolean
- clearedDate Date Cleared: string (date)
- credit Credit: number (double)
- creditTax Credit Tax: number (double)
- debit Debit: number (double)
- debitTax Debit Tax: number (double)
- department: department
- dueToFromSubsidiary: subsidiary
- eliminate Eliminate: boolean
- endDate End Date: string (date)
- entity: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- entityrepresentssubsidiary: subsidiary
- giftCertCode: giftCertificate
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- line Line Id: integer (int64)
- lineBaseCurrency: currency
- lineCurrencyPrecision Currency Precision: string
- lineFxRate Exchange Rate: number (double)
- lineSubsidiary: subsidiary
- lineTaxCode: nsResource
- lineTaxRate Tax Rate: number (double)
- lineTotalAmt Total Amount (Base Currency): number (double)
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
- refName Reference Name: string
- residual Residual: number (double)
- revenueRecognitionRule: nsResource
- schedule: nsResource
- scheduleNum: nsResource
- scheduleType: object
-
- id Internal identifier.: string Amortization , RevRec
- refName Reference Name: string
- startDate Start Date: string (date)
- taxAccount: account
- taxBasis Tax Basis: number (double)
- taxDetailsReference Tax Details Reference: string
- totalAmount Total Amount: number (double)
advIntercompanyJournalEntryCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: advIntercompanyJournalEntry
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
advIntercompanyJournalEntry - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
allocationSchedule
This record is available as a beta record.
- accountingbook: accountingBook
- accountsfromsource Use source/credit account(s): boolean
-
If you enable the Use source/credit account option, the destination lines should be custom segments, departments, classes, locations, and custom segments within accounts specified on the Source subtab.
- allocationDetails: allocationSchedule-allocationDetailsCollection
- allocationdestination: allocationSchedule-allocationdestinationCollection
- allocationmode: object
-
- id Internal identifier.: string FIXED , DYNAMIC
- refName Reference Name: string
- allocationsource: allocationSchedule-allocationsourceCollection
- batchfrequency Frequency: string
-
This field displays the frequency with which this allocation schedule should run.
- conversionrate: integer (int64)
- createdjournals: journalEntryCollection
- creditaccount: account
- creditclass: classification
- creditdepartment: department
- creditentity: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- creditlocation: location
- datebasis: object
-
- id Internal identifier.: string AOD , YTD , QTD , PTD
- refName Reference Name: string
- externalId External ID: string
- frequency Frequency: string
-
Choose how often you want to reallocate expenses from this account. You are not required to enter a date in the Next Date field if you choose End of Period as the allocation frequency. Only those allocation schedules where the selected Frequency is Run by Batch can be included in an allocation batch. The frequency that you select is relative to the date that you enter in the Next Date field.
- id Internal ID: string
- inactive Inactive: boolean
-
Check this box to inactivate this schedule or batch. Inactive schedules do not allocate expenses. Inactive batches are not deleted.
- isdetail: boolean
- journaldocid journaldocid: integer (int64)
- journaldocsnum journaldocsnum: string
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - name Name: string
-
Enter the name of this allocation schedule or batch.
- nextdate Next Date: string (date)
-
Enter the date of the next scheduled allocation. You can control the period of time that NetSuite uses to calculate the balance (weight timeline) by specifying the timeline end date through this field. This end date can be the date on which the schedule runs (system date), or a past or future date. When you select the weight basis (specific date, period to date, quarter to date, or year to date), your weight timeline is relative to the date you enter in the Next Date field.
- parentschedule: allocationSchedule
- postingperiod: accountingPeriod
- refName Reference Name: string
- remainingreminders Number Remaining: string
- remindforever Remind Forever: boolean
-
Choose Remind Forever to indefinitely reallocate based on this schedule. Choose Number Remaining to limit the number of times this schedule reallocates expenses. Enter the number of reallocations you want this schedule to make.
- srcbasecurrency: currency
- subsequentdate Subsequent Date: string (date)
-
Enter the date of the following allocation.
- subsidiary: subsidiary
- suffix: string
- trandate Date: string (date)
- unit Unit of Measure: string
- unitlabel Unit of Measure: string
-
This field displays the base unit assigned to the Unit Type.
- unitstype Unit Type: string
-
This field displays the unit of measure type associated with the selected statistical account.
- weightsinpercentage Values are percentages: boolean
-
If you enable the Values are percentages option, you can enter a percentage as a Weight value for each destination account or custom segment, department, class, location, and custom segment.
- weightsource: account
allocationSchedule-allocationDetails-allocationdestinationCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: allocationSchedule-allocationDetails-allocationdestinationElement
-
allocationSchedule-allocationDetails-allocationdestinationElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
allocationSchedule-allocationDetails-allocationdestinationElement
This record is available as a beta record.
- account: account
- balance Balance: string
- balancerate: number (float)
- balancesymbol: string
- class: classification
- department: department
- entity: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- intercompanyaccount: account
- links Links: nsLink
-
nsLink - location: location
- refName Reference Name: string
- subsidiary: subsidiary
- uniqueKey: integer (int64)
- weight Weight: number (float)
allocationSchedule-allocationDetails-allocationsourceCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: allocationSchedule-allocationDetails-allocationsourceElement
-
allocationSchedule-allocationDetails-allocationsourceElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
allocationSchedule-allocationDetails-allocationsourceElement
This record is available as a beta record.
- account Account: string
- class: classification
- department: department
- entity: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- links Links: nsLink
-
nsLink - location: location
- refName Reference Name: string
- uniqueKey: integer (int64)
allocationSchedule-allocationDetailsCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: allocationSchedule-allocationDetailsElement
-
allocationSchedule-allocationDetailsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
allocationSchedule-allocationDetailsElement
This record is available as a beta record.
- allocationdestination: allocationSchedule-allocationDetails-allocationdestinationCollection
- allocationsource: allocationSchedule-allocationDetails-allocationsourceCollection
- createdjournals: nsResourceCollection
- externalId External ID: string
- id Internal ID: integer (int64)
- links Links: nsLink
-
nsLink - postingperiod: accountingPeriod
- refName Reference Name: string
- trandate Date: string (date)
allocationSchedule-allocationdestinationCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: allocationSchedule-allocationdestinationElement
-
allocationSchedule-allocationdestinationElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
allocationSchedule-allocationdestinationElement
This record is available as a beta record.
- account: account
- balance Balance: string
- balancerate: number (float)
- balancesymbol: string
- class: classification
- department: department
- entity: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- links Links: nsLink
-
nsLink - location: location
- refName Reference Name: string
- uniqueKey: integer (int64)
- weight Weight: number (float)
allocationSchedule-allocationsourceCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: allocationSchedule-allocationsourceElement
-
allocationSchedule-allocationsourceElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
allocationSchedule-allocationsourceElement
This record is available as a beta record.
- account Account: string
- class: classification
- department: department
- entity: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- links Links: nsLink
-
nsLink - location: location
- refName Reference Name: string
- uniqueKey: integer (int64)
allocationScheduleCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: allocationSchedule
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
allocationSchedule - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
amortizationSchedule
This record is available as a beta record.
- accountingBook: accountingBook
- amortizationPeriod Amortization Period: integer (int64)
-
Enter the number of periods over which the amount should be amortized. For example, you can enter 60 to amortize the amount over 60 periods starting from the amortization start date. Note: The starting period is specified by the amortization start date on bills. If no amortization start date is specified, the posting date of the bill is the amortization start date. If an amortization end date is indicated on the bill, you do not need to complete this field.
- amortizationType: object
-
- id Internal identifier.: string STANDARD , VARIABLE
- refName Reference Name: string
- baseCurrencyPrecision: integer (int64)
- currency: currency
- endDate End Date: string (date)
-
The end date entered for this schedule appears here.
- externalId External ID: string
- forecastTemplate: amortizationTemplate
- id Internal ID: string
- initialAmount Initial Amount: number (double)
-
Enter a percentage or amount to be recognized in the first recognition period. The remaining amount is then recognized according to the set amortization method.
- isAmortization: boolean
- isEliminate Eliminate: boolean
-
If this box is checked, the source transaction for the amortization schedule is an intercompany transaction. This field is read-only.
- isInactive Inactive: boolean
-
Check this box if you no longer want to use this template. Inactivated templates no longer appear in lists and cannot be used to create schedules. To view inactivated templates or to reactivate them, check the Show Inactives box on the Amortization Templates list.
- isRecognized Is Recognized: boolean
- isSchedule: boolean
- job: job
- links Links: nsLink
-
nsLink - name Name: string
-
Enter a name for this template. The name you enter here appears in the Amortization Template dropdown on item records.
- parentSched: amortizationTemplate
- periodOffset Period Offset: integer (int64)
-
Specify the number of periods to postpone the start of amortization for the entire schedule. The first period to amortize has an offset of zero. For example, if your amortization terms are based on 30-day periods, enter a 2 in this field to wait 60 days before you begin amortizing expenses for this line. You can amortize different amounts to different accounts within the same period when you set several lines to the same period offset value. Setting a period offset does not change the number of periods in the schedule.
- recogIntervalSrc: object
-
- id Internal identifier.: string RECEIPTDATE , USERDEFINED
- refName Reference Name: string
- recurrence: amortizationSchedule-recurrenceCollection
- recurrenceType: object
-
- id Internal identifier.: string DATESPRORATE , EVENPERIODSPRORATE , CUSTOM , DATESINTOPERIODS , EVENPRORATEPERIOD
- refName Reference Name: string
- refName Reference Name: string
- remainingDeferredBalance Remaining Deferred Balance: number (double)
-
This field shows the amount on the schedule which has not yet been recognized.
- residual Residual: number (double)
-
Enter an amount or percentage to remain in the deferral account and not be amortized. A residual amount generally represents the salvage value of a fixed asset. Note: A residual amount entered on a transaction overrides a residual amount entered on an item record.
- revRecNumber: string
- revRecOffset Start Offset: integer (int64)
-
Specify the number of periods to postpone the start of the recognition for a schedule. Note: Setting a start offset changes the number of periods in the schedule because it postpones the beginning, but does not change the final period of the schedule.
- scheduleNumber Number: string
-
This number is automatically generated when you use Auto-Generated Numbering. If the Name field for the schedule is blank, the auto-generated number is used.
- sourceTran: nsResource
- startDate Start Date: string (date)
-
This shows the date expense recogntion begins for this schedule. The starting period is specified by the recognition start date on bills. If no recognition start date is specified, the posting date of the bill is the recognition start date.
- status: object
-
- id Internal identifier.: string NOTSTARTED , INPROGRESS , COMPLETED , ONHOLD
- refName Reference Name: string
- target: string
- totalAmortized Total Amortized: number (double)
-
This field shows the amount on the schedule which has already been recognized to date.
- totalAmount Amount: number (double)
-
This field shows the total amortization amount for the schedule, including amounts already recognized and amounts yet to be recognized. If you enabled the Allow Users to Modify Amortization Amount preference, this field can be edited. When you change this amount, the amount of each line of the schedule updates in proportion to the amount change. Only amounts that have not yet been recognized can be changed. The total amount of the schedule must always equal the purchase amount.
- tranLineId: string
- tranType: string
- useForeignAmounts Use Transaction Currency: boolean
amortizationSchedule-recurrenceCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: amortizationSchedule-recurrenceElement
-
amortizationSchedule-recurrenceElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
amortizationSchedule-recurrenceElement
This record is available as a beta record.
- defRevAccount: account
- foreignRecAmount Amount: number (double)
- incomeAccount: string
- isRecognized Is Recognized: boolean
- jDate Date Executed: string (date)
- journal Journal: string
- journalDoc: string
- links Links: nsLink
-
nsLink - pctAmortInPeriod % Amortized In Period: number (double)
- pctTotalAmortization % Total Amortized: number (double)
- periodOffset Period Offset: integer (int64)
- postingPeriod: accountingPeriod
- recAmount Base Amount: number (double)
- recurDate Date: string (date)
- refName Reference Name: string
- totalAmortizedMach Total Amortized: number (double)
amortizationScheduleCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: amortizationSchedule
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
amortizationSchedule - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
amortizationTemplate
This record is available as a beta record.
- acctContra: account
- acctDeferral: account
- acctTarget: account
- amortizationPeriod Amortization Period: integer (int64)
-
Enter the number of periods over which the amount should be amortized. For example, you can enter 60 to amortize the amount over 60 periods starting from the amortization start date. Note: The starting period is specified by the amortization start date on bills. If no amortization start date is specified, the posting date of the bill is the amortization start date. If an amortization end date is indicated on the bill, you do not need to complete this field.
- amortizationType: object
-
- id Internal identifier.: string STANDARD , VARIABLE
- refName Reference Name: string
- externalId External ID: string
- id Internal ID: string
- initialAmount Initial Amount: number (double)
-
Enter a percentage or amount to be recognized in the first recognition period. The remaining amount is then recognized according to the set amortization method.
- isAmortization: boolean
- isInactive Inactive: boolean
-
Check this box if you no longer want to use this template. Inactivated templates no longer appear in lists and cannot be used to create schedules. To view inactivated templates or to reactivate them, check the Show Inactives box on the Amortization Templates list.
- isPublic Public: boolean
-
This value indicates whether this amortization schedule is available to other users.
- isSchedule: boolean
- job: job
- links Links: nsLink
-
nsLink - name Name: string
-
Enter a name for this template. The name you enter here appears in the Amortization Template dropdown on item records.
- periodOffset Period Offset: integer (int64)
-
Specify the number of periods to postpone the start of amortization for the entire schedule. The first period to amortize has an offset of zero. For example, if your amortization terms are based on 30-day periods, enter a 2 in this field to wait 60 days before you begin amortizing expenses for this line. You can amortize different amounts to different accounts within the same period when you set several lines to the same period offset value. Setting a period offset does not change the number of periods in the schedule.
- recogIntervalSrc: object
-
- id Internal identifier.: string RECEIPTDATE , USERDEFINED , BETWEENBILLS , BETWEENBILLSRRDATE , SOREVRECDATES
- refName Reference Name: string
- recurrence: amortizationTemplate-recurrenceCollection
- recurrenceType: object
-
- id Internal identifier.: string DATESPRORATE , EVENPERIODSPRORATE , CUSTOM , DATESINTOPERIODS , EVENPRORATEPERIOD
- refName Reference Name: string
- refName Reference Name: string
- residual Residual: number (double)
-
Enter an amount or percentage to remain in the deferral account and not be amortized. A residual amount generally represents the salvage value of a fixed asset. Note: A residual amount entered on a transaction overrides a residual amount entered on an item record.
- revRecNumber: string
- revRecOffset Start Offset: integer (int64)
-
Specify the number of periods to postpone the start of the recognition for a schedule. Note: Setting a start offset changes the number of periods in the schedule because it postpones the beginning, but does not change the final period of the schedule.
- target: string
- totalAmount Amount: number (double)
-
This field shows the total amortization amount for the schedule, including amounts already recognized and amounts yet to be recognized. If you enabled the Allow Users to Modify Amortization Amount preference, this field can be edited. When you change this amount, the amount of each line of the schedule updates in proportion to the amount change. Only amounts that have not yet been recognized can be changed. The total amount of the schedule must always equal the purchase amount.
- useForeignAmounts Use Transaction Currency: boolean
amortizationTemplate-recurrenceCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: amortizationTemplate-recurrenceElement
-
amortizationTemplate-recurrenceElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
amortizationTemplateCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: amortizationTemplate
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
amortizationTemplate - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
assemblyBuild
This record is available as a beta record.
- accountingBookDetail: assemblyBuild-accountingBookDetailCollection
- auxDate: string
- billOfMaterials: bom
- billOfMaterialsRevision: bomRevision
- binItem: boolean
- binNumbers Bin Numbers: string
-
The preferred bin number from the assembly item record shows here. If assembly items from this build are stored in other bins, click the Bins icon. Bins must be selected on the assembly item record to show here. In the popup, edit the quantity for each bin, and click Done.
- buildable Buildable: number (float)
-
When you select an assembly item, the maximum number that you can build appears in the Buildable Quantity field. If you use locations, the quantity for the selected location is displayed in the Buildable Quantity field.
- class: classification
- component: assemblyBuild-componentCollection
- componentQuantitiesNeedRecalculation: boolean
- createdDate Date Created: string (date-time)
- createdFrom: nsResource
- currencyPrecision Currency Precision: string
- customForm: object
-
- id Internal identifier.: string -9980
- refName Reference Name: string
- department: department
- effectiveBomControl: string
- excludeFromGLNumbering Exclude from GL Audit Numbering: boolean
- expirationDate Expiration Date: string (date)
-
If you are building a lot numbered assembly item, enter the expiration date of the lot in this field. You can receive a warning when a lot is about to expire. To set the preference to receive an expiration warning, go to Setup > Accounting > Preferences > Accounting Preferences. On the Items/Transactions subtab, in the Days Before Lot Expiration Warning field, enter the number of days in advance of a lot item's expiration that you would like to receive a warning.
- externalId External ID: string
- hasNumberedComponents: boolean
- id Internal ID: string
- initScriptRun: boolean
- inventoryDetail: assemblyBuild-inventoryDetail
- inventoryDetailAvail: string
- inventoryDetailReq: string
- inventoryDetailUiType: string
- inventoryDetail_upd: string
- isLotNumberedAssembly: boolean
- isNumbered: boolean
- isNumberedAssembly: boolean
- isSerial: boolean
- item: assemblyItem
- itemBinList: string
- lastModifiedDate Date Last Modified: string (date-time)
- line: integer (int64)
- linkedIR: itemReceipt
- linkedInventoryTransfer: inventoryTransfer
- links Links: nsLink
-
nsLink - location: location
- maxReloadDate: string (date)
- memo Memo: string
-
Optionally enter a Memo. You can search for this text later to find this entry.
- minReloadDate: string (date)
- orderAssemblyQty: number (float)
- orderDoc: string
- origQuantity: number (float)
- outsourcingCharge: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- outsourcingChargeUnitPrice Unit Price: number (double)
- postingPeriod: accountingPeriod
- prevDate Previous Effective Date: string (date)
- qtyLmit: number (float)
- quantity Quantity: number (float)
-
In the Quantity to Build field, enter the number of assembly items you want to build. You cannot enter a quantity that exceeds the amount displayed in the Buildable Quantity field.
- refName Reference Name: string
- revision: itemRevision
- revisionMemo Revision Memo: string
- serialNumbers Serial Numbers: string
-
Enter the serial numbers for the assemblies you are building or unbuilding. You can enter up to 3800 characters in this field.
- subsidiary: subsidiary
- total Projected Value: number (double)
-
NetSuite calculates the Projected Value of this transaction. Projected value for the new assembly items is the total value of the parts times the quantity being built.
- tranDate Date: string (date)
-
Accept today's Date or enter another transaction date.
- tranId Ref No.: string
-
The Reference # field displays a system generated number. You can enter a different reference number to track this transaction.
- units Unit of Measure: string
-
If the assembly you select uses Units of Measure, the base units are displayed in the Units field.
assemblyBuild-accountingBookDetailCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: assemblyBuild-accountingBookDetailElement
-
assemblyBuild-accountingBookDetailElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
assemblyBuild-accountingBookDetailElement
This record is available as a beta record.
- accountingBook: accountingBook
- exchangeRate Exchange Rate: number (double)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- revRecOnRevCommitment Rev Rec on Rev Commit.: boolean
- subsidiary: subsidiary
- tranIsVsoeBundle Transaction Is VSOE Bundle: boolean
assemblyBuild-component-componentInventoryDetail
This record is available as a beta record.
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- externalId External ID: string
- inventoryassignment: assemblyBuild-component-componentInventoryDetail-inventoryassignmentCollection
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemDescription Description: string
-
A more complete Description of the item.
- links Links: nsLink
-
nsLink - location: location
- quantity Quantity: number (float)
-
In the Quantity to Build field, enter the number of assembly items you want to build. You cannot enter a quantity that exceeds the amount displayed in the Buildable Quantity field.
- refName Reference Name: string
- toLocation: location
- unit Units: string
-
If the assembly uses Units of Measure, the base units are displayed in the Units field.
assemblyBuild-component-componentInventoryDetail-inventoryassignmentCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: assemblyBuild-component-componentInventoryDetail-inventoryassignmentElement
-
assemblyBuild-component-componentInventoryDetail-inventoryassignmentElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
assemblyBuild-component-componentInventoryDetail-inventoryassignmentElement
This record is available as a beta record.
- binNumber: bin
- expirationDate Expiration Date: string (date)
- internalId Internal ID: integer (int64)
- inventoryDetail Inventory Detail: integer (int64)
- inventoryStatus: inventoryStatus
- issueInventoryNumber: inventoryNumber
- links Links: nsLink
-
nsLink - packCarton Pack Carton: string
- pickCarton Pick Carton: string
- quantity Quantity: number (float)
- quantityAvailable Unpicked Bin Qty: number (float)
- receiptInventoryNumber Serial/Lot Number: string
- refName Reference Name: string
- secondaryQuantity Secondary Quantity: number (float)
- toBinNumber: bin
- toInventoryStatus: inventoryStatus
assemblyBuild-componentCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: assemblyBuild-componentElement
-
assemblyBuild-componentElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
assemblyBuild-componentElement
This record is available as a beta record.
- assemblyLevel: boolean
- binItem: boolean
- binNumbers Bin Numbers: string
- buildVariance: number (float)
- compItemName Component: string
- compItemUrl: string
- componentInventoryDetail: assemblyBuild-component-componentInventoryDetail
- componentInventoryDetailAvail: string
- componentInventoryDetailReq: string
- componentInventoryDetail_upd: string
- componentNumbers Serial Numbers: string
- componentUiType: string
- fulfillmentBin: string
- hasMembersOnBuild: boolean
- indentLevel: integer (int64)
- isNonInventory: boolean
- isNumbered: boolean
- isSerial: boolean
- item: string
- itemBinList: string
- itemCost: number (float)
- itemSource: object
-
- id Internal identifier.: string WORK_ORDER , PHANTOM , PURCHASE_ORDER , STOCK
- refName Reference Name: string
- lineNumber: integer (int64)
- links Links: nsLink
-
nsLink - oldquantity: number (float)
- orderDoc: integer (int64)
- orderLine: integer (int64)
- orderLineQty: number (float)
- origQuantity: number (float)
- quantity Quantity: number (float)
- quantityOnHand Quantity On Hand: number (float)
- refName Reference Name: string
- unitCost: number (float)
- unitCostOverride: string
- units Units: string
assemblyBuild-inventoryDetail
This record is available as a beta record.
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- externalId External ID: string
- inventoryassignment: assemblyBuild-inventoryDetail-inventoryassignmentCollection
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemDescription Description: string
-
A more complete Description of the item.
- links Links: nsLink
-
nsLink - location: location
- quantity Quantity: number (float)
-
In the Quantity to Build field, enter the number of assembly items you want to build. You cannot enter a quantity that exceeds the amount displayed in the Buildable Quantity field.
- refName Reference Name: string
- toLocation: location
- unit Units: string
-
If the assembly uses Units of Measure, the base units are displayed in the Units field.
assemblyBuild-inventoryDetail-inventoryassignmentCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: assemblyBuild-inventoryDetail-inventoryassignmentElement
-
assemblyBuild-inventoryDetail-inventoryassignmentElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
assemblyBuild-inventoryDetail-inventoryassignmentElement
This record is available as a beta record.
- binNumber: bin
- expirationDate Expiration Date: string (date)
- internalId Internal ID: integer (int64)
- inventoryDetail Inventory Detail: integer (int64)
- inventoryStatus: inventoryStatus
- issueInventoryNumber: inventoryNumber
- links Links: nsLink
-
nsLink - packCarton Pack Carton: string
- pickCarton Pick Carton: string
- quantity Quantity: number (float)
- quantityAvailable Unpicked Bin Qty: number (float)
- receiptInventoryNumber Serial/Lot Number: string
- refName Reference Name: string
- secondaryQuantity Secondary Quantity: number (float)
- toBinNumber: bin
- toInventoryStatus: inventoryStatus
assemblyBuildCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: assemblyBuild
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
assemblyBuild - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
assemblyItem
- VSOEDeferral: object
-
- id Internal identifier.: string DEFERALLUNTIL , DEFERUNTIL
- refName Reference Name: string
- VSOEDelivered Default as Delivered: boolean
-
Check this box to automatically set this item to a Delivered status when this item is added to a transaction. Clear this box to leave the delivery status clear by default.
- VSOEPermitDiscount: object
-
- id Internal identifier.: string IFDELIVERED , NEVER
- refName Reference Name: string
- VSOEPrice Allocation Price: number (double)
-
Enter the VSOE Price for this item if it is known. Note: If you need to use more than one VSOE price for an item, you can set the most common price here and then change the price on each order manually.
- VSOESopGroup: object
-
- id Internal identifier.: string EXCLUDE , NORMAL , SOFTWARE
- refName Reference Name: string
- accountingBookDetail: assemblyItem-accountingBookDetailCollection
- alternateDemandSourceItem: assemblyItem
- amortizationPeriod Amortization Period: integer (int64)
- amortizationTemplate: amortizationTemplate
- assetAccount: account
- atpLeadTime ATP Lead Time: integer (int64)
- atpMethod: object
-
- id Internal identifier.: string CUMULATIVE_ATP_WITH_LOOK_AHEAD , DISCRETE_ATP
- refName Reference Name: string
- autoExpandKitForRevenuemgmt Auto-Expansion for Revenue Management: boolean
- autoLeadTime Auto-Calculate: boolean
-
Lead time is the average number of days between ordering this item from the vendor and receiving it. * Check the Auto-Calculate box if you want NetSuite to calculate the lead time based on the most recent order history of this item. This is calculated by taking the number of days between the order entry and receipt on the three most recent purchase orders, and dividing by three. o If there are multiple receipts for the item against the same purchase order, only the first receipt is used for the calculation. o Lead time calculation is not weighted by number of units received. o More recent purchase orders without receipts are ignored. * Clear the Auto-Calculate box to manually enter a lead time value in days. If the Auto-Calculate box is cleared and no value is entered, then the default value from the Set Up Inventory Management page is used.
- autoPreferredStockLevel Auto-Calculate: boolean
-
The preferred stock level is the optimum quantity to maintain in stock of an item. The quantity you enter here is used to determine your replenishment needs on the Order Items page. It is the quantity you want to have in stock after an order is placed. * Auto-Calculating – Check the Auto-Calculate box if you want NetSuite to calculate the preferred stock level based on demand for the item. The preferred stock level is calculated as: (daily demand * number of days supply preferred). If no preferred stock level is identified, then the default preferred stock level is used from the Set Up Inventory Management page. * Manually Calculating – Clear the Auto-Calculate box to manually enter the preferred stock quantity. The preferred stock level you set is used to calculate the quantity of items to be ordered on the Order Items page.
- autoProductionLeadTime Auto Calculate Production Lead Time: boolean
- autoReorderPoint Auto-Calculate: boolean
-
Reorder Point is the quantity level at which you need to reorder or build more of this item. * Auto-Calculate – Check the Auto-Calculate box to automatically calculate the reorder point based on demand for the item over time. The reorder point depends on the safety stock definition and is calculated as follows: o Without safety stock defined: Reorder point = (average lead time days * demand) o With safety stock defined in days: Reorder point = [(average lead time days + safety stock days) * demand] o With safety stock quantity defined: Reorder point = [(average lead time days * demand) + safety stock quantity) * Manually Calculate – Clear the Auto-Calculate box to manually enter the point at which to reorder or build more of this item. If you go to Home > User Preferences and place a check mark in the Inventory Level Warnings box, NetSuite reminds you when you have reached the reorder point.
- availableToPartners Available to Adv. Partners: boolean
-
Check this box to make this item available to partners with the Advanced Partner Center role for viewing. These items are also available to partners with roles that are customized for the Advanced Partner Center and include view, create or edit access to item records.
- averageCost Average Cost: number (double)
-
This field displays the current average cost of the item across all locations. Using the weighted-average method, the average cost is calculated as the total units available during a period divided by the beginning inventory cost plus the cost of additions to inventory. Note: The average cost calculated per location is listed for each location on the Locations subtab. If you use Multiple Units of Measure, average cost is calculated using stock units.
- backwardConsumptionDays Backward Consumption Days: integer (int64)
- baseUnit Primary Base Unit: string
-
This field displays the base unit of measure for this item.
- billExchRateVarianceAcct: account
- billOfMaterials: assemblyItem-billOfMaterialsCollection
- billPriceVarianceAcct: account
- billQtyVarianceAcct: account
- billingSchedule: billingSchedule
- binNumber: assemblyItem-binNumberCollection
- buildEntireAssembly Mark Sub-assemblies Phantom: boolean
-
Checking this box instructs the work order to build sub-assemblies for this item by default. Sub-assemblies are marked as Phantom on the Item Source, and the mark Sub-Assemblies Phantom box will be checked on the work order. This default can be overridden by clearing the Mark Sub-Assemblies Phantom box or amending the item source .
- buildTime Work Order Variable Lead Time: number (float)
-
In the Work Order Lead Time field, enter the lead time (in days) to build one assembly in the base unit.
- buildTimeLotSize Work Order Lead Time Lot Size: number (float)
- class: classification
- cogsAccount: account
- consumptionUnit Primary Consumption Unit: string
-
If you use the Multiple Units of Measure feature, select the default unit of measure for inventory.
- contingentRevenueHandling Eligible For Contingent Revenue Handling: boolean
-
Check this box to indicate that the item is subject to contingent revenue handling. When checked, revenue allocation is affected.
- copyDescription Copy from Sales Order: boolean
-
Check this box to copy the purchase description from the item description you enter on a sales order. Clear this box to enter a purchase description in the field above.
- correlatedItems: assemblyItem-correlatedItemsCollection
- cost Purchase Price: number (double)
-
Enter the price you pay for this item. If you do not enter a price, purchase orders for this item show the most recent purchase price by default. If you select a preferred vendor for this item, the price is shown in the currency selected on the vendor's record. If no preferred vendor is selected, the price is shown in your base currency.
- costAccountingStatus Cost Accounting Status: string
- costEstimate Item Defined Cost: number (double)
-
Enter an Item Defined Cost amount.
- costEstimateUnits Est. Cost Unit: string
- costingMethod: object
-
- id Internal identifier.: string SERIAL , LOT , AVG , LIFO , GROUPAVG , FIFO , STANDARD
- refName Reference Name: string
- countryOfManufacture: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- createExpensePlansOn: nsResource
- createRevenuePlansOn: nsResource
- createdDate Date Created: string (date-time)
- currency: currency
- custReturnVarianceAccount: account
- customForm: object
-
- id Internal identifier.: string -220 , -10221 , -10220
- refName Reference Name: string
- defaultItemShipMethod: shipItem
- defaultReturnCost Default Return Cost: number (double)
-
Enter the rate you want to default to show as the cost for this item when it is returned. What you enter in this field defaults to show in the Override Rate field on item receipts. You can still change this value after it appears on the item receipt.
- defaultReturnCostUnits: string
- defaultRevision Default Revision: string
-
If a default revision has been identified, it is displayed in this field.
- deferralAccount: account
- deferredRevenueAccount: account
- demandModifier Estimated Demand Change: number (double)
-
Enter the default percentage of Expected Demand Change to use for calculating item demand. For example, if you know that new customers will increase sales of this item in the future, you can enter a 10% expected demand change to be added on to previous sales totals. If no expected demand change percentage is entered, then the default value from the Set Up Inventory Management page is used.
- demandSource: object
-
- id Internal identifier.: string FORECASTANDORDERS , EXISTINGORDERSANDDEPENDENTDEMAND , FORECASTCONSUMPTION , ITEMDEMANDPLAN
- refName Reference Name: string
- demandTimeFence Demand Time Fence: integer (int64)
-
Demand Time Fence defaults to the number entered in the Default Demand Time Fence field. Verify the default or enter a number between zero and 365 to determine the demand time fence for this item.
- department: department
- description Description: string
-
Enter a description for this item. This description will appear in the Description column of sales forms.
- directRevenuePosting Direct Revenue Posting: boolean
-
Check this box to disable advanced revenue management for this item. When checked, posting transactions that include this item post directly to the item revenue account. No revenue element or revenue arrangement is created. When you check this box, the Deferred Revenue Account on the Accounting subtab is disabled. When you create sales transactions that include items that have this box checked, all the items in the transaction must have the box checked. You cannot mix items that post directly to revenue with items that post to deferred revenue in the same transaction. This restriction also applies to kit items. All items in a kit must post either to revenue or to deferred revenue. You cannot check or clear the box after the item has been used in a transaction with advanced revenue management. By default, this box is not checked.
- displayName Display Name/Code: string
-
Enter an optional name of up to 250 characters for this item in addition to the Item Name. If you are integrating with a Yahoo! store, this field is imported from Yahoo!. The display name prints in the Item column of sales forms when Basic printing is used. If this item is a member of a kit, this name appears in the Item column when the Print Items box is checked. If you do not enter a display name, the item name appears on printed forms.
- distributionCategory: nsResource
- distributionNetwork: nsResource
- dontShowPrice Don't Show Price: boolean
-
Check this box to hide the price of this item online. This is useful for items you want to advertise but don't want to sell or for items that you track inventory for and want to display but are offered in combination with other items.
- dropShipExpenseAccount: account
- effectiveBomControl: object
-
- id Internal identifier.: string EFFECTIVE_DATE , REVISION_CONTROL
- refName Reference Name: string
- enforceminqtyinternally Enforce Minimum Internally: boolean
-
Check this box to apply the minimum quantity restriction on sales orders generated from NetSuite. When you clear this box, but enter a number in the Minimum Quantity field, the minimum quantity is only applied to web store orders.
- excludeFromSiteMap Exclude from Sitemap: boolean
-
Check this box to exclude a tab, category or item page from the site map.
- expenseAmortizationRule: nsResource
- externalId External ID: string
- featuredDescription Featured Description: string
-
If this item is displayed on the home page of your Web site, enter a featured description for this item. This description appears below the item's store display name on the Home page of your store or site. You can enter up to 999 characters including basic HTML code. Enter and format text using the formatting options, or click the HTML Source Code link to enter HTML.
- fixedBuildTime Work Order Fixed Lead Time: number (float)
- fixedLotSize Fixed Lot Size: number (float)
-
If you selected Fixed Lot Size as the lot sizing method, then enter a quantity in the Fixed Lot Size field. This is the quantity that procurement of this item is always based on, regardless of demand projections.
- fixedLotSizeUnits: string
- forwardConsumptionDays Forward Consumption Days: integer (int64)
- froogleProductFeed Google Base Product Feed: boolean
-
Check this box to include this item when exporting item lists to Froogle. Clear this box to remove this item when exporting item lists to Froogle.
- futurehorizon Supply Chain Future Horizon: integer (int64)
-
Enter the number of days ahead you want to be included in a snapshot for this item. This will include future orders beyond the snapshot generated for this item. For example, when you select 30 in this field, open orders that are past due by 30 days are included. The default for this field is 30 days. The maximum you can enter in this field is 365 days.
- gainLossAccount: account
- handlingCost Handling Cost: number (double)
-
As an option, you may enter a handling cost for this item in dollars. You must also create a shipping item for per-item shipping and handling costs at Lists > Shipping Items > New. When this item is selected on sales orders, invoices or cash sales, the appropriate shipping and handling charges are automatically calculated.
- hazmatHazardClass Hazmat Hazard Class: string
-
Enter the DOT hazardous material class or division.
- hazmatId Hazmat Id: string
-
Enter the regulatory identifier for the commodity from the Federal Express Ground Hazardous Materials Shipping Guide. The format is UNXXXX, where XXXX is a four digit number.
- hazmatItemUnits Hazmat Item Units: string
-
Enter the unit of measure for this item, such as kg or ml.
- hazmatItemUnitsQty Hazmat Item Units Quantity: number (float)
-
Enter the quantity for the item units.
- hazmatPackingGroup: object
-
- id Internal identifier.: string , DEFAULT , I , II , III
- refName Reference Name: string
- hazmatShippingName Hazmat Shipping Name: string
-
Enter the shipping name for the ID as listed in the Federal Express Ground Hazardous Materials Shipping Guide. This item appears on the OP950 form.
- hierarchyVersions: assemblyItem-hierarchyVersionsCollection
- id Internal ID: string
- includeChildren Include Children: boolean
-
Check the Include Children box to share the item with all the sub-subsidiaries associated with each subsidiary selected in the Subsidiary field. Note: When sharing items across subsidiaries, all of the options selected on the item record must be compatible across subsidiaries. For example, when entering an inventory item to be shared across subsidiaries, you should select Income and Asset accounts on the item record that are also shared across the same subsidiaries.
- incomeAccount: account
- insertItemAttribute: object
-
- id Internal identifier.: string class , department , itemid , location , issueproduct , vendorname
- refName Reference Name: string
- intercoCogsAccount: account
- intercoIncomeAccount: account
- internalId Internal ID: integer (int64)
-
Use this ID number to create smart tags for your item templates, site templates, and custom Web site that you host with NetSuite.
- isDropShipItem Drop Ship Item: boolean
-
Check the Drop Ship Item box to have this item default as a drop ship item on sales orders. When a sales transaction for a drop ship item is approved, a linked purchase order for the preferred vendor is automatically generated. The vendor ships this item to your customer directly. Note: an item can be a drop ship or a special order, but not both.
- isGCoCompliant Google Checkout Compliant: boolean
- isHazmatItem Hazmat/Dangerous Goods: boolean
-
Check this box if this item is categorized as either hazardous material or dangerous goods. These items can only be shipped using FedEx integration.
- isInactive Inactive: boolean
-
When you check this box, this item will no longer appear on a list unless you check the Show All box at the bottom of the list page.
- isLotItem Lot Numbered: boolean
- isOnline Display in Website: boolean
-
Check this box to make this item available online in your Web site. You cannot sell this item online unless you check this box. If the item is of the Other Charge for Sale or Resale subtype, checking this box does not make it available in the web store catalog. However, it becomes available during web store checkout.
- isPhantom Phantom: boolean
-
Check this box to mark the Item Source for this item on any bill of materials as Phantom by default. The item source value will also be applied to any work order issued which uses this item. The default value can be overridden on the item source field on the Bill of Materials or Work Order record.
- isSerialItem Serialized: boolean
- isSpecialOrderItem Special Order Item: boolean
-
Check this box if you want this item to default as a special order on sales transactions. When a sales transaction for a special order item is approved, a linked purchase order is automatically generated. Then, the order cannot be fulfilled until the linked purchase order is received. Special order items can be used for custom orders or "just-in-time" inventory. Important: You must identify a preferred vendor and a purchase price on an item record in order for that item to be selected as a special order. Note: An item can be a drop ship or a special order, but not both.
- isSpecialWorkOrderItem Special Work Order Item: boolean
-
If this box is checked, when this item is selected on a sales order, the box in the Create WO column is checked by default. Clear this box to have the Create WO box default to cleared.
- isStorePickupAllowed Store Pickup Allowed: boolean
-
If this box is checked, indicates that at least one location allows store pickup of the item. If you clear the Allow Store Pickup box in the Locations sublist for all locations, this box is also cleared when you save the item record. This field is read only.
- issueProduct: issueProduct
- itemCarrier: object
-
- id Internal identifier.: string ups , nonups
- refName Reference Name: string
- itemId Item Name/Number: string
-
Enter up to 250 characters for the name of this item. This name appears in lists on transactions. If you have the option of entering a display name and do not, the item name prints in the Item column of sales forms when Basic printing is used. If you have the option to enter a vendor name and do not, the item name prints in the Item column of purchase forms. If you have entered a display name, it will print on purchases instead of the item name when Basic printing is used.
- itemProcessFamily: nsResource
- itemProcessGroup: nsResource
- itemRevenueCategory: nsResource
- itemShipMethod: shipItemCollection
- itemType: object
-
- itemVendor: assemblyItem-itemVendorCollection
- lastModifiedDate Last Modified: string (date-time)
- lastPurchasePrice Last Purchase Price: number (double)
-
This field displays the most recent purchase price of the item. This price is determined by the most recent transaction for the item that added positive inventory, such as a purchase receipt, inventory transfer or inventory adjustment. (This does not include item returns or assembly unbuilds.) If two transactions are entered on the same day, the one entered later takes precedence and is used to calculate the last purchase price. When you use the Multiple-Location Inventory feature, the following is true: * The last purchase price reflects the most recent transaction at any location. * The Inventory subtab of inventory item records includes a link to the last positive-inventory transaction per location. * If multiple purchases are made on the same day with different prices and locations, then the highest price paid on that day becomes the last purchase price. If you use Multiple Units of Measure, the last purchase price is calculated using purchase units.
- leadTime Purchase Lead Time: integer (int64)
-
Lead time is the average number of days between ordering this item from the vendor and receiving it. * Auto-Calculating – Check the Auto-Calculate box if you want NetSuite to calculate the lead time based on the most recent order history of this item. Lead time is calculated by taking the number of days between the order entry and receipt on the three most recent purchase orders, and dividing by three. If more than three purchase orders exist, all purchase orders within the period specified in the Order Analysis Interval field on the Inventory Management Preferences dialog will be used. o If there are multiple receipts for the item against the same purchase order, the calculation is made using the difference between the purchase order and the last receipt (the receipt that fully receives the order). o Lead time calculation is not weighted by number of units received. o More recent purchase orders without receipts are ignored. * Manually Calculating – Clear the Auto-Calculate box to manually enter a lead time value in days. If the Auto-Calculate box is cleared and no value is entered, then the default value from the Set Up Inventory Management page is used.
- links Links: nsLink
-
nsLink - location: location
- locations: assemblyItem-locationsCollection
- manufacturer Manufacturer: string
-
Enter the name of the company that manufactures this item.
- manufacturerAddr1 Manufacturer Address: string
-
Enter the address of the manufacturer. This is necessary to fill out international shipping forms when you sell and ship this item.
- manufacturerCity Manufacturer City: string
-
Enter the city location of the manufacturer of this item. This is necessary to automatically fill out international forms when you ship this item across borders.
- manufacturerState Manufacturer State: string
-
Enter the state where this item's manufacturer is located. This is necessary to fill out international forms when you ship this item.
- manufacturerTariff HS Tariff Number: string
-
Enter the Harmonized System (HS) tariff code number or the Harmonized Tariff Schedule (HTS) code number. This number should be six to ten characters.
- manufacturerTaxId Manufacturer Tax Id: string
-
Enter the Tax ID Number (TIN) for the manufacturer.
- manufacturerZip Manufacturer Zip Code: string
-
Enter the postal code of the location of this manufacturer. This is necessary to create international forms when you ship this item.
- matchBillToReceipt Match Bill To Receipt: boolean
-
Check the Match Bill to Receipt box if you want the Match Bill to Receipt box on transaction lines to be checked by default for this item. This enables you to generate variances based on vendor bill lines. Then, on the Post Vendor Bill Variances page, you must select Bill in the Transaction Type field to generate the variance postings. Purchase orders that include this item default to have this box checked and variances are generated based on vendor bill lines. Clear this box if you want to generate variance postings based on purchase order lines rather than vendor bill lines and do not want the Match Bill to Receipt box to be checked by default on transaction lines for this item. Then, on the Post Vendor Bill Variances page, you must select Purchase Order in the Transaction Type field to generate the variance postings. This preference defaults to be disabled. Even when enabled, this option can be changed on individual purchase order lines.
- matrixItemNameTemplate Matrix Item Name Template: string
-
This field is used to control how the matrix item will be displayed in the Matrix Item Name/Number field. Compose the order in which attributes and matrix options are displayed by selecting from the Insert Item Attribute and Insert Matrix Option dropdown lists. Add custom separator characters to easier distinguish the various options. Example: Item Name: Fabric / Color / Waist / Length [Location]
- matrixItemNameTemplateHelp Matrix Item Name Template: string
- matrixType: object
-
- id Internal identifier.: string , PARENT , CHILD
- refName Reference Name: string
- maximumquantity Maximum Order Qty: integer (int64)
-
Enter the greatest quantity of this item that customers can purchase. If customers enter an item quantity above the maximum amount, a warning message is displayed. Web store customers are unable to complete checkout unless they enter a quantity equal to or below the maximum quantity. Leave this field empty to allow customers to check out without maximum quantity restrictions. You can edit this warning at Setup > Site Builder/SuiteCommerce Advanced > Customize Text.
- member: assemblyItem-memberCollection
- metaTagHtml Meta Tag HTML: string
-
Enter the Meta Tag HTML you want to appear in the < head > section of this item page. Meta tags enable your Web site to be found by search engines.
- minimumquantity Minimum Order Qty: integer (int64)
-
Enter the lowest quantity that customers can purchase. Web store customers receive a warning and cannot check out if they enter an item quantity below this minimum. Leave this field empty to allow customers to check out with no minimum quantity restrictions. You can edit this warning at Setup > Site Builder/SuiteCommerce Advanced > Customize Text.
- mpn Manufacturer Part Number: string
-
MPN (Manufacturers Part Number) - Enter the part number used by the manufacturer to identify this item.
- multManufactureAddr Multiple Manufacturer Addresses: boolean
-
Check the Multiple Manufacture Addresses box if this manufacturer uses more than one address.
- nexTagCategory NexTag Category: string
-
Enter the name of the NexTag category this item should be included in. This category is included in the product feeds you can export at Setup > Web Site > Product Feeds.
- nexTagProductFeed NexTag Product Feed: boolean
-
Check this box to include this item when exporting item lists to NexTag. Clear this box to remove this item when exporting item lists to NexTag.
- noPriceMessage No Price Message: string
-
If you opted to not show a price online, enter the message that should show instead of the price. For example, you might enter "Call for Price."
- offerSupport Offer Support: boolean
-
Check this box to offer support for this particular item. By offering support for items, customers can select on case records which item they are having trouble with.
- onSpecial On Special: boolean
-
If you want to put this item on special, check this box. The item then appears in the Specials category in your store or site.
- outOfStockBehavior: object
-
- id Internal identifier.: string DISABLE , ENABLENMSG , REMOVE , ENABLE , DEFAULT
- refName Reference Name: string
- outOfStockMessage Out Of Stock Message: string
-
You can enter a custom out of stock message for this item. The message here replaces the default out of stock message.
- overallQuantityPricingType: object
-
- id Internal identifier.: string ITEM , PARENT , SCHEDULE
- refName Reference Name: string
- pageTitle Page Title: string
-
Enter the text you want to appear as the page's title for this item. This text appears in the browser tab. Use a descriptive title for the item page, this can help achieve better results with search engine ranking.
- parent: assemblyItem
- parentOnly Use as Category Only: boolean
- periodicLotSizeDays Periods of Supply Increment: integer (int64)
- periodicLotSizeType: object
-
- id Internal identifier.: string INTERVAL , WEEKLY , MONTHLY
- refName Reference Name: string
- planningItemCategory: planningItemCategory
- preferenceCriterion: object
-
- id Internal identifier.: string , A , B , C , D , E , F
- refName Reference Name: string
- preferredLocation: location
- preferredStockLevel Preferred Stock Level: number (float)
-
The preferred stock level is the optimum quantity to maintain in stock of an item. The quantity you enter here is used to determine your replenishment needs on the Order Items page. It is the quantity you want to have in stock after an order is placed. * Auto-Calculating – Check the Auto-Calculate box if you want NetSuite to calculate the preferred stock level based on demand for the item. The preferred stock level is calculated as: (daily demand * number of days supply preferred). If no preferred stock level is identified, then the default preferred stock level is used from the Set Up Inventory Management page. * Manually Calculating – Clear the Auto-Calculate box to manually enter the preferred stock quantity. The preferred stock level you set is used to calculate the quantity of items to be ordered on the Order Items page.
- preferredStockLevelDays Days: number (float)
-
The preferred stock level is the optimum quantity to maintain in stock of an item. The quantity you enter here is used to determine your replenishment needs on the Order Items page. It is the quantity you want to have in stock after an order is placed. * Auto-Calculating – Check the Auto-Calculate box if you want NetSuite to calculate the preferred stock level based on demand for the item. The preferred stock level is calculated as: (daily demand * number of days supply preferred). If no preferred stock level is identified, then the default preferred stock level is used from the Set Up Inventory Management page. * Manually Calculating – Clear the Auto-Calculate box to manually enter the preferred stock quantity. The preferred stock level you set is used to calculate the quantity of items to be ordered on the Order Items page.
- preferredStockLevelUnits: string
- presentationItem: assemblyItem-presentationItemCollection
- price: assemblyItem-price
- pricesIncludeTax Prices Include Tax: boolean
-
Check this box to save the base price as the tax inclusive price. Clear this box to save the base price as the tax exclusive price.
- pricingGroup: pricingGroup
- printItems Print Items: boolean
-
Check this box to display the member items with their respective display names, quantities and descriptions on sales and purchase forms. Clear this box to display only the description and amount of the group or kit on sales and purchase forms. Note: Assembly items do not display on purchase forms even when this box is checked. Also note that member items are never shown on printed forms; only one line with the group name and summary is printed.
- prodPriceVarianceAcct: account
- prodQtyVarianceAcct: account
- purchaseDescription Purchase Description: string
-
Enter up to 999 characters of text for a description of this item to appear on vendor orders. Include the unit of measure in this description.
- purchaseOrderAmount Vendor Bill - Purchase Order Amount Tolerance: number (float)
-
Enter the tolerance limit for the discrepancy between the amount on the vendor bill and purchase order.
- purchaseOrderQuantity Vendor Bill - Purchase Order Quantity Tolerance: number (float)
-
Enter the tolerance limit for the discrepancy between the quantity on the vendor bill and purchase order.
- purchaseOrderQuantityDiff Vendor Bill - Purchase Order Quantity Difference: number (float)
-
Enter the difference limit for the discrepancy between the quantity on the vendor bill and purchase order.
- purchasePriceVarianceAcct: account
- purchaseUnit Primary Purchase Unit: string
-
Select the unit you use to purchase this item from the vendor.
- quantityAvailable Quantity Available: number (float)
- quantityAvailableBase Quantity Available (Base Unit): number (float)
- quantityBackOrdered Quantity Back Ordered: number (float)
- quantityCommitted Quantity Committed: number (float)
-
This field shows the number of this item that are already committed to be sold and are currently showing on orders.
- quantityOnHand Quantity On Hand: number (float)
-
This field shows the quantity of this item you have on hand.
- quantityOnHandBase Quantity On Hand (Base Unit): number (float)
- quantityOnOrder Quantity On Order: number (float)
-
This field shows the quantity of this item you currently have on order with the vendor.
- quantityPricingSchedule: nsResource
- rate Price: number (double)
-
Enter the rate for this discount or markup. The rate can be either a percentage or dollar amount. A percentage discount must be followed by a % sign. A dollar amount should be entered as a positive number.
- rateIncludingTax Price Including Tax: number (double)
- receiptAmount Vendor Bill - Item Receipt Amount Tolerance: number (float)
-
Enter the tolerance limit for the discrepancy between the amount on the vendor bill and item receipt.
- receiptQuantity Vendor Bill - Item Receipt Quantity Tolerance: number (float)
-
Enter the tolerance limit for the discrepancy between the quantity on the vendor bill and item receipt.
- receiptQuantityDiff Vendor Bill - Item Receipt Quantity Difference: number (float)
-
Enter the difference limit for the discrepancy between the quantity on the vendor bill and item receipt.
- refName Reference Name: string
- reorderMultiple Reorder Multiple: integer (int64)
-
Enter the quantity you prefer to order of this item each time. Then, the Order Items page suggests ordering a quantity of this item that is always multiple of the number you enter. For example, if the vendor only accepts orders in multiples of one thousand, you would enter 1000 in this field. Then, the Order items page might suggest that you order 1000 or 2000, but not 1500. Note: If you use the Multiple Units of Measure feature, the reorder multiple always functions in base units.
- reorderPoint Build Point: number (float)
-
The Reorder Point is the quantity level at which you need to reorder or build more of this item. * Auto-Calculating – Check the Auto-Calculate box if you want NetSuite to calculate the reorder point based on demand for the item over time. The reorder point depends on the safety stock definition and is calculated as follows: o Without safety stock defined: Reorder point = (average lead time days * demand) o With safety stock defined in days: Reorder point = [(average lead time days + safety stock days) * demand] o With safety stock quantity defined: Reorder point = [(average lead time days * demand) + safety stock quantity) * Manually Calculating – Clear the Auto-Calculate box if you want to manually enter the point at which to reorder or build more of this item. If you go to Home > User Preferences and place a check mark in the Inventory Level Warnings box, you are reminded when you have reached the reorder point.
- reorderPointUnits: string
- rescheduleInDays Reschedule In Days: integer (int64)
-
In the Reschedule In Days field, enter a number between one and 90 that is the maximum number of days that the order can be advanced from the current day. For example, if you enter 10 in this field, an order for this item can be moved up ten days earlier, but not eleven or more days. This field defaults to be blank. Note: If this field is left blank, NetSuite does not make recommendations to reschedule orders for this item to a later date.
- rescheduleOutDays Reschedule Out Days: integer (int64)
-
In the Reschedule Out Days field, enter a number between one and 180 that is the maximum number of days that the order can be delayed from the current day. For example, if you enter 10 in this field, an order for this item can be moved to ten days later, but not eleven or more days. This field defaults to be blank. Note: If this field is left blank, NetSuite does not make recommendations to reschedule orders for this item to a later date.
- residual Residual: number (double)
- revRecForecastRule: nsResource
- revReclassFxAccount: account
- revenueAllocationGroup: nsResource
- revenueRecognitionRule: nsResource
- rotationType: object
-
- id Internal identifier.: string LEFO , FEFO
- refName Reference Name: string
- roundUpAsComponent Round Up Quantity as Component: boolean
-
If you use the component yield preference, depending on your settings, the component yield calculation may result in a fractional quantity. You can use this setting so that the quantity for a component on a work order automatically rounds up to a whole number in base units. For example, you have an assembly that requires 2 units of Component A. The component yield is 99%. To build 5 of these assemblies requires 10.1 units of Component A. Since you can consume components only in whole numbers, you cannot consume 10.1 units. Therefore, you need to round up to the next highest whole number in base units. Check the Round Up Quantity as Component box to enable NetSuite to round up the quantity consumed for this item. Clear this box if you do not want NetSuite to round up the quantity consumed for this item.
- safetyStockLevel Safety Stock Level: number (float)
-
Enter the amount of an item you prefer to keep in stock at all times. Safety stock can be a quantity or a number of days worth of stock. This amount is used to auto-calculate the reorder point of an item. * To define safety stock as a quantity, enter a value. * To define safety stock as a number of days, enter a value in the field next to Days. If no safety stock value is entered, then the default value from the Set Up Inventory Management page is used.
- safetyStockLevelDays Safety Stock Level Days: integer (int64)
-
Enter the amount of an item you prefer to keep in stock at all times. Safety stock can be a quantity or a number of days worth of stock. This amount is used to auto-calculate the reorder point of an item. * To define safety stock as a quantity, enter a value. * To define safety stock as a number of days, enter a value in the field next to Days. If no safety stock value is entered, then the default value from the Set Up Inventory Management page is used.
- saleUnit Primary Sale Unit: string
-
Select the unit you use to sell this item to customers on sales transactions.
- savedReorderPoint Build Point: number (float)
- scheduleBCode: object
-
- scheduleBNumber Schedule B Number: string
-
Enter the number for the Schedule B form for this item.
- scheduleBQuantity Schedule B Quantity: number (float)
-
Enter the numeric quantity in relation to the unit of measure entered in the Schedule B Code field. These two fields are used together to determine the amount represented by one of this item on the Schedule B form for Shipping Export Declarations. For example, if you enter 5 in the Schedule B Quantity field, and you select kilogram in the Schedule B Code field, when you fulfill two of these items on an order, the Schedule B form presents the items’ amount as 10 kilograms.
- scrapAcct: account
- searchKeywords Search Keywords: string
-
Enter alternative search keywords that customers might use to find this item using your Web store’s internal search. These can include synonyms, acronyms, alternate languages or misspellings. These keywords are seen as equally important as the item name when searches are conducted.
- seasonalDemand Seasonal Demand: boolean
-
Check the Seasonal Demand box to define how NetSuite analyzes customer demand for this item . Customer demand for an item is used to auto-calculate reorder points and preferred stock levels. An item’s demand rate is calculated as the average sales quantity per day. * Historical Demand – Clear the Seasonal Demand box to calculate the demand as average sales per day over a specific period. To set the number of months interval between analysis to evaluate sales orders and calculate item demand, go to Setup > Accounting > Set Up Inventory Management > Order Analysis Interval field. * Seasonal Demand – Check the Seasonal Demand box to calculate the reorder quantity for this item based on inventory demand changes through the year. To set the number of months interval between analysis to evaluate sales orders and calculate item demand, go to Setup > Accounting > Set Up Inventory Management > Order Analysis Interval field.
- shipIndividually Ships Individually: boolean
-
Check this box if this item always ships alone and with no other items in the same package. This helps determine the number of packages needed and the shipping rate on order fulfillments.
- shipPackage: nsResource
- shippingCost Shipping Cost: number (double)
-
As an option, you may enter a shipping cost for this item in dollars. You must also create a shipping item for per-item shipping costs at Lists > Shipping Items > New. When this item is selected on sales orders, invoices or cash sales, the appropriate shipping charges are automatically calculated.
- shoppingDotComCategory Shopping.com Category: string
-
Enter the name of the Shopping.com category that this item should go under. This category is included in the product feeds that you can export from Setup > Web Site > Product Feeds. Go to www.shopping.com for more information on the categories available. This is an optional field only available for following item records: Kit/Package, Non-inventory Item for Sale, Non-inventory Item for Resale, Assembly (lot and serialized), and Inventory (lot and serialized).
- shoppingProductFeed Shopping Product Feed: boolean
-
Check this box to include this item when exporting item lists to Shopping.com. Clear this box to remove this item when exporting item lists to Shopping.com.
- shopzillaCategoryId Shopzilla Category ID: integer (int64)
-
Enter the name of the Shopzilla category this item should be included in. This category is included in the product feeds you export at Setup > Web Site > Product Feeds. Go to www.shopzilla.com for more information on the available categories. This is an optional field only displayed for the following item records: Kit/Package, Non-inventory Item for Sale, Non-inventory Item for Resale, Assembly (lot and serialized), and Inventory (lot and serialized).
- shopzillaProductFeed Shopzilla Product Feed: boolean
-
Check this box to include this item when exporting item lists to Shopzilla. Clear this box to remove this item when exporting item lists to Shopzilla.
- siteCategory: assemblyItem-siteCategoryCollection
- siteMapPriority: object
-
- stockDescription Stock Description: string
-
Enter up to 21 characters to specify information about this item, such as New, Refurbished or Ships 2-3 days.
- stockUnit Primary Stock Unit: string
-
Select the unit you use to stock this item in inventory.
- storeDescription Store Description: string
-
The store description appears under the item's store display name on item list pages in your store or site. You can enter letters, numbers, and basic HTML code. Note: To make the store description display when an item is in the Web store shopping cart, go to Setup > Web Site > Set Up Web Site. Click the Cart subtab, and check the box next to Store Description.
- storeDetailedDescription Detailed Description: string
-
Enter a detailed description for this item. When your customers click an item's store display name for more information, they see this description. You can enter letters, numbers or basic HTML code. If you are using Internet Explorer, you can also clear the View Source box below to enter and format text using the formatting options above. This eliminates the need for HTML code. If you do not see the View Source box, make sure Rich Text Editing is enabled at Home > Set Preferences > Appearance.
- storeDisplayImage: nsResource
- storeDisplayName Store Display Name: string
-
Enter the name of this item as you want it displayed in your Web site. You can enter up to 250 characters.
- storeDisplayThumbnail: nsResource
- subsidiary: subsidiaryCollection
- supplyLotSizingMethod: object
-
- id Internal identifier.: string FIXED_LOT_SIZE , LOT_FOR_LOT , PERIODIC_LOT_SIZE
- refName Reference Name: string
- supplyReplenishmentMethod: object
-
- id Internal identifier.: string TIME_PHASED , MPS , REORDER_POINT , MRP
- refName Reference Name: string
- supplyTimeFence Planning Time Fence: integer (int64)
-
This field defaults to the number entered in the Default Planning Time Fence field. Verify the default or enter a number between zero and 365 to determine the planning time fence for this item.
- supplyType: object
-
- id Internal identifier.: string TRANSFER , PURCHASE
- refName Reference Name: string
- totalValue Total Value: number (double)
-
Enter or accept the total value of this item. NetSuite generates this amount by multiplying your purchase price and your quantity on hand. As you buy and sell additional inventory, NetSuite continues to calculate the total value.
- trackLandedCost Track Landed Cost: boolean
-
Check this box to track landed costs associated with this item. Note: You must include an item that tracks landed costs on transactions you want to source for landed costs. For example, on the Landed Costs subtab of item receipts, a vendor bill shows in the source transaction list only if the bill includes a landed cost item.
- transferPrice Transfer Price: number (double)
-
Enter a transfer price on an item record to set the default value used as the transfer price on transfer orders. You can still override this default by entering a new transfer price for an item on the transfer order. The use of the value in the Transfer Price field on a transfer order depends on your setting for the Use Item Cost as Transfer Cost preference. When the Use Item Cost as Transfer Cost preference is enabled, the transfer price on a transfer order is not considered for posting cost accounting of line items. In the Transfer Price field, enter a declared value for the item to be used for shipping purposes only. When the Use Item Cost as Transfer Cost preference is disabled, the transfer price on a transfer order is considered for posting cost accounting of line items. Items that do not have a transfer price set on a transfer order use a zero value for cost accounting calculations when the item is received. Note: If the Transfer Price field is blank on the item record, a value of zero shows by default on the transfer order. Unless a transfer price value is entered on the transfer order, a value of zero is used for COGS calculations when the item is received.
- transferPriceUnits Transfer Price Units: string
- unbuildVarianceAccount: account
- unitsType: unitsType
- upcCode UPC Code: string
-
Enter a maximum of 999 characters in this field to identify an internal name or number to store the item's UPC Code. You can use the text you enter here when adding the item to transactions, searching, or viewing reports. * When you enter text in this field, the SKU/UPC field on item labels displays this UPC Code and prints in UPC bar code format. * When this field is clear, the SKU/UPC field on item labels displays the Item Name/Number and prints in Code-128 bar code format.
- urlComponent URL Component: string
-
Enter a short, descriptive name for this item to appear as part of its URL in the Web store. Setting a name to show in the URL can result in better ranking from search engines. If you leave this field blank, NetSuite terms and numbers are used as identifiers in the URL. Note: Descriptive URL components are case sensitive. Descriptive URLs must match the case used in the URL Component field of an item record to point to the correct page.
- useBins Use Bins: boolean
-
Check this box to track bin locations for this item. If you choose to use bins for this item, you must associate at least one bin with the item using the Bin Numbers subtab. You can associate multiple items with one bin and multiple bins with one item. You can also designate one preferred bin per location. The preferred bin is listed by default on receipt and fulfillment transactions. To create bin records that can be selected here, go to Lists > Supply Chain > Bins > New.
- useComponentYield Use Component Yield: boolean
-
Check the Use Component Yield box to enable NetSuite to account for material component yield loss during the ordering and planning process.
- useMarginalRates Use Marginal Rates: boolean
-
Check this box if you want the quantity discounts in the schedule to be applied to each pricing bracket separately. For example, a schedule offers no discount for the first 100 items sold and a 5% discount if more than 100 are sold. If 150 items are sold, the first 100 are at normal price, and the other fifty items are sold at 5% discount. Leave this box clear if you want the discount to apply to all of the items sold.
- vendReturnVarianceAccount: account
- vendor: vendor
- vendorName Vendor Name/Code: string
-
If your vendor uses a name for this item that is different from the name you use, you can enter up to 60 characters as the vendor's name for this item here. The vendor's name for this item prints in the Item column of purchase forms. If you do not enter a vendor name, the item name prints in the Item column of purchase forms. If you have entered a display name, it will print on purchases instead of the item name.
- weight Item Weight : number (float)
-
Enter the weight of this item and select the units in the dropdown.
- weightUnit: object
-
- id Internal identifier.: string 1 , 2 , 3 , 4
- refName Reference Name: string
- weightUnits Weight Units: string
- wipAcct: account
- wipVarianceAcct: account
- yahooProductFeed Yahoo Shopping Product Feed: boolean
assemblyItem-accountingBookDetailCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: assemblyItem-accountingBookDetailElement
-
assemblyItem-accountingBookDetailElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
assemblyItem-accountingBookDetailElement
- accountingBook: accountingBook
- amortizationTemplate: amortizationTemplate
- createExpensePlansOn: nsResource
- createRevenuePlansOn: nsResource
- links Links: nsLink
-
nsLink - refName Reference Name: string
- revRecForecastRule: nsResource
- revRecSchedule: revRecTemplate
- revenueRecognitionRule: nsResource
- sameAsPrimaryAmortization Same as Primary Book Amortization: boolean
- sameAsPrimaryRevRec Same as Primary Book Rev Rec: boolean
assemblyItem-billOfMaterialsCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: assemblyItem-billOfMaterialsElement
-
assemblyItem-billOfMaterialsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
assemblyItem-billOfMaterialsElement
- billOfMaterials: bom
- defaultForLocation: locationCollection
- links Links: nsLink
-
nsLink - refName Reference Name: string
assemblyItem-binNumberCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: assemblyItem-binNumberElement
-
assemblyItem-binNumberElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
assemblyItem-hierarchyVersionsCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: assemblyItem-hierarchyVersionsElement
-
assemblyItem-hierarchyVersionsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
assemblyItem-hierarchyVersionsElement
- endDate Hierarchy Version End Date: string (date)
- hierarchyNode: merchandiseHierarchyNode
- hierarchyVersion: merchandiseHierarchyVersion
- isIncluded Included In Version: boolean
- links Links: nsLink
-
nsLink - refName Reference Name: string
- startDate Hierarchy Version Start Date: string (date)
assemblyItem-itemVendor-itemVendorPrice
- externalId External ID: string
- itemvendorpricelines: assemblyItem-itemVendor-itemVendorPrice-itemvendorpricelinesCollection
- links Links: nsLink
-
nsLink - refName Reference Name: string
assemblyItem-itemVendor-itemVendorPrice-itemvendorpricelinesCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: assemblyItem-itemVendor-itemVendorPrice-itemvendorpricelinesElement
-
assemblyItem-itemVendor-itemVendorPrice-itemvendorpricelinesElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
assemblyItem-itemVendorCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: assemblyItem-itemVendorElement
-
assemblyItem-itemVendorElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
assemblyItem-itemVendorElement
- itemVendorPrice: assemblyItem-itemVendor-itemVendorPrice
- links Links: nsLink
-
nsLink - predConfidence Predicted Risk Confidence: number (double)
- predictedDays Predicted Days Late/Early: integer (int64)
- preferredVendor Preferred: boolean
- purchasePrice Purchase Price: number (double)
- refName Reference Name: string
- schedule: nsResource
- subsidiary: subsidiary
- vendor: vendor
- vendorCode Code: string
- vendorCurrencyName Currency: string
assemblyItem-locationsCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: assemblyItem-locationsElement
-
assemblyItem-locationsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
assemblyItem-locationsElement
- advanceWarningThreshold Firm/Release Advance Warning Threshold: integer (int64)
- atpLeadTime ATP Lead Time: integer (int64)
- autoProductionLeadTime Auto Calculate Production Lead Time: boolean
- averageCostMli Average Cost: number (double)
- backwardConsumptionDays Backward Consumption Days: integer (int64)
- buildTime Work Order Variable Lead Time: number (float)
- buildTimeLotSize Work Order Lead Time Lot Size: number (float)
- cost Standard Cost: number (double)
- costAccountingStatus Cost Accounting Status: string
- costingLotSize Costing Lot Size: number (float)
- currentStandardCost Current Standard Cost: number (double)
- currentStandardCostEffectiveDate Current Standard Cost Effective Date: string (date)
- defaultReturnCost Default Return Cost: number (double)
- demandSource: object
-
- id Internal identifier.: string FORECASTANDORDERS , EXISTINGORDERSANDDEPENDENTDEMAND , FORECASTCONSUMPTION , ITEMDEMANDPLAN
- refName Reference Name: string
- demandTimeFence Demand Time Fence: integer (int64)
- fixedBuildTime Work Order Fixed Lead Time: number (float)
- fixedLotSize Fixed Lot Size: number (float)
- forwardConsumptionDays Forward Consumption Days: integer (int64)
- inventoryCostTemplate: nsResource
- isWip WIP: boolean
- lastPurchasePriceMli Last Purchase Price: number (double)
- lateDemandThreshold High Impact Late Demand Threshold: number (float)
- latePeriodDays Late Period Days: integer (int64)
- leadTime Purchase Lead Time: integer (int64)
- links Links: nsLink
-
nsLink - location: location
- locationAllowStorePickup Allow Store Pickup: boolean
- locationCostingGroup: nsResource
- locationId Location: integer (int64)
- locationStorePickupBufferStock Store Pickup Buffer Stock: number (float)
- location_display Location: string
- locationqtyavailforstorepickup Quantity Available for Store Pickup: number (float)
- minimumRescheduleDays Minimum Reschedule Days: integer (int64)
- onHandValueMli Value: number (double)
- pastDueForecastDays Past Due Forecast Days: integer (int64)
- periodicLotSizeDays Periods of Supply Increment: integer (int64)
- periodicLotSizeType: object
-
- id Internal identifier.: string INTERVAL , WEEKLY , MONTHLY
- refName Reference Name: string
- poReceiptCost PO Receipt Cost: number (double)
- preferredStockLevel Preferred Stock Level: number (float)
- qtyInTransitExternal Quantity In Transit (External): number (float)
- quantityAvailable Quantity Available: number (float)
- quantityAvailableBase Quantity Available (Base Unit): number (float)
- quantityBackOrdered Quantity Back Ordered: number (float)
- quantityCommitted Quantity Committed: number (float)
- quantityInTransit Quantity In Transit: number (float)
- quantityOnHand Quantity On Hand: number (float)
- quantityOnHandBase Quantity On Hand (Base Unit): number (float)
- quantityOnOrder Quantity On Order: number (float)
- refName Reference Name: string
- reorderPoint Build Point: number (float)
- rescheduleHorizon Reschedule Horizon: integer (int64)
- rescheduleInDays Reschedule In Days: integer (int64)
- rescheduleOutDays Reschedule Out Days: integer (int64)
- safetyStockLevel Safety Stock Level: number (float)
- savedReorderPoint Reorder Point: number (float)
- supplyLotSizingMethod: object
-
- id Internal identifier.: string FIXED_LOT_SIZE , LOT_FOR_LOT , PERIODIC_LOT_SIZE
- refName Reference Name: string
- supplyTimeFence Planning Time Fence: integer (int64)
- supplyType: object
-
- id Internal identifier.: string TRANSFER , PURCHASE
- refName Reference Name: string
assemblyItem-memberCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: assemblyItem-memberElement
-
assemblyItem-memberElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
assemblyItem-memberElement
- bomQuantity BoM Quantity: string
- componentYield Component Yield: number (double)
- effectiveDate Effective Date: string (date)
- effectiveRevision: itemRevision
- id Internal ID: integer (int64)
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemSource: object
-
- id Internal identifier.: string WORK_ORDER , PHANTOM , PURCHASE_ORDER , STOCK
- refName Reference Name: string
- lineNumber Line Id: integer (int64)
- links Links: nsLink
-
nsLink - memberDescr Description: string
- memberUnit Units: string
- obsoleteDate Obsolete Date: string (date)
- obsoleteRevision: itemRevision
- quantity Quantity: string
- refName Reference Name: string
assemblyItem-presentationItemCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: assemblyItem-presentationItemElement
-
assemblyItem-presentationItemElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
assemblyItem-price
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: assemblyItem-priceElement
-
assemblyItem-priceElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
assemblyItem-priceElement
- currencyPage: currency
- discountDisplay Default Discount %: number (double)
- isInactive Inactive: boolean
-
When you check this box, this item will no longer appear on a list unless you check the Show All box at the bottom of the list page.
- links Links: nsLink
-
nsLink - price Amount: number (double)
- priceLevel: priceLevel
- priceLevelName Price Level: string
- priceQty Sequence Number: integer (int64)
- quantity: object
-
- value Value: string
- refName Reference Name: string
assemblyItem-siteCategoryCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: assemblyItem-siteCategoryElement
-
assemblyItem-siteCategoryElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
assemblyItem-siteCategoryElement
- category: nsResource
- links Links: nsLink
-
nsLink - refName Reference Name: string
- webSite: webSite
assemblyItemCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: assemblyItem
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
assemblyItem - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
assemblyUnbuild
This record is available as a beta record.
- accountingBookDetail: assemblyUnbuild-accountingBookDetailCollection
- auxDate: string
- billOfMaterials: bom
- billOfMaterialsRevision: bomRevision
- binItem: boolean
- binNumbers Bin Numbers: string
-
The preferred bin number from the assembly item record shows here. If assembly items from this build are stored in other bins, click the Bins icon. Bins must be selected on the assembly item record to show here. In the popup, edit the quantity for each bin, and click Done.
- built Built: number (float)
-
This field shows the assembled quantity you currently have in stock of this item.
- class: classification
- component: assemblyUnbuild-componentCollection
- componentQuantitiesNeedRecalculation: boolean
- costingMethod: string
- createdDate Date Created: string (date-time)
- currencyPrecision Currency Precision: string
- customForm: object
-
- id Internal identifier.: string -9979
- refName Reference Name: string
- department: department
- effectiveBomControl: string
- excludeFromGLNumbering Exclude from GL Audit Numbering: boolean
- expirationDate Expiration Date: string (date)
- externalId External ID: string
- hasNumberedComponents: boolean
- id Internal ID: string
- inventoryDetail: assemblyUnbuild-inventoryDetail
- inventoryDetailAvail: string
- inventoryDetailReq: string
- inventoryDetailUiType: string
- inventoryDetail_upd: string
- isLotNumberedAssembly: boolean
- isNumbered: boolean
- isNumberedAssembly: boolean
- isSerial: boolean
- item: assemblyItem
- itemBinList: string
- lastModifiedDate Date Last Modified: string (date-time)
- line: integer (int64)
- links Links: nsLink
-
nsLink - location: location
- maxReloadDate: string (date)
- memo Memo: string
-
Optionally enter a Memo. You can search for this text later to find this entry.
- minReloadDate: string (date)
- orderAssemblyQty: number (float)
- orderDoc: string
- origQuantity: number (float)
- outsourcingCharge: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- outsourcingChargeUnitPrice Unit Price: number (double)
- postingPeriod: accountingPeriod
- prevDate Previous Effective Date: string (date)
- qtyLmit: number (float)
- quantity Quantity: number (float)
-
Enter the number of assembly items you want to disassemble. You cannot enter a number higher than the Built number.
- refName Reference Name: string
- revision: itemRevision
- revisionMemo Revision Memo: string
- serialNumbers Serial Numbers: string
-
Enter the serial numbers for the assemblies you are building or unbuilding. You can enter up to 3800 characters in this field.
- subsidiary: subsidiary
- total Projected Value: number (double)
-
NetSuite calculates the projected value of this transaction. The projected value for the raw materials is the total value of the parts times the quantity being disassembled.
- tranDate Date: string (date)
-
Accept today's Date or enter another transaction date.
- tranId Ref No.: string
-
Enter an optional reference number for this transaction. You can use reference numbers to track transactions.
- units Unit of Measure: string
-
If the assembly you select uses Units of Measure, the base units are displayed in the Units field.
assemblyUnbuild-accountingBookDetailCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: assemblyUnbuild-accountingBookDetailElement
-
assemblyUnbuild-accountingBookDetailElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
assemblyUnbuild-accountingBookDetailElement
This record is available as a beta record.
- accountingBook: accountingBook
- exchangeRate Exchange Rate: number (double)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- revRecOnRevCommitment Rev Rec on Rev Commit.: boolean
- subsidiary: subsidiary
- tranIsVsoeBundle Transaction Is VSOE Bundle: boolean
assemblyUnbuild-component-componentInventoryDetail
This record is available as a beta record.
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- externalId External ID: string
- inventoryassignment: assemblyUnbuild-component-componentInventoryDetail-inventoryassignmentCollection
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemDescription Description: string
-
A more complete Description of the item.
- links Links: nsLink
-
nsLink - location: location
- quantity Quantity: number (float)
-
In the Quantity to Build field, enter the number of assembly items you want to build. You cannot enter a quantity that exceeds the amount displayed in the Buildable Quantity field.
- refName Reference Name: string
- toLocation: location
- unit Units: string
-
If the assembly uses Units of Measure, the base units are displayed in the Units field.
assemblyUnbuild-component-componentInventoryDetail-inventoryassignmentCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: assemblyUnbuild-component-componentInventoryDetail-inventoryassignmentElement
-
assemblyUnbuild-component-componentInventoryDetail-inventoryassignmentElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
assemblyUnbuild-component-componentInventoryDetail-inventoryassignmentElement
This record is available as a beta record.
- binNumber: bin
- expirationDate Expiration Date: string (date)
- internalId Internal ID: integer (int64)
- inventoryDetail Inventory Detail: integer (int64)
- inventoryStatus: inventoryStatus
- issueInventoryNumber: inventoryNumber
- links Links: nsLink
-
nsLink - packCarton Pack Carton: string
- pickCarton Pick Carton: string
- quantity Quantity: number (float)
- quantityAvailable Unpicked Bin Qty: number (float)
- receiptInventoryNumber Serial/Lot Number: string
- refName Reference Name: string
- secondaryQuantity Secondary Quantity: number (float)
- toBinNumber: bin
- toInventoryStatus: inventoryStatus
assemblyUnbuild-componentCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: assemblyUnbuild-componentElement
-
assemblyUnbuild-componentElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
assemblyUnbuild-componentElement
This record is available as a beta record.
- assemblyLevel: boolean
- binItem: boolean
- binNumbers Bin Numbers: string
- buildVariance: number (float)
- compItemName Component: string
- compItemUrl: string
- componentInventoryDetail: assemblyUnbuild-component-componentInventoryDetail
- componentInventoryDetailAvail: string
- componentInventoryDetailReq: string
- componentInventoryDetail_upd: string
- componentNumbers Serial Numbers: string
- componentUiType: string
- fulfillmentBin: string
- hasMembersOnBuild: boolean
- indentLevel: integer (int64)
- isNonInventory: boolean
- isNumbered: boolean
- isSerial: boolean
- item: string
- itemBinList: string
- itemCost: number (float)
- itemSource: object
-
- id Internal identifier.: string WORK_ORDER , PHANTOM , PURCHASE_ORDER , STOCK
- refName Reference Name: string
- lineNumber: integer (int64)
- links Links: nsLink
-
nsLink - oldquantity: number (float)
- orderDoc: integer (int64)
- orderLine: integer (int64)
- orderLineQty: number (float)
- origQuantity: number (float)
- quantity Quantity: number (float)
- quantityOnHand Quantity On Hand: number (float)
- refName Reference Name: string
- unitCost: number (float)
- unitCostOverride: string
- units Units: string
assemblyUnbuild-inventoryDetail
This record is available as a beta record.
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- externalId External ID: string
- inventoryassignment: assemblyUnbuild-inventoryDetail-inventoryassignmentCollection
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemDescription Description: string
-
A more complete Description of the item.
- links Links: nsLink
-
nsLink - location: location
- quantity Quantity: number (float)
-
In the Quantity to Build field, enter the number of assembly items you want to build. You cannot enter a quantity that exceeds the amount displayed in the Buildable Quantity field.
- refName Reference Name: string
- toLocation: location
- unit Units: string
-
If the assembly uses Units of Measure, the base units are displayed in the Units field.
assemblyUnbuild-inventoryDetail-inventoryassignmentCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: assemblyUnbuild-inventoryDetail-inventoryassignmentElement
-
assemblyUnbuild-inventoryDetail-inventoryassignmentElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
assemblyUnbuild-inventoryDetail-inventoryassignmentElement
This record is available as a beta record.
- binNumber: bin
- expirationDate Expiration Date: string (date)
- internalId Internal ID: integer (int64)
- inventoryDetail Inventory Detail: integer (int64)
- inventoryStatus: inventoryStatus
- issueInventoryNumber: inventoryNumber
- links Links: nsLink
-
nsLink - packCarton Pack Carton: string
- pickCarton Pick Carton: string
- quantity Quantity: number (float)
- quantityAvailable Unpicked Bin Qty: number (float)
- receiptInventoryNumber Serial/Lot Number: string
- refName Reference Name: string
- secondaryQuantity Secondary Quantity: number (float)
- toBinNumber: bin
- toInventoryStatus: inventoryStatus
assemblyUnbuildCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: assemblyUnbuild
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
assemblyUnbuild - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
billingAccount
- autoName Auto: boolean
-
Clear this box to manually enter a name for this record. If you leave this box marked, NetSuite assigns a name or number for this record based on your settings at Setup > Set Up Auto-Generated Numbers.
- billAddress Bill To: string
- billAddressList Bill To Select: string
-
Select the billing address you want to use for this billing account. Options are sourced from the customer record.
- billingSchedule: billingSchedule
- cashSaleForm: object
-
- id Internal identifier.: string -9905 , 95
- refName Reference Name: string
- class: classification
- createdBy Created By: string
- createdDate Created: string (date-time)
- currency: currency
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- customer: customer
- customerDefault Customer Default: boolean
-
If checked, this field indicates that this is the default billing account for this customer.
- department: department
- displayName: string
- externalId External ID: string
- frequency: object
-
- id Internal ID: string
-
The internal ID for this record is shown here. If you do not want to show internal IDs, clear the Show Internal IDs box at Home > Set Preferences.
- idNumber Account Number: string
-
The number of the billing account. This number is automatically generated upon save.
- inactive Inactive: boolean
-
Check this box if the billing account is no longer active.
- invoiceForm: object
-
- lastBillCycleDate Last Bill Cycle Date: string (date)
- lastBillDate Last Bill Date: string (date)
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - location: location
- memo Account Description: string
-
Enter a description for this billing account.
- name Name: string
-
The name of this billing account.
- nextBillCycleDate: object
-
- id Internal identifier.: string
- refName Reference Name: string
- refName Reference Name: string
- requestOffCycleInvoice Use Off-Cycle Invoice for Advance Charges: boolean
-
Check this box if you want advance charges for this billing account invoiced before the first scheduled bill date.
- shipAddress Ship To: string
-
The shipping address for this billing account.
- shipAddressList Ship To Select: string
-
Select the shipping address you want to use for this billing account. Options are sourced from the customer record.
- startDate Start Date: string (date)
-
Enter the date this person or company became a customer, lead or prospect. If this person or company has a contract with you, enter the start date of the contract. If you enter an estimate or an opportunity for this customer, this field will be updated with the date of that transaction.
- subsidiary: subsidiary
billingAccountCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: billingAccount
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
billingAccount - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
billingClass
This record is available as a beta record.
- description Description: string
-
Enter a description of this other list item.
- externalId External ID: string
- id Internal ID: string
- isInactive Inactive: boolean
-
Check this box to remove all references to this record from your account. You can reactivate the record at any time.
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - name Billing Class: string
-
Enter the name for this record. This name appears in lists that include this record.
- price Price: number (double)
- priceCost: billingClass-priceCostCollection
- refName Reference Name: string
- saleUnit Sale Unit: string
-
Select a sale unit for this billing class. The selections available in this field are determined by the units type selected. Sale unit enables you to create custom interval billing rates. When creating charge rules for charge-based billing projects, the billing class rate is used to create charges for the selected interval.
- unitsType: unitsType
billingClass-priceCostCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: billingClass-priceCostElement
-
billingClass-priceCostElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
billingClassCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: billingClass
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
billingClass - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
billingRateCard
This record is available as a beta record.
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- customer: customer
- effectivedate Effective Date: string (date)
-
Enter the date you want this version to begin being used.
- enddate End Date: string (date)
-
This is the last date the displayed rate card is used.
- externalId External ID: string
- id Internal ID: string
- isinactive Inactive: boolean
-
Check this box to remove all references to this record from your account. You can reactivate the record at any time.
- links Links: nsLink
-
nsLink - name Name: string
-
Enter the name for this record. This name appears in lists that include this record.
- ratecardpricing: billingRateCard-ratecardpricingCollection
- ratecardpricingmulti: billingRateCard-ratecardpricingmulti
- ratecardversion: billingRateCard-ratecardversionCollection
- refName Reference Name: string
- version Version: integer (int64)
-
This is the version number of the current billing rate card. To create a new version, click Create New Version.
billingRateCard-ratecardpricingCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: billingRateCard-ratecardpricingElement
-
billingRateCard-ratecardpricingElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
billingRateCard-ratecardpricingElement
This record is available as a beta record.
- billingclass Billing Class: string
- billingclassid Billing Class: integer (int64)
- currentrate: number (float)
- links Links: nsLink
-
nsLink - price Price: number (double)
- refName Reference Name: string
- saleunit Sale Unit: string
- serviceitem: nsResource
- slavedrate: number (float)
- unitstype: unitsType
billingRateCard-ratecardpricingmulti
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: billingRateCard-ratecardpricingmultiElement
-
billingRateCard-ratecardpricingmultiElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
billingRateCard-ratecardpricingmultiElement
This record is available as a beta record.
- billingclass Billing Class: string
- billingclassid Billing Class: integer (int64)
- currency: object
-
- value Value: string
- currencykey Currency: integer (int64)
- currentrate: number (float)
- links Links: nsLink
-
nsLink - price Price: number (double)
- refName Reference Name: string
- saleunit Sale Unit: string
- serviceitem: nsResource
- slavedrate: number (float)
- unitstype: unitsType
billingRateCard-ratecardversion-ratecardpricingforsearchCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: billingRateCard-ratecardversion-ratecardpricingforsearchElement
-
billingRateCard-ratecardversion-ratecardpricingforsearchElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
billingRateCard-ratecardversion-ratecardpricingmultiforsearch
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: billingRateCard-ratecardversion-ratecardpricingmultiforsearchElement
-
billingRateCard-ratecardversion-ratecardpricingmultiforsearchElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
billingRateCard-ratecardversionCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: billingRateCard-ratecardversionElement
-
billingRateCard-ratecardversionElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
billingRateCard-ratecardversionElement
This record is available as a beta record.
- effectivedate Effective Date: string (date)
- enddate End Date: string (date)
- links Links: nsLink
-
nsLink - ratecardpricingforsearch: billingRateCard-ratecardversion-ratecardpricingforsearchCollection
- ratecardpricingmultiforsearch: billingRateCard-ratecardversion-ratecardpricingmultiforsearch
- refName Reference Name: string
- version Version: integer (int64)
billingRateCardCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: billingRateCard
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
billingRateCard - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
billingRevenueEvent
This record is available as a beta record.
- amount Amount (Transaction Currency): number (double)
-
This is the total revenue amount included in this revenue recognition plan.
- cumulativePercentComplete Cumulative Percent Complete: number (double)
-
Enter a value in this field when the Amount Source for the associated revenue recognition rule is Event-Percent Complete.
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- enddate End Date: string (date)
-
Enter or select a date for the rev rec end date.
- eventType: nsResource
- eventdate Date: string (date)
-
Enter or select a date for the trigger.
- eventpurpose: object
-
- id Internal identifier.: string ACTUAL , FORECAST
- refName Reference Name: string
- externalId External ID: string
- id Internal ID: string
- links Links: nsLink
-
nsLink - projectRevenueRule: object
-
- id Internal identifier.: string
- refName Reference Name: string
- quantity Quantity: number (float)
-
Enter a value in this field when the Amount Source for the associated revenue recognition rule is Event-Percent based on quantity.
- refName Reference Name: string
- startdate Start Date: string (date)
-
Enter or select a date for the rev rec start date.
- subscriptionLine: subscriptionLine
- transactionLine Transaction Line: string
-
Select a transaction line as the sales contract source. Each revenue recognition event may have only one sales contract source.
billingRevenueEventCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: billingRevenueEvent
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
billingRevenueEvent - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
billingSchedule
This record is available as a beta record.
- applyToSubtotal Apply To Subtotal: boolean
-
Check this box to create a billing schedule applied to the pre-tax, pre-discount subtotal of a transaction. To create a billing schedule applied to a transaction subtotal, Type must be set to Standard and Recurrence Frequency must be set to Custom.
- billforactuals Invoice Actual Time Only: boolean
-
Check the box to invoice only actual time worked and recorded in Time Tracking in each interval. If checked, you cannot enter an initial amount. Clear the box to invoice planned time and actual time worked.
- dayperiod: integer (int64)
- externalId External ID: string
- frequency: object
-
- id Internal ID: string
- inArrears In Arrears: boolean
-
Check this box to bill at the end of each period, instead of the beginning. For example, on a billing schedule with no initial amount, standard monthly frequency, in arrears, the first invoice is created one month from one day after the sales order date. Note: When this box is not checked, the first invoice bills for the initial amount plus the first recurring amount.
- initialAmount Initial Amount: number (double)
-
Enter the initial bill amount generated by this billing schedule. This can be entered as a percentage or a set currency amount if you use line-level billing schedules. You can only use percentage initial amounts if you apply billing schedules on the transaction level.
- initialTerms: term
- isInactive Inactive: boolean
-
Check this box to inactivate this billing schedule. You cannot apply inactive schedules to orders.
- isPublic Public: boolean
-
Check this box to make this billing schedule public. You can select a public schedule on any estimate, sales order or item record. If you do not check the Public box, this schedule is Private. A private billing schedule shows only in the transaction it is created from. If you create a private billing schedule from a transaction, that schedule is attached to items on the resulting sales order. Note: This check box is available only for schedules created on-the-fly. If you create a regular schedule, it defaults to Public and cannot be changed.
- job: job
- links Links: nsLink
-
nsLink - milestone: billingSchedule-milestoneCollection
- monthdom: integer (int64)
- monthdow: object
-
- id Internal identifier.: string 1 , 2 , 3 , 4 , 5 , 6 , 7 , -1
- refName Reference Name: string
- monthdowim: object
-
- id Internal identifier.: string 1 , 2 , 3 , 4 , 5
- refName Reference Name: string
- monthmode: string
- name Name: string
-
Enter the name of this billing schedule.
- numberRemaining Recurrence Count: integer (int64)
-
Enter the number of subsequent payments you want the order amount divided into.
- recurrence: billingSchedule-recurrenceCollection
- recurrencePattern: object
-
- id Internal identifier.: string FIXED_BILL_DATE , ANNIVERSARY_BILL_DATE
- refName Reference Name: string
- recurrenceTerms: term
- recurrencedowmask: string
- refName Reference Name: string
- repeatEvery: object
-
- id Internal identifier.: string 1 , 2 , 3 , 4 , 6
- refName Reference Name: string
- repeatunit: string
- scheduleType: object
-
- id Internal identifier.: string FBM , STD , TM , FBI , CB
- refName Reference Name: string
- seriesStartDate Recurrence Date: string (date)
- transaction: nsResource
- weekfriday Friday: boolean
- weekmonday Monday: boolean
- weeksaturday Saturday: boolean
- weeksunday Sunday: boolean
- weekthursday Thursday: boolean
- weektuesday Tuesday: boolean
- weekwednesday Wednesday: boolean
- yeardom: integer (int64)
- yeardow: object
-
- id Internal identifier.: string 1 , 2 , 3 , 4 , 5 , 6 , 7 , -1
- refName Reference Name: string
- yeardowim: object
-
- id Internal identifier.: string 1 , 2 , 3 , 4 , 5
- refName Reference Name: string
- yeardowimmonth: object
-
- yearmode: string
- yearmonth: object
-
billingSchedule-milestoneCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: billingSchedule-milestoneElement
-
billingSchedule-milestoneElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
billingSchedule-milestoneElement
This record is available as a beta record.
- comments Comment: string
- links Links: nsLink
-
nsLink - milestoneactualcompletiondate Actual Completion Date: string (date)
- milestoneamount Amount: number (double)
- milestonecompleted Completed: boolean
- milestonedate Estimated Completion Date: string (date)
- milestoneid: number (double)
- milestoneterms: term
- projecttask: projectTask
- refName Reference Name: string
billingSchedule-recurrenceCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: billingSchedule-recurrenceElement
-
billingSchedule-recurrenceElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
billingSchedule-recurrenceElement
This record is available as a beta record.
- amount Amount: number (double)
- count Count: integer (int64)
- links Links: nsLink
-
nsLink - paymentterms: term
- recurrencedate Date: string (date)
- recurrenceid: integer (int64)
- refName Reference Name: string
- relativetoprevious Relative to Previous: boolean
- units: object
-
- id Internal identifier.: string DAY , WEEK , MONTH
- refName Reference Name: string
billingScheduleCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: billingSchedule
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
billingSchedule - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
bin
This record is available as a beta record.
- binNumber Bin Number: string
-
Enter a number, name, or code for this bin that can help you identify its location in your warehouse. For example, you can track bins by number and track rows and shelves by letter. The first bin in the first shelf of the first row would be AA01. Note: Bin numbers cannot include an Ampersand (&).
- externalId External ID: string
- id Internal ID: string
- inventoryBalance: bin-inventoryBalanceCollection
- isInactive Inactive: boolean
-
Check this box to remove all references to this record from your account. You can reactivate the record at any time.
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
-
Enter a description or notes for this bin. This memo is only stored with this record and not visible on other pages or lists.
- refName Reference Name: string
- sequenceNumber Sequence Number: number (float)
-
Enter the sequence number for the bin. Sequence numbers are used during bin sorting, to determine the recommended bin for items on a pick task.
- type: object
-
- id Internal identifier.: string STORAGE , OUTBOUND_STAGING , PICKING , INBOUND_STAGING , NONE , WIP
- refName Reference Name: string
- zone: nsResource
bin-inventoryBalanceCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: bin-inventoryBalanceElement
-
bin-inventoryBalanceElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
bin-inventoryBalanceElement
This record is available as a beta record.
- committedQtyPerLocation Committed Quantity (Per Location): string
- committedQtyPerSerialLotNumber Committed Quantity (Per Serial/Lot Number): string
- committedQtyPerSerialLotNumberLocation Committed Quantity (Per Serial/Lot Number & Location): string
- inventoryNumber: inventoryNumber
- inventoryStatus: inventoryStatus
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- links Links: nsLink
-
nsLink - location: location
- quantityAvailable Available Quantity: string
- quantityOnHand On-Hand Quantity: string
- quantityPicked Picked Quantity: string
- refName Reference Name: string
binCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: bin
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
bin - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
binTransfer
This record is available as a beta record.
- createdDate Date Created: string (date-time)
- externalId External ID: string
- id Internal ID: string
- inventory: binTransfer-inventoryCollection
- lastModifiedDate Date Last Modified: string (date-time)
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
-
Optionally enter a Memo for this transfer. Then, you can search for the text entered here to find this transfer.
- prevDate Previous Effective Date: string (date)
- refName Reference Name: string
- subsidiary: subsidiary
- tranDate Date: string (date)
-
Verify or enter the date of this transfer.
- tranId Bin Transfer #: string
-
This field displays the next bin transfer number or To Be Generated by the system.
binTransfer-inventory-inventoryDetail
This record is available as a beta record.
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- externalId External ID: string
- inventoryassignment: binTransfer-inventory-inventoryDetail-inventoryassignmentCollection
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemDescription Description: string
-
A more complete Description of the item.
- links Links: nsLink
-
nsLink - location: location
- quantity Quantity: number (float)
-
In the Quantity to Build field, enter the number of assembly items you want to build. You cannot enter a quantity that exceeds the amount displayed in the Buildable Quantity field.
- refName Reference Name: string
- toLocation: location
- unit Units: string
-
If the assembly uses Units of Measure, the base units are displayed in the Units field.
binTransfer-inventory-inventoryDetail-inventoryassignmentCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: binTransfer-inventory-inventoryDetail-inventoryassignmentElement
-
binTransfer-inventory-inventoryDetail-inventoryassignmentElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
binTransfer-inventory-inventoryDetail-inventoryassignmentElement
This record is available as a beta record.
- binNumber: bin
- expirationDate Expiration Date: string (date)
- internalId Internal ID: integer (int64)
- inventoryDetail Inventory Detail: integer (int64)
- inventoryStatus: inventoryStatus
- issueInventoryNumber: inventoryNumber
- links Links: nsLink
-
nsLink - packCarton Pack Carton: string
- pickCarton Pick Carton: string
- quantity Quantity: number (float)
- quantityAvailable Unpicked Bin Qty: number (float)
- receiptInventoryNumber Serial/Lot Number: string
- refName Reference Name: string
- secondaryQuantity Secondary Quantity: number (float)
- toBinNumber: bin
- toInventoryStatus: inventoryStatus
binTransfer-inventoryCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: binTransfer-inventoryElement
-
binTransfer-inventoryElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
binTransfer-inventoryElement
This record is available as a beta record.
- description Description: string
- frombins From Bins: string
- inventoryDetail: binTransfer-inventory-inventoryDetail
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemunits Units: string
- line: string
- links Links: nsLink
-
nsLink - preferredBin Preferred Bin: string
- quantity Quantity: number (float)
- refName Reference Name: string
- tobins To Bins: string
binTransferCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: binTransfer
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
binTransfer - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
binWorksheet
This record is available as a beta record.
- createdDate Date Created: string (date-time)
- externalId External ID: string
- id Internal ID: string
- item: binWorksheet-itemCollection
- lastModifiedDate Date Last Modified: string (date-time)
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
-
Enter any comment about why you are deleting this transaction. If you selected the standard deletion reason, Other, you must provide a comment in this field.
- prevDate Previous Effective Date: string (date)
- refName Reference Name: string
- subsidiary: subsidiary
- tranDate Date: string (date)
-
Accept today's Date as the transaction date, or select another date.
- tranId Bin Worksheet #: string
-
The transaction ID number shows in this field. If you use auto-generated numbering, the next number in the sequence shows by default.
binWorksheet-item-inventoryDetail
This record is available as a beta record.
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- externalId External ID: string
- inventoryassignment: binWorksheet-item-inventoryDetail-inventoryassignmentCollection
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemDescription Description: string
-
A more complete Description of the item.
- links Links: nsLink
-
nsLink - location: location
- quantity Quantity: number (float)
-
In the Quantity to Build field, enter the number of assembly items you want to build. You cannot enter a quantity that exceeds the amount displayed in the Buildable Quantity field.
- refName Reference Name: string
- toLocation: location
- unit Units: string
-
If the assembly uses Units of Measure, the base units are displayed in the Units field.
binWorksheet-item-inventoryDetail-inventoryassignmentCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: binWorksheet-item-inventoryDetail-inventoryassignmentElement
-
binWorksheet-item-inventoryDetail-inventoryassignmentElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
binWorksheet-item-inventoryDetail-inventoryassignmentElement
This record is available as a beta record.
- binNumber: bin
- expirationDate Expiration Date: string (date)
- internalId Internal ID: integer (int64)
- inventoryDetail Inventory Detail: integer (int64)
- inventoryStatus: inventoryStatus
- issueInventoryNumber: inventoryNumber
- links Links: nsLink
-
nsLink - packCarton Pack Carton: string
- pickCarton Pick Carton: string
- quantity Quantity: number (float)
- quantityAvailable Unpicked Bin Qty: number (float)
- receiptInventoryNumber Serial/Lot Number: string
- refName Reference Name: string
- secondaryQuantity Secondary Quantity: number (float)
- toBinNumber: bin
- toInventoryStatus: inventoryStatus
binWorksheet-itemCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: binWorksheet-itemElement
-
binWorksheet-itemElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
binWorksheet-itemElement
This record is available as a beta record.
- baseuomquantity: number (float)
- conversionrate: number (float)
- description Description: string
- inventoryDetail: binWorksheet-item-inventoryDetail
- item Item: string
- itembinnumbers Bin Numbers: string
- itembins Bins: string
- itemname Item: string
- itemonhand Total: number (float)
- itemunits Units: string
- itemunitslabel: string
- line: string
- links Links: nsLink
-
nsLink - quantity Quantity: number (float)
- refName Reference Name: string
binWorksheetCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: binWorksheet
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
binWorksheet - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
blanketPurchaseOrder
This record is available as a beta record.
- accountingBookDetail: blanketPurchaseOrder-accountingBookDetailCollection
- approvalStatus: object
-
- id Internal identifier.: string 11 , 1 , 2 , 3
- refName Reference Name: string
- billedAmount Billed Amount: number (double)
-
The Summary box displays the total billed amount for all orders created from this contract or blanket purchase order.
- billingInstructions Billing Instructions: string
-
Enter details to provide special instructions to vendors regarding billing.
- carrier Carrier: string
-
Select a specific shipping carrier in the Carrier field. For example, the buyer may have an account with a particular carrier to utilize better freight rates.
- class: classification
- createdDate Date Created: string (date-time)
- createdFrom: nsResource
- currency: currency
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- department: department
- discountAmount Discount Amount: number (double)
- discountDate Discount Date: string (date)
- dueDate Due Date: string (date)
- effectivityBasedOn: object
-
- id Internal identifier.: string ORDERDATE , RECEIPTDATE
- refName Reference Name: string
- email Email: string
- employee: employee
- endDate End Date: string (date)
-
End Date – Enter the last date to include orders in this schedule.
- entity: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- exchangeRate Exchange Rate: number (double)
-
The value of this field is set to 1 when a currency is selected and should not be changed. It may be used in the future for multiple currency support.
- excludefromsupplyplanning Exclude from Supply Planning: boolean
- expense: blanketPurchaseOrder-expenseCollection
- externalId External ID: string
- id Internal ID: string
- incoTerm: nsResource
- item: blanketPurchaseOrder-itemCollection
- lastModifiedDate Date Last Modified: string (date-time)
- links Links: nsLink
-
nsLink - location: location
- maximumAmount Maximum Amount: number (double)
-
This is is the maximum currency amount used for determining the required approval level, if you use approval routing.
- memo Memo: string
-
Enter any comment about why you are deleting this transaction. If you selected the standard deletion reason, Other, you must provide a comment in this field.
- message Vendor Message: string
- nextApprover: employee
- nexus: nexus
- orderStatus: object
-
- id Internal identifier.: string A , R , B , H
- refName Reference Name: string
- originator Originator: string
- otherRefNum PO/Check Number: string
-
This field displays the identifying number of the entity you select in the next field.
- packingListInstructions Packing List Instructions: string
-
Enter details to provide special instructions to vendors regarding the packing list.
- prevDate Previous Effective Date: string (date)
- productLabelingInstructions Product Labeling Instructions: string
-
Enter details to provide special instructions to vendors regarding labeling the product.
- purchaseOrderInstructions Purchase Order Instructions: string
-
Enter details to provide special instructions to vendors regarding the purchase order.
- purchasedAmount Purchased Amount: number (double)
-
The Summary box displays the total purchased amount for all orders created from this contract or blanket purchase order.
- receivedAmount Received Amount: number (double)
-
The Summary box displays the total received amount for all orders created from this contract or blanket purchase order.
- refName Reference Name: string
- source: object
-
- startDate Start Date: string (date)
-
Start Date – Enter the first date to include orders in this schedule.
- status: object
-
- id Internal identifier.: string A , R , B , H
- refName Reference Name: string
- storeOrder: string
- subsidiary: subsidiary
- terms: term
- toBeEmailed To Be Emailed: boolean
-
Select Yes if you want to email this form. Select No if you do not want to email this form. Select Respect Customer Preference to send email based on the default preference on the customer record. Set the preference on the Info subtab of a customer record in the Send Transactions Via field.
- toBeFaxed To Be Faxed: boolean
- toBePrinted To Be Printed: boolean
- tranDate Date: string (date)
-
Accept today's Date as the transaction date, or select another date.
- tranId Transaction Number: string
-
The transaction ID number shows in this field. If you use auto-generated numbering, the next number in the sequence shows by default.
- webSite: string
blanketPurchaseOrder-accountingBookDetailCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: blanketPurchaseOrder-accountingBookDetailElement
-
blanketPurchaseOrder-accountingBookDetailElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
blanketPurchaseOrder-accountingBookDetailElement
This record is available as a beta record.
- accountingBook: accountingBook
- exchangeRate Exchange Rate: number (double)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- revRecOnRevCommitment Rev Rec on Rev Commit.: boolean
- subsidiary: subsidiary
- tranIsVsoeBundle Transaction Is VSOE Bundle: boolean
blanketPurchaseOrder-expense-orderSchedule
This record is available as a beta record.
- createPurchaseOrder: object
-
- id Internal identifier.: string MANUAL , LEAD
- refName Reference Name: string
- createSchedule: object
-
- id Internal identifier.: string MANUAL , AUTO
- refName Reference Name: string
- currencyPrecision: integer (int64)
- endDate End Date: string (date)
- id Internal ID: integer (int64)
- item: integer (int64)
- lineId: integer (int64)
- links Links: nsLink
-
nsLink - maxDate: string (date)
- maxOrderDate: string (date)
- minDate: string (date)
- minOrderDate: string (date)
- refName Reference Name: string
- releaseFrequency: object
-
- id Internal identifier.: string WEEKLY , QUARTERLY , DAILY , MONTHLY
- refName Reference Name: string
- schedule: blanketPurchaseOrder-expense-orderSchedule-scheduleCollection
- startDate Start Date: string (date)
- total Total Amount: number (double)
- totalScheduled: number (float)
- transactionId Transaction ID: integer (int64)
- updateAmount: number (float)
- updateDays: string
blanketPurchaseOrder-expense-orderSchedule-scheduleCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: blanketPurchaseOrder-expense-orderSchedule-scheduleElement
-
blanketPurchaseOrder-expense-orderSchedule-scheduleElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
blanketPurchaseOrder-expense-orderSchedule-scheduleElement
This record is available as a beta record.
- amount Amount: number (double)
- id ID: integer (int64)
- links Links: nsLink
-
nsLink - memo Memo: string
- orderSchedule Order Schedule: integer (int64)
- purchaseOrder: nsResource
- quantity: number (float)
- refName Reference Name: string
- release Release: boolean
- tranDate Date: string (date)
blanketPurchaseOrder-expenseCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: blanketPurchaseOrder-expenseElement
-
blanketPurchaseOrder-expenseElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
blanketPurchaseOrder-expenseElement
This record is available as a beta record.
- account: account
- amount Amount: number (double)
- amountOrdered Amount Ordered: number (double)
- category: expenseCategory
- class: classification
- department: department
- line Line: integer (int64)
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
- orderSchedule: blanketPurchaseOrder-expense-orderSchedule
- refName Reference Name: string
blanketPurchaseOrder-item-orderSchedule
This record is available as a beta record.
- createPurchaseOrder: object
-
- id Internal identifier.: string MANUAL , LEAD
- refName Reference Name: string
- createSchedule: object
-
- id Internal identifier.: string MANUAL , AUTO
- refName Reference Name: string
- currencyPrecision: integer (int64)
- endDate End Date: string (date)
- id Internal ID: integer (int64)
- item: integer (int64)
- lineId: integer (int64)
- links Links: nsLink
-
nsLink - maxDate: string (date)
- maxOrderDate: string (date)
- minDate: string (date)
- minOrderDate: string (date)
- refName Reference Name: string
- releaseFrequency: object
-
- id Internal identifier.: string WEEKLY , QUARTERLY , DAILY , MONTHLY
- refName Reference Name: string
- schedule: blanketPurchaseOrder-item-orderSchedule-scheduleCollection
- startDate Start Date: string (date)
- total Total Quantity: number (float)
- totalScheduled: number (float)
- transactionId Transaction ID: integer (int64)
- updateAmount: number (float)
- updateDays: string
blanketPurchaseOrder-item-orderSchedule-scheduleCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: blanketPurchaseOrder-item-orderSchedule-scheduleElement
-
blanketPurchaseOrder-item-orderSchedule-scheduleElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
blanketPurchaseOrder-item-orderSchedule-scheduleElement
This record is available as a beta record.
- allocatedDemand Allocated Demand: number (float)
- amount: number (double)
- id ID: integer (int64)
- links Links: nsLink
-
nsLink - memo Memo: string
- orderSchedule Order Schedule: integer (int64)
- purchaseOrder: nsResource
- quantity Quantity: number (float)
- refName Reference Name: string
- release Release: boolean
- tranDate Date: string (date)
blanketPurchaseOrder-itemCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: blanketPurchaseOrder-itemElement
-
blanketPurchaseOrder-itemElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
blanketPurchaseOrder-itemElement
This record is available as a beta record.
- amount Amount: number (double)
- billVarianceStatus: object
-
- id Internal identifier.: string NOVARIANCES , JOURNALNOTPOSTED , JOURNALPOSTED
- refName Reference Name: string
- class: classification
- department: department
- description Description: string
- initOqpBucket Initial OQP Bucket: string
- isClosed Closed: boolean
- isOpen Is Opened: boolean
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemSubtype: object
-
- id Internal identifier.: string Sale , Purchase , Resale
- refName Reference Name: string
- itemType: object
-
- job: job
- licenseCode License Code: string
- line Transaction Line: integer (int64)
- linked Linked: boolean
- links Links: nsLink
-
nsLink - location: location
- marginal Marginal: boolean
- matrixType Matrix Type: string
- minQty Minimum Quantity: number (float)
- options Options: string
- oqpBucket Oqp Bucket: string
- orderSchedule: blanketPurchaseOrder-item-orderSchedule
- printItems Print Items: boolean
- quantity Quantity: number (float)
- rate Rate: number (double)
- rateIncludingTax Rate: number (double)
- rateSchedule Rate Schedule: string
- refName Reference Name: string
- subsidiary: subsidiary
- units Units: string
- vendorName Vendor Name: string
blanketPurchaseOrderCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: blanketPurchaseOrder
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
blanketPurchaseOrder - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
bom
This record is available as a beta record.
- assembly: bom-assemblyCollection
- availableForAllAssemblies Available For All Assemblies: boolean
-
Check the Available for All Assemblies box to allow all assemblies to use this BOM. Clear the box to limit BOM use to only the selected assemblies.
- availableForAllLocations Available For All Locations: boolean
-
Check the Available for all Locations box to allow all locations to use this BOM. Clear the box to allow only the selected locations use this BOM.
- availableForLocations: locationCollection
- availableForSubisidiaries: subsidiaryCollection
- bomAssemblyLocation: bom-bomAssemblyLocationCollection
- bomRevision: bomRevisionCollection
- createdDate Date Created: string (date-time)
-
The date this Bill of Materials was created.
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- externalId External ID: string
- hashOfLinkedAssemblies: string
- id Internal ID: string
- includeChildren Include Children: boolean
- isInactive Inactive: boolean
-
Check the Inactive box if you do not want this BOM or BOM revision to appear in search lists on records and forms. Clear this box if you want this BOM or BOM revision to appear in lists.
- lastModifiedDate Last Modified Date: string (date-time)
- legacyBomForAssembly: assemblyItem
- links Links: nsLink
-
nsLink - memo Memo: string
-
Optionally, in the Memo field, enter any information you want to include with this BOM.
- name Name: string
-
Enter a unique and descriptive Bill of Materials (BOM) or BOM revision Name. For example, Grill BOM or BOM Revision 1.
- refName Reference Name: string
- restrictToAssemblies: assemblyItemCollection
- restrictToLocations: locationCollection
- subsidiary: subsidiaryCollection
- useComponentYield Use Component Yield: boolean
-
Check the Use Component Yield box to apply component yield to all BOM revisions. Component yield is the percentage of the component that survives the manufacturing process. To learn more, see the help topic Component Yield Preferences.
- usedOnAssembly Used On Assembly: boolean
-
If checked, the read-only Used on Assembly box indicates that the BOM is associated to an assembly.
bom-assemblyCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: bom-assemblyElement
-
bom-assemblyElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
bom-assemblyElement
This record is available as a beta record.
- assembly: assemblyItem
- canBeMaster Can be Master Default: boolean
- links Links: nsLink
-
nsLink - masterDefault Master Default: boolean
- refName Reference Name: string
bom-bomAssemblyLocationCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: bom-bomAssemblyLocationElement
-
bom-bomAssemblyLocationElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
bom-bomAssemblyLocationElement
This record is available as a beta record.
- assembly: assemblyItem
- isMasterDefaultBom Master Default: boolean
- links Links: nsLink
-
nsLink - refName Reference Name: string
bomCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: bom
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
bom - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
bomRevision
This record is available as a beta record.
- actiontype Action: string
- billOfMaterials: bom
- component: bomRevision-componentCollection
- createdDate Date Created: string (date-time)
-
The date this Bill of Materials was created.
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- effectiveEndDate Effective End Date: string (date)
-
Click the calendar icon to set an Effective End Date. Not entering both effective start and end dates, may affect future revisions.
- effectiveStartDate Effective Start Date: string (date)
-
Click the calendar icon to set an Effective Start Date. Not entering both effective start and end dates, may affect future revisions.
- externalId External ID: string
- id Internal ID: string
- isInactive Inactive: boolean
-
Check the Inactive box if you do not want this BOM or BOM revision to appear in search lists on records and forms. Clear this box if you want this BOM or BOM revision to appear in lists.
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - memo Memo: string
-
Optionally, in the Memo field, enter any information you want to include with this BOM.
- name Name: string
-
Enter a unique and descriptive Bill of Materials (BOM) or BOM revision Name. For example, Grill BOM or BOM Revision 1.
- previousRevisionKey Revision: integer (int64)
- refName Reference Name: string
- updatePreviousRevision Update: boolean
- useDefaulting Use Defaulting: string
bomRevision-componentCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: bomRevision-componentElement
-
bomRevision-componentElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
bomRevisionCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: bomRevision
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
bomRevision - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
bonus
This record is available as a beta record.
- bonusAmountAbsolute Amount: number (float)
- bonusAwardDate Award Date: string (date)
- bonusComment Comment: string
- bonusCurrency Currency: string
- bonusEmployee: employee
- bonusModifiedBy: employee
- bonusStatus: object
-
- id Internal identifier.: string none , ready_to_pay , being_processed , paid , cancelled
- refName Reference Name: string
- bonusType: nsResource
- bonusamountPercentage Percentage: number (float)
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- externalId External ID: string
- id Internal ID: string
- links Links: nsLink
-
nsLink - refName Reference Name: string
bonusCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: bonus
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
bonus - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
budgetExchangeRate
This record is available as a beta record.
- accountingbook: accountingBook
- averagerate Average Exchange Rate: number (double)
-
This is the average exchange rate. This rate is calculated from a weighted average of the exchange rates for transactions applied during the period to accounts with a general rate type of Average. This rate is used to translate accounts in the income statement and to build retained earnings.
- currentrate Current Exchange Rate: number (double)
-
This is the current exchange rate. Also referred to as ending rate. This rate is based on the currency exchange rate that is effective at the end of the reported upon period. This rate is used for most asset and liability accounts in the balance sheet.
- externalId External ID: string
- fromcurrency: currency
- fromsubsidiary: subsidiary
- historicalrate Historical Exchange Rate: number (double)
-
This is the historical exchange rate. This rate is calculated from a weighted average of the exchange rates for transactions applied during the period to accounts with a general rate type of Historical. This rate is used for equity accounts, or owner's investments, in the balance sheet.
- id Internal ID: string
- isderived Exchange Rate Derived: boolean
-
If this box is checked, the exchange rate is indirect. Indirect rates are rates set between subsidiaries more than one hierarchical level removed from each other, such as a child and grandchild. Indirect rates are always set by the system and cannot be edited or auto calculated by users.
- iseliminationsubsidiary Is Elimination Subsidiary: boolean
-
If this box is checked, the subsidiary associated with this budget exchange rate is an elimination subsidiary. You cannot edit the rates for an elimination subsidiary.
- isperiodclosed Period Closed: boolean
-
If this box is checked, the accounting period is closed.
- links Links: nsLink
-
nsLink - periodStartDate Period Start Date: string (date)
-
This is the date on which the accounting period began.
- postingperiod: accountingPeriod
- refName Reference Name: string
- tocurrency: currency
- tosubsidiary: subsidiary
budgetExchangeRateCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: budgetExchangeRate
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
budgetExchangeRate - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
bulkOwnershipTransfer
This record is available as a beta record.
- externalId External ID: string
- id Internal ID: string
- inboundShipmentNumber Inbound Shipment: string
- incoterm: nsResource
- items: bulkOwnershipTransfer-itemsCollection
- links Links: nsLink
-
nsLink - postingperiod: accountingPeriod
- receivinglocation: location
- refName Reference Name: string
- trandate Date: string (date)
- vendor: vendor
bulkOwnershipTransfer-itemsCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: bulkOwnershipTransfer-itemsElement
-
bulkOwnershipTransfer-itemsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
bulkOwnershipTransfer-itemsElement
This record is available as a beta record.
- amount Amount: number (double)
- currency: currency
- currencyPrecision Currency Precision: integer (int64)
- description Description: string
- exchangeRate Exchange Rate: number (double)
- exchangeRatePurchOrd Exchange Rate (Line): number (double)
- id ID: integer (int64)
- incoterm: nsResource
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemType Item Type: string
- links Links: nsLink
-
nsLink - origLine Item Source: integer (int64)
- poRate PO Rate: number (double)
- process Process: boolean
- purchaseOrder: nsResource
- quantity Quantity: number (float)
- rate Rate: number (double)
- receivingLocation: location
- refName Reference Name: string
- uniqueKey Unique Key: string
- unit Unit: string
- unitId Unit of Measure: string
- unitRate Conversion Rate {1}: number (float)
- vendor Vendor: string
bulkOwnershipTransferCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: bulkOwnershipTransfer
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
bulkOwnershipTransfer - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
calendarEvent
- accessLevel: object
-
- id Internal identifier.: string PUBLIC , PRIVATE , SHOW AS BUSY
- refName Reference Name: string
- allDayEvent All Day: boolean
-
If this event will take place all day long, check this box when you are creating the event. The event appears in the calendar from 8:00 a.m. until 6:00 p.m.
- attendee: calendarEvent-attendeeCollection
- bom: bom
- bomRevision: bomRevision
- company: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- completedDate Completed Date: string (date)
- contact: contact
- createdDate Date Created: string (date-time)
- customForm: object
-
- id Internal identifier.: string -110 , -10110
- refName Reference Name: string
- endTime End time: string
-
Select the time this event ends. If the access to this event is Public, the start and end times appear next to the title of this event on the calendar. The time frame for the event shows on daily and weekly views of the calendar but does not show on the monthly view.
- externalId External ID: string
- id Internal ID: string
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - location Location: string
-
Enter the location where this event will take place.
- message Message: string
-
Enter any message or notes for this event. This message appears under the event title in the e-mail sent to the people invited to this event.
- mfgRouting: manufacturingRouting
- organizer: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- owner: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- refName Reference Name: string
- relatedItem: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- reminderMinutes: object
-
- id Internal identifier.: string 0 , 5 , 10 , 15 , 30
- refName Reference Name: string
- reminderType: object
-
- id Internal identifier.: string POPUP , EMAIL
- refName Reference Name: string
- resource: calendarEvent-resourceCollection
- response: object
-
- id Internal identifier.: string TENTATIVE , ACCEPTED , ESCALATED , NO_RESPONSE , DECLINED
- refName Reference Name: string
- startDate Start Date: string (date)
-
Enter the date for this event or click the calendar icon to choose a date. This event appears on that date in the calendar in the daily view, weekly view and monthly view. The date will also appear below the message if you choose to send an e-mail to the attendees.
- startTime Start Time: string
-
Select the time this event begins. If the access to this event is Public, the start and end times appear next to the title of this event on the calendar. The time frame for the event will show on daily and weekly views of the calendar but not the monthly view.
- status: object
-
- id Internal identifier.: string TENTATIVE , CONFIRMED , COMPLETE , CANCELLED
- refName Reference Name: string
- supportCase: supportCase
- timedEvent Timed Event: boolean
-
Check this box if this event requires reserved time on your calendar, such as an hour meeting or another time period you want others to see as not available. Clear this box for items you want to include on your calendar but do not have a set time, such as birthdays and anniversaries.
- timezone Time Zone: string
- title Title: string
-
Enter a name for this event. This name is the subject line of the e-mail sent to those invited to the event. This title also appears to others if this event is marked public. The title shows on your calendar and on the calendars of those invited to this event.
- transaction: nsResource
calendarEvent-attendeeCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: calendarEvent-attendeeElement
-
calendarEvent-attendeeElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
calendarEvent-attendeeElement
- attendance: object
-
- id Internal identifier.: string REQUIRED , OPTIONAL
- refName Reference Name: string
- attendee: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- links Links: nsLink
-
nsLink - refName Reference Name: string
- response: object
-
- id Internal identifier.: string ACCEPTED , DECLINED , TENTATIVE , NO_RESPONSE
- refName Reference Name: string
calendarEvent-resourceCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: calendarEvent-resourceElement
-
calendarEvent-resourceElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
calendarEvent-resourceElement
- links Links: nsLink
-
nsLink - refName Reference Name: string
- resource: nsResource
calendarEventCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: calendarEvent
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
calendarEvent - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
campaign
This record is available as a beta record.
- audience: nsResource
- autoName Auto: boolean
-
Clear this box if you want to enter an ID for this campaign.
- basecost Cost: number (double)
-
Enter the cost of this campaign apart from the cost of any specific campaign events. The base cost is added to the cost of individual campaign events to determine the total cost of the campaign.
- campaigndirectmail: campaign-campaigndirectmailCollection
- campaigndrip: campaign-campaigndripCollection
- campaignemail: campaign-campaignemailCollection
- campaignevent: campaign-campaigneventCollection
- campaignid ID: string
-
The campaign ID is determined in one of the following ways: * If you use auto-generated numbers for campaigns, this ID is generated when you save the campaign. * If you do not use auto-generated numbers for campaigns, enter a campaign ID. Campaign IDs make it easier to identify campaigns on reports and lists.
- category: nsResource
- convcostpercustomer Cost per Purchaser: number (double)
-
The cost per customer conversion for this campaign is calculated here. This is calculated by dividing the cost of the campaign by the number of transactions entered with this campaign's promotion code.
- conversions Number of Purchasers: integer (int64)
-
This is the number of leads or prospects that have become customers as a result of this campaign.
- cost Total Cost: number (double)
-
This cost is calculated by adding the base cost of the campaign to the cost of each individual campaign event. You cannot edit the amount in this field. This amount is deducted from the revenue generated by this campaign to determine the return on investment.
- costpercustomer Cost Per Lead: number (double)
-
The cost per new customer for this campaign is calculated here. Cost per customer is calculated by dividing the total cost of the campaign by the number of new customers your business gained as a result of this campaign. The number of new customers is calculated by counting the transactions entered with this campaign's promotion code.
- customForm: object
-
- id Internal identifier.: string -10130
- refName Reference Name: string
- defaultevent: campaign-defaulteventCollection
- enddate End Date: string (date)
-
Enter or select the date this campaign ends.
- eventNumber: integer (int64)
- expectedrevenue Projected Income: number (double)
-
Enter the amount of revenue that is predicted that this marketing campaign will generate.
- externalId External ID: string
- family: nsResource
- id Internal ID: string
- isdefaultleadsource Default Lead Source: boolean
- isinactive Inactive: boolean
-
Check this box to inactivate this campaign.
- item: one of: [ inventoryItemCollection, assemblyItemCollection, kitItemCollection, nsResourceCollection, discountItemCollection, markupItemCollection, subtotalItemCollection, descriptionItemCollection, paymentItemCollection, salesTaxItemCollection, taxGroupCollection, shipItemCollection, downloadItemCollection, giftCertificateItemCollection, subscriptionPlanCollection, nonInventorySaleItemCollection, nonInventoryResaleItemCollection, nonInventoryPurchaseItemCollection, serviceSaleItemCollection, serviceResaleItemCollection, servicePurchaseItemCollection, otherChargeSaleItemCollection, otherChargeResaleItemCollection, otherChargePurchaseItemCollection ]
- keyword Keyword: string
-
Enter the paid keyword you are tracking with this campaign.
- leadsgenerated Leads Generated: integer (int64)
-
This is the number of new leads generated by this campaign.
- links Links: nsLink
-
nsLink - local Execute On Local Server: boolean
- message Description: string
-
Enter a description for this campaign. This description only appears on the campaign record.
- offer: nsResource
- origcampaignid: string
- owner: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- profit Profit: number (double)
-
This is the profit earned by this campaign. Profit is calculated by deducting the cost of the campaign from the total revenue.
- promotionCode: promotionCode
- refName Reference Name: string
- roi Return on Investment: number (double)
-
The return on investment of this campaign is calculated here. Return on investment is calculated by deducting the cost of the campaign from the total revenue generated and dividing the difference by the campaign's cost.
- searchengine: nsResource
- startdate Start Date: string (date)
-
Enter or select the date this campaign begins.
- title Title: string
-
Enter a title for this campaign. You can enter up to 99 characters in this field.
- totalrevenue Revenue: number (double)
-
This field shows the total sales of transactions associated with this campaign.
- uniquevisitors Unique Visitors: integer (int64)
-
This is the number of unique visitors that have visited your website as a result of this campaign.
- url URL: string
-
Enter the URL for the campaign landing page or online customer form associated with this campaign. If you enter a campaign ID or if you autonumber your campaigns, NetSuite automatically appends the URL to include the leadsource parameter. This is the destination URL you provide to search engine services for paid keywords.
- vertical: nsResource
campaign-campaigndirectmail-eventresponseCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: campaign-campaigndirectmail-eventresponseElement
-
campaign-campaigndirectmail-eventresponseElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
campaign-campaigndirectmail-eventresponseElement
This record is available as a beta record.
- bounced # Bounced: integer (int64)
- bouncedratio % Bounced: number (double)
- clickedthru # Clicked Thru: integer (int64)
- clickedthruratio % Clicked Thru: number (double)
- links Links: nsLink
-
nsLink - opened # Opened: integer (int64)
- openedratio % Opened: number (double)
- refName Reference Name: string
- responded # Responded: integer (int64)
- respondedratio % Responded: number (double)
- sent # Sent: integer (int64)
- unsubscribed # Unsubscribed: integer (int64)
- unsubscribedratio % Unsubscribed: number (double)
campaign-campaigndirectmailCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: campaign-campaigndirectmailElement
-
campaign-campaigndirectmailElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
campaign-campaigndirectmailElement
This record is available as a beta record.
- campaigngroup: nsResource
- channel: nsResource
- cost Cost: number (double)
- datescheduled Date: string (date)
- datesent Date Executed: string (date)
- description Title: string
- dscheduled Date: string (date-time)
- eventresponse: campaign-campaigndirectmail-eventresponseCollection
- id ID: integer (int64)
- links Links: nsLink
-
nsLink - promocode: promotionCode
- promocodeusetype: promotionCode
- refName Reference Name: string
- seqNum Sequence Num: integer (int64)
- status: object
-
- id Internal identifier.: string NOTSTART , PROGRESS , COMPLETE , EXECUTE
- refName Reference Name: string
- subscription: nsResource
- template: nsResource
- type: object
-
- id Internal identifier.: string OTHER , INTEGRATION , DRIP , EMAIL , DIRECTMAIL , DEFAULT
- refName Reference Name: string
campaign-campaigndrip-eventresponseCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: campaign-campaigndrip-eventresponseElement
-
campaign-campaigndrip-eventresponseElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
campaign-campaigndrip-eventresponseElement
This record is available as a beta record.
- bounced # Bounced: integer (int64)
- bouncedratio % Bounced: number (double)
- clickedthru # Clicked Thru: integer (int64)
- clickedthruratio % Clicked Thru: number (double)
- links Links: nsLink
-
nsLink - opened # Opened: integer (int64)
- openedratio % Opened: number (double)
- refName Reference Name: string
- responded # Responded: integer (int64)
- respondedratio % Responded: number (double)
- sent # Sent: integer (int64)
- unsubscribed # Unsubscribed: integer (int64)
- unsubscribedratio % Unsubscribed: number (double)
campaign-campaigndripCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: campaign-campaigndripElement
-
campaign-campaigndripElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
campaign-campaigndripElement
This record is available as a beta record.
- campaigngroup: nsResource
- channel: nsResource
- cost Cost: number (double)
- datesent Date Executed: string (date)
- description Title: string
- dscheduled Date: string (date-time)
- eventresponse: campaign-campaigndrip-eventresponseCollection
- id ID: integer (int64)
- links Links: nsLink
-
nsLink - lockEvent: boolean
- promocode: promotionCode
- promocodeusetype: promotionCode
- refName Reference Name: string
- seqNum Sequence Num: integer (int64)
- status: object
-
- id Internal identifier.: string NOTSTART , PROGRESS , COMPLETE , EXECUTE , FAILED , SENT , PLANNING
- refName Reference Name: string
- subscription: nsResource
- template: campaignTemplate
- templateCategory: nsResource
- templateVersion: string
- type: object
-
- id Internal identifier.: string OTHER , INTEGRATION , DRIP , EMAIL , DIRECTMAIL , DEFAULT
- refName Reference Name: string
- usesnlcouponcode: string
campaign-campaignemail-eventresponseCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: campaign-campaignemail-eventresponseElement
-
campaign-campaignemail-eventresponseElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
campaign-campaignemail-eventresponseElement
This record is available as a beta record.
- bounced # Bounced: integer (int64)
- bouncedratio % Bounced: number (double)
- clickedthru # Clicked Thru: integer (int64)
- clickedthruratio % Clicked Thru: number (double)
- links Links: nsLink
-
nsLink - opened # Opened: integer (int64)
- openedratio % Opened: number (double)
- refName Reference Name: string
- responded # Responded: integer (int64)
- respondedratio % Responded: number (double)
- sent # Sent: integer (int64)
- unsubscribed # Unsubscribed: integer (int64)
- unsubscribedratio % Unsubscribed: number (double)
campaign-campaignemailCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: campaign-campaignemailElement
-
campaign-campaignemailElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
campaign-campaignemailElement
This record is available as a beta record.
- campaigngroup: nsResource
- channel: nsResource
- cost Cost: number (double)
- datescheduled Date: string (date)
- datesent Date Executed: string (date)
- description Title: string
- dscheduled Date: string (date-time)
- eventresponse: campaign-campaignemail-eventresponseCollection
- id ID: integer (int64)
- links Links: nsLink
-
nsLink - lockEvent: boolean
- promocode: promotionCode
- promocodeusetype: promotionCode
- refName Reference Name: string
- seqNum Sequence Num: integer (int64)
- status: object
-
- id Internal identifier.: string NOTSTART , PROGRESS , EXECUTE , FAILED , SENT
- refName Reference Name: string
- subscription: nsResource
- template: campaignTemplate
- templateCategory: nsResource
- templateVersion: string
- testcell Test Cell: string
- timeScheduled Time: string
- type: object
-
- id Internal identifier.: string OTHER , INTEGRATION , DRIP , EMAIL , DIRECTMAIL , DEFAULT
- refName Reference Name: string
- usesnlcouponcode: string
campaign-campaignevent-eventresponseCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: campaign-campaignevent-eventresponseElement
-
campaign-campaignevent-eventresponseElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
campaign-campaignevent-eventresponseElement
This record is available as a beta record.
- bounced # Bounced: integer (int64)
- bouncedratio % Bounced: number (double)
- clickedthru # Clicked Thru: integer (int64)
- clickedthruratio % Clicked Thru: number (double)
- links Links: nsLink
-
nsLink - opened # Opened: integer (int64)
- openedratio % Opened: number (double)
- refName Reference Name: string
- responded # Responded: integer (int64)
- respondedratio % Responded: number (double)
- sent # Sent: integer (int64)
- unsubscribed # Unsubscribed: integer (int64)
- unsubscribedratio % Unsubscribed: number (double)
campaign-campaigneventCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: campaign-campaigneventElement
-
campaign-campaigneventElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
campaign-campaigneventElement
This record is available as a beta record.
- campaigngroup: nsResource
- channel: nsResource
- cost Cost: number (double)
- datescheduled Date: string (date)
- datesent Date Executed: string (date)
- description Title: string
- dscheduled Date: string (date-time)
- eventresponse: campaign-campaignevent-eventresponseCollection
- id ID: integer (int64)
- links Links: nsLink
-
nsLink - promocode: promotionCode
- promocodeusetype: promotionCode
- refName Reference Name: string
- seqNum Sequence Num: integer (int64)
- status: object
-
- id Internal identifier.: string NOTSTART , PROGRESS , COMPLETE , EXECUTE
- refName Reference Name: string
- subscription: nsResource
- template: nsResource
- type: object
-
- id Internal identifier.: string OTHER , INTEGRATION , DRIP , EMAIL , DIRECTMAIL , DEFAULT
- refName Reference Name: string
campaign-defaulteventCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: campaign-defaulteventElement
-
campaign-defaulteventElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
campaignCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: campaign
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
campaign - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
campaignResponse
This record is available as a beta record.
- responses: campaignResponse-responsesCollection
- campaignevent: nsResource
- campaignresponsedate Date Created: string (date-time)
-
This is the date the campaign was sent.
- campaignresponsetime Time created: string
- channel: nsResource
- entity: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- eventResponse Event Response: string
- externalId External ID: string
- id Internal ID: string
- leadsource: nsResource
- links Links: nsLink
-
nsLink - newresponsedate New Response Date: string (date)
-
Enter the date for this campaign response.
- newresponsetime New Response Time: string
-
Enter the time of this campaign response.
- note Note: string
-
Enter a note about this campaign response.
- refName Reference Name: string
- response: object
-
- id Internal identifier.: string BOUNCED , BOUNCED_INVALID_SENDER , BOUNCED_MAILBOX_FULL , FAILED_UNEXPECTED_ERROR , UNSUBSCRIBED_BY_FBL , BOUNCED_PREVIOUS_HARD_BOUNCE , BOUNCED_NETWORK_ISSUES , FAILED_TEMPLATE_ERROR , CLICKEDTHRU , SUBSCRIBED_BY_EMAIL , UNSUBSCRIBED_BY_EMAIL , BOUNCED_LIMITS_EXCEEDED , BOUNCED_MISC , RECEIVED , PURCHASED_TRANSACTION , ACCEPTED , TENTATIVE , UNSUBSCRIBED , RESPONDED , BOUNCED_NOT_ACCEPTING_MSGS , NORESPONSE , BOUNCED_MAIL_PROTOCOL_ISSUES , BOUNCED_MEDIA_ERROR , VIEWED , BOUNCED_INVALID_ADDRESS , CLICKEDTHRU_TO_URL , SENT_SUCCESSFULLY , BOUNCED_SPAM , PURCHASED , DECLINED , BOUNCED_FROM_EMAIL_HANDLER , DUMMY , SUBSCRIBED , BOUNCED_TOO_MANY_RECIPIENTS , QUEUED , RESPONDED_ONLINE , BOUNCED_SECURITY_ISSUES , RESPONDED_VIA_EMAIL , BOUNCED_MAILBOX_DISABLED , SENT , ESCALATED
- refName Reference Name: string
campaignResponse-responsesCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: campaignResponse-responsesElement
-
campaignResponse-responsesElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
campaignResponse-responsesElement
This record is available as a beta record.
- author: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- links Links: nsLink
-
nsLink - note Notes: string
- refName Reference Name: string
- response: object
-
- id Internal identifier.: string BOUNCED , BOUNCED_INVALID_SENDER , BOUNCED_MAILBOX_FULL , FAILED_UNEXPECTED_ERROR , UNSUBSCRIBED_BY_FBL , BOUNCED_PREVIOUS_HARD_BOUNCE , BOUNCED_NETWORK_ISSUES , FAILED_TEMPLATE_ERROR , CLICKEDTHRU , SUBSCRIBED_BY_EMAIL , UNSUBSCRIBED_BY_EMAIL , BOUNCED_LIMITS_EXCEEDED , BOUNCED_MISC , RECEIVED , PURCHASED_TRANSACTION , ACCEPTED , TENTATIVE , UNSUBSCRIBED , RESPONDED , BOUNCED_NOT_ACCEPTING_MSGS , NORESPONSE , BOUNCED_MAIL_PROTOCOL_ISSUES , BOUNCED_MEDIA_ERROR , VIEWED , BOUNCED_INVALID_ADDRESS , CLICKEDTHRU_TO_URL , SENT_SUCCESSFULLY , BOUNCED_SPAM , PURCHASED , DECLINED , BOUNCED_FROM_EMAIL_HANDLER , DUMMY , SUBSCRIBED , BOUNCED_TOO_MANY_RECIPIENTS , QUEUED , RESPONDED_ONLINE , BOUNCED_SECURITY_ISSUES , RESPONDED_VIA_EMAIL , BOUNCED_MAILBOX_DISABLED , SENT , ESCALATED
- refName Reference Name: string
- responsedate Date/Time: string (date-time)
campaignResponseCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: campaignResponse
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
campaignResponse - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
campaignTemplate
This record is available as a beta record.
- content Content: string
- description Description: string
-
Enter a description of this template.
- emailAsSalesRep Email as Sales Rep: boolean
-
Check the Email as Sales Rep box if you want replies to email generated by this template sent to the sales rep assigned to customer recipients. If you check this box, each campaign email message shows the Nickname and From Email Address entered by the rep at Home > Set Preferences > General subtab, under the User Profile section. If the rep does not have a profile set up, the marketing email address and From name entered on the template record are used. Note - This preference overrides the reply-to email address you set on this template.
- fromEmail: nsResource
- fromName From Name: string
-
Enter the name you want to appear in the From field on e-mail you send using this template.
- id Internal ID: string
- isAutoConverted Automatically Converted Template: boolean
- isInactive Inactive: boolean
-
Check this box to inactivate this template. Inactive templates cannot be used in marketing campaigns.
- isPrivate Private: boolean
-
Check this box if you want to be the only person in your company who can use this template.
- links Links: nsLink
-
nsLink - mediaItem: nsResource
- name Name: string
-
Enter a name for this template.
- previewEmail: string
- recordType Record Type: string
- refName Reference Name: string
- replyToEmail: nsResource
- restrictToGroup: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- sendEmailPreview Send Email Preview: boolean
-
Check this box if you want to send a preview of this template when you save this record. Enter the email address you want to receive this preview.
- subject Subject: string
-
Enter the subject of this template. You can include CRMSDK tags in this subject. If this is an online HTML form template, the title appears in the title of the browser window when someone navigates to the online form. If this is a marketing e-mail template, the subject appears in the Subject field of the e-mail.
- subscription: nsResource
- templateType Template Type: string
- templateVersion Version: string
- trackStatistics Track Outgoing Email: boolean
-
If you want to track statistics related to how often this email message is opened or clicked through, check the Track Outgoing Email box. If you choose to track marketing email statistics, whenever a recipient of your marketing email opens or clicks through a message, a request is sent to NetSuite's server. Some of your marketing email recipients may have concerns about this process that you may want to address in your company's privacy policy. Only links to pages in NetSuite are tracked as having been clicked for campaign response reporting. For example, a link to a page in your NetSuite Web site or an online customer form would be tracked, but a link to a third-party site would not be tracked. These tracking statistics are included in such reports as the Campaign Statistics Summary and Detail.
- typeName: object
-
- id Internal identifier.: string GNCTEMPLATE , PDF , HCM , MAIL , KUDOS , SYSTEMEMAIL , EMAIL , ONLINEFORM , FAX , CAMPAIGN
- refName Reference Name: string
- usesMedia: object
-
- id Internal identifier.: string T , F
- refName Reference Name: string
campaignTemplateCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: campaignTemplate
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
campaignTemplate - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
cardholderAuthentication
This record is available as a beta record.
- acceptHeader Accept Header: string
- amount Amount: number (double)
- authenticateDeviceFormAction Authenticate Device Form Action: string
- authenticateDeviceFormId Form ID: string
- authenticateDeviceInputs: cardholderAuthentication-authenticateDeviceInputsCollection
- authenticateDeviceResults: cardholderAuthentication-authenticateDeviceResultsCollection
- authenticationFields: cardholderAuthentication-authenticationFieldsCollection
- billingAddress: cardholderAuthentication-billingAddress
- cardholderAuthenticationEvents: cardholderAuthentication-cardholderAuthenticationEventsCollection
- cavv Cardholder Authetication Verification Value (CAVV): string
- challengeShopperFormAction Challenge Shopper Form Action: string
- challengeShopperFormId Form ID: string
- challengeShopperInputs: cardholderAuthentication-challengeShopperInputsCollection
- challengeShopperResults: cardholderAuthentication-challengeShopperResultsCollection
- challengeWindowSize: object
-
- id Internal identifier.: string 01 , 02 , 03 , 04 , 05
- refName Reference Name: string
- currency: currency
- eci: object
-
- id Internal identifier.: string 00 , 01 , 02 , 05 , 06 , 07
- refName Reference Name: string
- entity: customer
- externalId External ID: string
- handlingMode: object
-
- id Internal identifier.: string PROCESS , SAVE_ONLY
- refName Reference Name: string
- id Internal ID: string
- ipAddress IP Address: string
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - notificationUrl Notification URL: string
- paymentCardCsc CSC: string
- paymentMethod: string
- paymentOption: nsResource
- paymentProcessingProfile: nsResource
- refName Reference Name: string
- shippingAddress: cardholderAuthentication-shippingAddress
- status: object
-
- id Internal identifier.: string CANCELLED , RETURN_FROM_SHOPPER_CHALLENGE , AUTHENTICATED , NOT_REQUIRED , WAITING_FOR_DEVICE_AUTHENTICATION , WAITING_FOR_INITIAL_PROCESS , RETURN_FROM_DEVICE_AUTHENTICATION , WAITING_FOR_SHOPPER_CHALLENGE
- refName Reference Name: string
- subsidiary: subsidiary
- threeDSTranStatusReason: object
-
- threeDSTransactionId 3D Secure Transaction Id: string
- threeDSVersion: object
-
- id Internal identifier.: string 2.1.0 , 2.2.0 , 1.0.2
- refName Reference Name: string
- userAgent User Agent: string
cardholderAuthentication-authenticateDeviceInputsCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: cardholderAuthentication-authenticateDeviceInputsElement
-
cardholderAuthentication-authenticateDeviceInputsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
cardholderAuthentication-authenticateDeviceResultsCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: cardholderAuthentication-authenticateDeviceResultsElement
-
cardholderAuthentication-authenticateDeviceResultsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
cardholderAuthentication-authenticationFieldsCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: cardholderAuthentication-authenticationFieldsElement
-
cardholderAuthentication-authenticationFieldsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
cardholderAuthentication-billingAddress
This record is available as a beta record.
- addr1 Address 1: string
- addr2 Address 2: string
- addr3 Address 3: string
- addrPhone Phone: string
- addrText Address: string
- addressee Addressee: string
- attention Attention: string
- city City: string
- country: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- id Internal ID: integer (int64)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- state State: string
- zip Zip: string
cardholderAuthentication-cardholderAuthenticationEventsCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: cardholderAuthentication-cardholderAuthenticationEventsElement
-
cardholderAuthentication-cardholderAuthenticationEventsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
cardholderAuthentication-cardholderAuthenticationEventsElement
This record is available as a beta record.
- eventDatetime Date/Time: string (date-time)
- externalId External ID: string
- id Internal ID: integer (int64)
- links Links: nsLink
-
nsLink - paymentProcessingProfile: nsResource
- refName Reference Name: string
- referenceCode Reference Code: string
- request Raw Request: string
- response Raw Response : string
- status: object
-
- id Internal identifier.: string OVERRIDE , ACCEPT , REJECT , PENDING , HOLD
- refName Reference Name: string
- statusDetails Status Details: string
- statusReason: object
-
- id Internal identifier.: string AMOUNT_EXCEEDED , CARD_EXPIRED , REJECT , NOT_REQUIRED , CARD_INVALID , FORWARD_CHAL_SHOPPER , FORWARD_REQUESTED , GENERAL_HOLD , CONFIRMATION_PENDING , FORWARD_AUTH_DEVICE , GENERAL_REJECT , FRAUDREJECT , CANCELED , INSUFFICIENT_FUNDS , ASYNC_NOTIFICATION , FRAUDREVIEW , VERBALAUTH , FRAUDREJECTEXTERNAL , DEVICE_PRIMED , GATEWAYERROR , PAYMENT_TERMINATED , PARTNER_DECLINE , FORWARD_PAYER_AUTH , OVERRIDE , FRAUDREVIEWEXTERNAL , ACCEPT , DEVICE_NOT_PRIMED , FATAL_ERROR , AUTHORIZATION , SYSTEMERROR
- refName Reference Name: string
- testMode Test Mode: boolean
- threeDSTranStatus: object
-
- id Internal identifier.: string A , R , C , D , U , I , Y , N
- refName Reference Name: string
- threeDSTranStatusReason: object
-
- validationError Plugin Validation Error: string
cardholderAuthentication-challengeShopperInputsCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: cardholderAuthentication-challengeShopperInputsElement
-
cardholderAuthentication-challengeShopperInputsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
cardholderAuthentication-challengeShopperResultsCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: cardholderAuthentication-challengeShopperResultsElement
-
cardholderAuthentication-challengeShopperResultsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
cardholderAuthentication-shippingAddress
This record is available as a beta record.
- addr1 Address 1: string
- addr2 Address 2: string
- addr3 Address 3: string
- addrPhone Phone: string
- addrText Address: string
- addressee Addressee: string
- attention Attention: string
- city City: string
- country: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- id Internal ID: integer (int64)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- state State: string
- zip Zip: string
cardholderAuthenticationCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: cardholderAuthentication
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
cardholderAuthentication - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
cashRefund
This record is available as a beta record.
- account: account
- accountingBookDetail: cashRefund-accountingBookDetailCollection
- altHandlingCost Handling Cost: number (double)
-
This is the amount the customer was charged for handling.
- altShippingCost Shipping Cost: number (double)
-
This is the amount the customer was charged for shipping.
- appliedRules: cashRefund-appliedRulesCollection
- asOfDate As of Date: string (date)
-
Type an as of date for this cash refund.
- billAddr1 Billing Address Line 1: string
- billAddr2 Billing Address Line 2: string
- billAddr3 Billing Address Line 3: string
- billAddress Bill To: string
-
The default billing address autofills this field from the customer's record at Lists > Relationships > Customers. To enter a different address: * Select another address in the Bill To Select field. * Select New in the Bill To Select field to enter a new billing address.
- billAddressList: nsResource
- billAddressee Billing Addressee: string
- billAttention Billing Attention: string
- billCity Billing Address City: string
- billCountry: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- billOverride Override: string
- billPhone Billing Phone: string
- billState Billing Address State: string
- billZip Billing Address Zip Code: string
- billingAccount: billingAccount
- billingAddress: cashRefund-billingAddress
- billingAddress_text Billing Address: string
- bulkProcSubmission: nsResource
- cardSwipe Card Swipe: string
- cardholderAuthentication: cardholderAuthentication
- checkNumber Check #: string
- checklink: check
- class: classification
- cleared Cleared: boolean
- clearedDate Date Cleared: string (date)
- contribPct Contribution Percentage: string
- createdDate Date Created: string (date-time)
- createdFrom: nsResource
- currency: currency
- customForm: object
-
- id Internal identifier.: string -9904
- refName Reference Name: string
- customerPaymentAuthorization: customerPaymentAuthorization
- debitKsn Debit KSN: string
- debitPinBlock Debit Pin Block: string
- deferredRevenue Deferred Revenue: number (double)
-
Deferred Revenue: amount of revenue deferred on this transaction
- department: department
- discountAmount Discount Amount: number (double)
- discountDate Discount Date: string (date)
- dueDate Due Date: string (date)
- dynamicDescriptor Soft Descriptor: string
- email Email: string
- endDate End Date: string (date)
- entity: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- entityTaxRegNum Customer Tax Reg. Number: string
-
Select the customer's tax registration number associated with this cash refund.
- estGrossProfit Est. Gross Profit: number (double)
-
Estimated Gross Profit is a read-only field that equals the revenue amount minus the Est. Cost. At the transaction level, it equals the gross profit of all lines, factoring transaction-level discounts and markups.
- estGrossProfitPercent Est. Gross Profit Percent: number (double)
-
Estimated Gross Profit Margin, as a percentage: Read-only field that equals the Est. Gross Profit divided by revenue, expressed as a percentage. At the transaction level, it equals the gross profit percent of all lines, factoring transaction-level discounts and markups.
- exchangeRate Exchange Rate: number (double)
-
The currency's exchange rate is shown in this field. You can edit the exchange rate for this transaction only, or you can update the currency record with the exchange rate you enter here.
- excludeCommission Exclude Commissions: boolean
-
Check this option to exclude this transaction and its subordinate transactions from inclusion in all commission calculations.
- excludeFromGLNumbering Exclude from GL Audit Numbering: boolean
- externalId External ID: string
- handlingCost Handling Cost: number (double)
-
Enter the amount the customer was charged for handling.
- handlingMode: object
-
- id Internal identifier.: string MIMIC , PROCESS , SAVE_ONLY
- refName Reference Name: string
- handlingTaxAmount Handling Tax Amount: number (double)
- id Internal ID: string
- inputReferenceCode Input P/N Ref.: string
- integrationId: string
- item: cashRefund-itemCollection
- job: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- lastModifiedDate Date Last Modified: string (date-time)
- leadSource: nsResource
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
-
If you wish, enter a memo to describe this cash refund. It will appear on reports such as the 2-line Undeposited Funds register.
- message Customer Message: string
-
Edit the message you selected in the Select Message field, or enter a new message here. If you choose to print, email or fax this transaction to the customer, this message shows on the transaction.
- messageSel: customerMessage
- nexus: nexus
- originator Originator: string
- otherRefNum PO/Check Number: string
-
If required, enter the customer's original check number.
- outputAuthCode Auth. Code: string
- outputReferenceCode P/N Ref.: string
- partner: partner
- partners: cashRefund-partnersCollection
- paymentCardCsc CSC: string
- paymentDeviceId Payment Device ID: string
- paymentInstrumentLimit Payment Instrument Limit: number (double)
- paymentOperation: object
-
- id Internal identifier.: string CREDIT , REFUND
- refName Reference Name: string
- paymentOption: nsResource
- paymentProcessingProfile: nsResource
- postingPeriod: accountingPeriod
- prevDate Previous Effective Date: string (date)
- prevPartner Previous Partner: integer (int64)
- prevRep Previous Representative: integer (int64)
- recognizedRevenue Recognized Revenue: number (double)
-
Recognized Revenue: cumulative amount of revenue recognized for this transaction
- recurringBill Recurring Bill: boolean
- refName Reference Name: string
- refundCheck Create Check: boolean
-
Place a check mark in the box after Create Check if you wish to refund money by check. Clear this box if you want to issue a cash or credit card refund.
- revCommitStatus Revenue Commitment Status: string
- revCommitStatusDescr Revenue Commitment Status: string
- revRecOnRevCommitment Rev Rec on Rev Commit.: boolean
- revenueStatus Revenue Status: string
-
The possible values for this field are: 1. Pending: indicates that no recognition has occurred. All revenue is still deferred. 2. In Progress: indicates that some recognition has occurred. 3. Completed: indicates that all recognition has occurred. No deferred revenue remains.
- revenueStatusDescr Revenue Status: string
- salesEffectiveDate Sales Effective Date: string (date)
-
You can change the sales effective date for this transaction. The sales effective date determines which commission plan and historical sales team this transaction applies to. If this return is created from a sales transaction, the sales effective date from the sale shown in the Created From field is set by default for this refund.
- salesRep: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- salesReturn Sales Return: string
- salesTeam: cashRefund-salesTeamCollection
- shipAddress Ship To: string
- shipAddressList: nsResource
- shipDate Ship Date: string (date)
- shipIsResidential Shipping address is residential: boolean
- shipMethod: shipItem
- shipOverride Override: boolean
- shippingAddress: cashRefund-shippingAddress
- shippingAddress_text Shipping Address: string
- shippingCost Shipping Cost: number (double)
-
Enter the amount the customer was charged for shipping.
- shippingCostOverridden Shipping Cost Overridden: boolean
- shippingTaxAmount Shipping Tax Amount: number (double)
-
This field displays the shipping tax amount for this cash refund.
- source: object
-
- startDate Start Date: string (date)
- storeOrder: string
- subsidiary: subsidiary
- subsidiaryTaxRegNum Subsidiary Tax Reg. Number: string
-
This field shows the tax registration number of the transaction nexus. NetSuite automatically populates this field based on the nexus lookup logic. You can override the transaction nexus and tax registration number that NetSuite automatically selects by checking the Nexus Override box. When you select a different tax registration number in the dropdown list, the corresponding nexus is automatically selected in the Nexus field.
- subtotal Subtotal: number (double)
-
This field shows the subtotal of the items on this cash refund. This is the total before discounts, shipping costs, handling costs or taxes are added to the refund.
- taxDetails: cashRefund-taxDetailsCollection
- taxDetailsOverride Tax Details Override: boolean
-
Check this box to override the tax information on the Tax Details subtab of the transaction. Only roles with at least the Edit level of the Tax Details Tab permission can override the tax details.
- taxPointDate Tax Point Date: string (date)
- taxPointDateOverride Tax Point Date Override: boolean
-
Check this box to override the tax point date.
- taxRegOverride Tax Registration Override: boolean
- taxTotal Tax: number (double)
-
NetSuite multiplies the tax rate by the taxable total of line items and enters it here.
- terms: term
- thirdPartyAcct 3rd Party Account: string
- toBeEmailed To Be Emailed: boolean
-
Check this box if you want to e-mail this cash refund form. Then, enter the e-mail address in the space to the right of the check box. You can enter multiple e-mail addresses by separating them with semicolons. It is important to separate the addresses with only semicolons, and do not include any spaces.
- toBeFaxed To Be Faxed: boolean
-
Check this box if you want to fax this cash sale refund. Enter the fax number in the space to the right of the check box if it doesn't already appear. To fax NetSuite forms, an administrator must first set up fax service at Setup > Company > Printing, Fax and E-mail Preferences.
- toBePrinted To Be Printed: boolean
-
Check this box if you wish to save this in a queue of cash refund forms to print. Otherwise, you can click Print below to submit and print this form at once.
- toprint2 Print {1}: boolean
-
Place a check mark in the box after Print Check if you are creating a check and if you wish to print that check.
- total Total: number (double)
-
NetSuite computes the total of line items and tax, and then enters it here.
- totalAfterTaxes Total After Taxes: number (double)
- totalCostEstimate Est. Cost: number (double)
-
The estimated cost of the specific number of items. This is calculated as: estimated rate x quantity = estimated cost
- tranDate Date: string (date)
-
NetSuite inserts today's date for the posting date of this cash refund. You can type or pick another date. What you enter here determines the date range in which this transaction appears in the A/R and A/P registers. You can select or enter custom date ranges on registers.
- tranId Refund #: string
-
NetSuite increases the largest refund number by one. If you wish, you can type another number. The next refund number will revert to the standard pattern. You can enter a maximum of 45 characters in this field.
- tranIsVsoeBundle Transaction Is VSOE Bundle: boolean
- transactionToRefund: nsResource
- vsoeAutoCalc Auto Calculate VSOE Allocation: boolean
-
The VSOE allocation amount can be calculated automatically by checking the Auto Calculate VSOE Allocation box. Allocation is the process to determine the VSOE price for items. The total VSOE amount allocated is the revenue amount to be recognized for the bundle.
- webSite: string
- whichChargesToAdd: object
-
- id Internal identifier.: string , ALL , TRANSACTION_DATE , AS_OF_DATE
- refName Reference Name: string
cashRefund-accountingBookDetailCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: cashRefund-accountingBookDetailElement
-
cashRefund-accountingBookDetailElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
cashRefund-accountingBookDetailElement
This record is available as a beta record.
- accountingBook: accountingBook
- exchangeRate Exchange Rate: number (double)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- revRecOnRevCommitment Rev Rec on Rev Commit.: boolean
- subsidiary: subsidiary
- tranIsVsoeBundle Transaction Is VSOE Bundle: boolean
cashRefund-appliedRulesCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: cashRefund-appliedRulesElement
-
cashRefund-appliedRulesElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
cashRefund-billingAddress
This record is available as a beta record.
- addr1 Address 1: string
-
Enter the address the way it should appear on forms. For employees, customers, partners, and vendors, what you enter here autofills on forms if this address is marked default for Shipping or Billing. Enter up to 50 characters. This field is required for the Online Bill Pay feature.
- addr2 Address 2: string
-
Enter an optional second address line the way it should appear on forms. For employees, customers, partners, and vendors, what you enter here autofills on forms if this address is marked default for Shipping or Billing. Enter up to 50 characters.
- addr3 Address 3: string
- addrPhone Phone: string
-
Enter the phone number.
- addrText Address: string
-
The values entered in the other address fields are displayed here.
- addressee Addressee: string
-
Enter the name of the entity that should appear on the shipping label here. This name appears on the shipping label below what you enter in the Attention field.
- attention Attention: string
-
Enter the name of the person to whom a shipment is addressed, as it should appear on shipping labels. This field is required for UPS Integration.
- city City: string
-
Enter the city the way it should appear on all forms except checks.
- country: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- externalId External ID: string
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - override Override: boolean
-
Check this box to disable the free-form address text field. When this field is disabled, text entered in the other address fields does not display in the Address text field. Clear this box to allow text entered in the address component fields to appear in the free-form address text field.
- refName Reference Name: string
- state State/Province: string
-
Enter your company's state or province the way it should appear on all forms except checks.
- zip Zip: string
-
Enter the postal code the way it should appear on all forms except checks.
cashRefund-item-inventoryDetail
This record is available as a beta record.
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- externalId External ID: string
- inventoryassignment: cashRefund-item-inventoryDetail-inventoryassignmentCollection
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemDescription Description: string
-
A more complete Description of the item.
- links Links: nsLink
-
nsLink - location: location
- quantity Quantity: number (float)
-
In the Quantity to Build field, enter the number of assembly items you want to build. You cannot enter a quantity that exceeds the amount displayed in the Buildable Quantity field.
- refName Reference Name: string
- toLocation: location
- unit Units: string
-
If the assembly uses Units of Measure, the base units are displayed in the Units field.
cashRefund-item-inventoryDetail-inventoryassignmentCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: cashRefund-item-inventoryDetail-inventoryassignmentElement
-
cashRefund-item-inventoryDetail-inventoryassignmentElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
cashRefund-item-inventoryDetail-inventoryassignmentElement
This record is available as a beta record.
- binNumber: bin
- expirationDate Expiration Date: string (date)
- internalId Internal ID: integer (int64)
- inventoryDetail Inventory Detail: integer (int64)
- inventoryStatus: inventoryStatus
- issueInventoryNumber: inventoryNumber
- links Links: nsLink
-
nsLink - packCarton Pack Carton: string
- pickCarton Pick Carton: string
- quantity Quantity: number (float)
- quantityAvailable Unpicked Bin Qty: number (float)
- receiptInventoryNumber Serial/Lot Number: string
- refName Reference Name: string
- secondaryQuantity Secondary Quantity: number (float)
- toBinNumber: bin
- toInventoryStatus: inventoryStatus
cashRefund-itemCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: cashRefund-itemElement
-
cashRefund-itemElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
cashRefund-itemElement
This record is available as a beta record.
- amount Amount: number (double)
- billVarianceStatus: object
-
- id Internal identifier.: string NOVARIANCES , JOURNALNOTPOSTED , JOURNALPOSTED
- refName Reference Name: string
- catchUpPeriod: accountingPeriod
- chargeType: nsResource
- class: classification
- costEstimate Est. Cost: number (double)
- costEstimateRate Est. Rate: number (double)
- costEstimateType: object
-
- id Internal identifier.: string PREFVENDORRATE , AVGCOST , PURCHORDERRATE , LASTPURCHPRICE , MEMBERDEFINED , CUSTOM , ITEMDEFINED , PURCHPRICE
- refName Reference Name: string
- deferRevRec Deferred Revenue: boolean
- department: department
- description Description: string
- doNotCreateRevenueElement Do Not Create Revenue Element: boolean
- estGrossProfit Est. Gross Profit: number (double)
- estGrossProfitPercent Est. Gross Profit Percent: number (double)
- giftCertFrom From: string
- giftCertMessage Gift Message: string
- giftCertNumber Code: string
- giftCertRecipientEmail Recipient Email: string
- giftCertRecipientName Recipient Name: string
- initOqpBucket Initial OQP Bucket: string
- inventoryDetail: cashRefund-item-inventoryDetail
- isClosed Closed: boolean
- isOpen Is Opened: boolean
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemSubtype: object
-
- id Internal identifier.: string Sale , Purchase , Resale
- refName Reference Name: string
- itemType: object
-
- job: job
- licenseCode License Code: string
- line Transaction Line: integer (int64)
- linked Linked: boolean
- links Links: nsLink
-
nsLink - location: location
- marginal Marginal: boolean
- matrixType Matrix Type: string
- minQty Minimum Quantity: number (float)
- options Options: string
- oqpBucket Oqp Bucket: string
- orderDoc: nsResource
- orderLine Order Line: integer (int64)
- price: priceLevel
- printItems Print Items: boolean
- processedByRevCommit Processed by Rev Commit: boolean
- quantity Quantity: number (float)
- quantityAllocated Quantity Allocated: number (float)
- quantityAvailable Available: number (float)
- quantityCommitted Committed: number (float)
- quantityDemandAllocated Allocated Demand: number (float)
- quantityOnHand On Hand: number (float)
- rate Rate: number (double)
- rateIncludingTax Rate: number (double)
- rateSchedule Rate Schedule: string
- refName Reference Name: string
- revRecEndDate Rev. Rec. End Date: string (date)
- revRecSchedule: revRecSchedule
- revRecStartDate Rev. Rec. Start Date: string (date)
- revrec_recurrencetype Rev Rec Recurrence Type: string
- subscription: subscription
- subscriptionLine: subscriptionLine
- subsidiary: subsidiary
- taxAmount Tax Amount: number (double)
- taxDetailsReference Tax Details Reference: string
- units Units: string
- vsoeAllocation Allocation Amount: number (double)
- vsoeAmount Calculated Amount: number (double)
- vsoeDeferral: object
-
- id Internal identifier.: string DEFERALLUNTIL , DEFERUNTIL
- refName Reference Name: string
- vsoeDelivered Delivered: boolean
- vsoeIsEstimate Estimate: boolean
- vsoePermitDiscount: object
-
- id Internal identifier.: string IFDELIVERED , NEVER
- refName Reference Name: string
- vsoePrice Allocation Price: number (double)
- vsoeSOPGroup: object
-
- id Internal identifier.: string EXCLUDE , NORMAL , SOFTWARE
- refName Reference Name: string
cashRefund-partnersCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: cashRefund-partnersElement
-
cashRefund-partnersElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
cashRefund-partnersElement
This record is available as a beta record.
- contribution Contribution %: number (double)
- isPrimary Primary: boolean
- links Links: nsLink
-
nsLink - partner: partner
- partnerRole: partnerCategory
- refName Reference Name: string
cashRefund-salesTeamCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: cashRefund-salesTeamElement
-
cashRefund-salesTeamElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
cashRefund-shippingAddress
This record is available as a beta record.
- addr1 Address 1: string
-
Enter the address the way it should appear on forms. For employees, customers, partners, and vendors, what you enter here autofills on forms if this address is marked default for Shipping or Billing. Enter up to 50 characters. This field is required for the Online Bill Pay feature.
- addr2 Address 2: string
-
Enter an optional second address line the way it should appear on forms. For employees, customers, partners, and vendors, what you enter here autofills on forms if this address is marked default for Shipping or Billing. Enter up to 50 characters.
- addr3 Address 3: string
- addrPhone Phone: string
-
Enter the phone number.
- addrText Address: string
-
The values entered in the other address fields are displayed here.
- addressee Addressee: string
-
Enter the name of the entity that should appear on the shipping label here. This name appears on the shipping label below what you enter in the Attention field.
- attention Attention: string
-
Enter the name of the person to whom a shipment is addressed, as it should appear on shipping labels. This field is required for UPS Integration.
- city City: string
-
Enter the city the way it should appear on all forms except checks.
- country: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- externalId External ID: string
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - override Override: boolean
-
Check this box to disable the free-form address text field. When this field is disabled, text entered in the other address fields does not display in the Address text field. Clear this box to allow text entered in the address component fields to appear in the free-form address text field.
- refName Reference Name: string
- state State/Province: string
-
Enter your company's state or province the way it should appear on all forms except checks.
- zip Zip: string
-
Enter the postal code the way it should appear on all forms except checks.
cashRefund-taxDetailsCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: cashRefund-taxDetailsElement
-
cashRefund-taxDetailsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
cashRefund-taxDetailsElement
This record is available as a beta record.
- calcDetail Details: string
- lineName Name: string
- lineType Line type: string
- links Links: nsLink
-
nsLink - netAmount Net Amount: number (double)
- refName Reference Name: string
- taxAmount Tax Amount: number (double)
- taxBasis Tax Basis: number (double)
- taxCode: salesTaxItem
- taxDetailsReference: object
-
- id Internal identifier.: string
- refName Reference Name: string
- taxRate Tax Rate: number (double)
- taxType Tax Type: string
cashRefundCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: cashRefund
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
cashRefund - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
cashSale
- account: account
- accountingBookDetail: cashSale-accountingBookDetailCollection
- altHandlingCost Handling Cost: number (double)
-
The handling cost automatically calculates depending on the shipping method you select in the Ship Via field. To change the cost of handling, go to Lists > Shipping Items and select the shipping method with the handling cost you want to change.
- altShippingCost Shipping Cost: number (double)
-
The shipping cost automatically calculates depending on the shipping method you select in the Ship Via field above. To change the cost of a shipping method, go to Lists > Shipping Items and select the shipping method you want to change. If you use UPS Real-Time rates, shipments over 150lbs are broken up into shipments less than or equal to 150lbs for charging.
- appliedRules: cashSale-appliedRulesCollection
- asOfDate As of Date: string (date)
-
The date the cash sale takes effect.
- billAddr1 Billing Address Line 1: string
- billAddr2 Billing Address Line 2: string
- billAddr3 Billing Address Line 3: string
- billAddress Bill To: string
-
The default billing address autofills this field from the customer's record. To enter a different address: * Select another address in the Bill To Select field. * Select New in the Bill To Select field to enter a new billing address to be used for this transaction and saved with the associated entity record. * Select Custom in the Bill To Select field to enter a new billing address to be used for this transaction only (and not saved with the associated entity record). * Click the Edit icon for the Bill To Select field to modify an existing billing address.
- billAddressList: nsResource
- billAddressee Billing Addressee: string
- billAttention Billing Attention: string
- billCity Billing Address City: string
- billCountry: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- billOverride Override: string
- billPhone Billing Phone: string
- billState Billing Address State: string
- billZip Billing Address Zip Code: string
- billingAccount: billingAccount
- billingAddress: cashSale-billingAddress
- billingAddress_text Billing Address: string
- bulkProcSubmission: nsResource
- cardSwipe Card Swipe: string
- cardholderAuthentication: cardholderAuthentication
- checkNumber Check #: string
- class: classification
- cleared Cleared: boolean
- clearedDate Date Cleared: string (date)
- contribPct Contribution Percentage: string
- createdDate Date Created: string (date-time)
- createdFrom: nsResource
- currency: currency
- customForm: object
-
- id Internal identifier.: string -9905
- refName Reference Name: string
- customerPaymentAuthorization: customerPaymentAuthorization
- debitKsn Debit KSN: string
- debitPinBlock Debit Pin Block: string
- defaultILBAShipAddrVal: string
- defaultILBAShippingAddressKey: string
- defaultILShipMethKey Default Shipping Method Key: integer (int64)
- deferredRevenue Deferred Revenue: number (double)
-
Deferred Revenue: amount of revenue deferred on this transaction
- department: department
- discountAmount Discount Amount: number (double)
- discountDate Discount Date: string (date)
- dueDate Due Date: string (date)
- dynamicDescriptor Soft Descriptor: string
- email Email: string
- endDate End Date: string (date)
-
Type or pick the end date for this invoice.
- entity: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- entityTaxRegNum Customer Tax Reg. Number: string
-
Select the customer's tax registration number associated with this cash sale.
- estGrossProfit Est. Gross Profit: number (double)
-
Estimated Gross Profit: Read-only field that equals the revenue amount minus the Est. Cost. At the transaction level, it equals the gross profit of all lines, factoring transaction-level discounts and markups.
- estGrossProfitPercent Est. Gross Profit Percent: number (double)
-
Estimated Gross Profit Margin, as a percentage: Read-only field that equals the Est. Gross Profit divided by revenue, expressed as a percentage. At the transaction level, it equals the gross profit percent of all lines, factoring transaction-level discounts and markups.
- estimate Estimate: integer (int64)
- exchangeRate Exchange Rate: number (double)
-
The currency's exchange rate is shown in this field. You can edit the exchange rate for this transaction only, or you can update the currency record with the exchange rate you enter here.
- excludeCommission Exclude Commissions: boolean
-
Check this option to exclude this transaction and its subordinate transactions from inclusion in all commission calculations.
- excludeFromGLNumbering Exclude from GL Audit Numbering: boolean
- expCost: cashSale-expCostCollection
- externalId External ID: string
- fob FOB: string
-
Enter the location where the customers technically acquire ownership. For example, if your customers own goods as soon as they ship and pay the shipping costs from your location to theirs, you might enter Our warehouse.
- giftCertApplied Gift Certificate: number (double)
- giftCertRedemption: cashSale-giftCertRedemptionCollection
- handlingCost Handling Cost: number (double)
-
The handling cost automatically calculates depending on the shipping method you select in the Ship Via field. To change the cost of handling, go to Lists > Accounting > Shipping Items and select the shipping method with the handling cost you want to change.
- handlingMode: object
-
- id Internal identifier.: string MIMIC , PROCESS , SAVE_ONLY
- refName Reference Name: string
- handlingTaxAmount Handling Tax Amount: number (double)
- id Internal ID: string
- inputReferenceCode Input P/N Ref.: string
- integrationId: string
- isMultiShipTo Enable Item Line Shipping: boolean
-
Check this box to enter multiple shipping routes on this order. In the Ship To field, select a shipping address for the customer. The Default Billing address, from the customer record, is automatically displayed in the field. You can add a New address which is saved to the customer record, or enter a Custom address, which only stays on the transaction, and is not saved to the customer record. In the Ship Via field, select the shipping method you want to use for that address.
- item: cashSale-itemCollection
- itemCost: cashSale-itemCostCollection
- job: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- lastModifiedDate Date Last Modified: string (date-time)
- leadSource: nsResource
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
-
Enter a memo to describe this cash sale. It will appear on reports such as the 2-line Undeposited Funds register.
- message Customer Message: string
-
The text of the customer message you select in the Select Message field appears here. You can edit the message or enter a new customer message for only this transaction.
- messageSel: customerMessage
- nexus: nexus
- oppcreatedfrom: string
- oppcreatedfromtitle: string
- opportunity: opportunity
- originator Originator: string
- otherRefNum PO/Check Number: string
-
If your customer paid by check, enter the number here. It will appear on the Sales Receipt form.
- outputAuthCode Auth. Code: string
- outputReferenceCode P/N Ref.: string
- partner: partner
- partners: cashSale-partnersCollection
- paymentCardCsc CSC: string
- paymentDeviceId Payment Device ID: string
- paymentInstrumentLimit Payment Instrument Limit: number (double)
- paymentOperation: object
-
- id Internal identifier.: string SALE , CAPTURE
- refName Reference Name: string
- paymentOption: nsResource
- paymentProcessingProfile: nsResource
- postingPeriod: accountingPeriod
- prevDate Previous Effective Date: string (date)
- prevPartner Previous Partner: integer (int64)
- prevRep Previous Representative: integer (int64)
- previousOpportunity Previous Opportunity: string
- recognizedRevenue Recognized Revenue: number (double)
-
Recognized Revenue: cumulative amount of revenue recognized for this transaction
- recurringBill Recurring Bill: boolean
- refName Reference Name: string
- revCommitStatus Revenue Commitment Status: string
- revCommitStatusDescr Revenue Commitment Status: string
- revRecOnRevCommitment Rev Rec on Rev Commit.: boolean
-
Check this check box to create a Revenue Commitment or Revenue Commitment Reversal. * On a Sales Order, the Revenue Commitment replaces an invoice * On a Return Authorization, the Revenue Commitment Reversal replaces a credit memo. NetSuite creates all applicable Revenue Recognition schedules for the Revenue Commitment or Revenue Commitment Reversal.
- revenueStatus Revenue Status: string
-
The possible values for this field are: 1. Pending: indicates that no recognition has occurred. All revenue is still deferred. 2. In Progress: indicates that some recognition has occurred. 3. Completed: indicates that all recognition has occurred. No deferred revenue remains.
- revenueStatusDescr Revenue Status: string
- salesChannel: salesChannel
- salesEffectiveDate Sales Effective Date: string (date)
-
You can change the sales effective date for this transaction. The sales effective date determines which commission plan and historical sales team this transaction applies to.
- salesRep: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- salesTeam: cashSale-salesTeamCollection
- saleschannelorderpriority: string
- sendOrderFulfillmentEmail Resend Order Fulfillment Email: boolean
- shipAddress Ship To: string
-
The default shipping address autofills this field from the customer's record at Lists > Customers. To enter a different address: * Select another address in the Ship To Select field. * Select New in the Ship To Select field to enter a new billing address.
- shipAddressList: nsResource
- shipDate Ship Date: string (date)
-
Enter or pick the date this item will ship.
- shipGroup: cashSale-shipGroupCollection
- shipIsResidential Shipping address is residential: boolean
- shipMethod: shipItem
- shipOverride Override: boolean
- shippingAddress: cashSale-shippingAddress
- shippingAddress_text Shipping Address: string
- shippingCost Shipping Cost: number (double)
-
The shipping cost automatically calculates depending on the shipping method you select in the Ship Via field above. To change the cost of a shipping method, go to Lists > Accounting > Shipping Items and select the shipping method you want to change. If you use UPS Real-Time rates, shipments over 150lbs are charged as separate packages weiging equal to or less than 150lbs each.
- shippingCostOverridden Shipping Cost Overridden: boolean
- shippingTaxAmount Shipping Tax Amount: number (double)
- source: object
-
- startDate Start Date: string (date)
-
If you use the Advanced Billing feature, enter the date for the first bill to be created. If a cash sale is created from a sales order that includes a Start Date and End Date, those dates autofill on the cash sale when the order is billed.
- status: object
-
- id Internal identifier.: string A , B , C
- refName Reference Name: string
- storeOrder: string
- subsidiary: subsidiary
- subsidiaryTaxRegNum Subsidiary Tax Reg. Number: string
-
This field shows the tax registration number of the transaction nexus. NetSuite automatically populates this field based on the nexus lookup logic. You can override the transaction nexus and tax registration number that NetSuite automatically selects by checking the Nexus Override box. When you select a different tax registration number in the dropdown list, the corresponding nexus is automatically selected in the Nexus field.
- subtotal Subtotal: number (double)
-
This field shows the total of the items on this sales order. This is the total before any discount, shipping cost, handling cost or tax is added to the order.
- taxDetails: cashSale-taxDetailsCollection
- taxDetailsOverride Tax Details Override: boolean
-
Check this box to override the tax information on the Tax Details subtab of the transaction. Only roles with at least the Edit level of the Tax Details Tab permission can override the tax details.
- taxPointDate Tax Point Date: string (date)
-
Tax point date is a legal requirement in many countries. It is the date of transaction that determines the taxability. It may be different from the transaction date that determines the GL impact. Specific rules then consider the reporting of transactions based on tax point date and other factors.
- taxPointDateOverride Tax Point Date Override: boolean
- taxRegOverride Tax Registration Override: boolean
-
Check this box to override the values in the Nexus and Subsidiary Tax Reg. Number fields. Only roles with at least the Edit level of the Tax Details Tab permission can override the values that NetSuite automatically selects in these fields.
- taxTotal Tax: number (double)
-
NetSuite multiplies the tax rate by the taxable total of line items and enters it here.
- terms: term
- thirdPartyAcct 3rd Party Account: string
- time: cashSale-timeCollection
- toBeEmailed To Be Emailed: boolean
-
Check this box if you want to e-mail this receipt. Then enter the e-mail address in the space to the right of the check box. You can enter multiple e-mail addresses by separating them with semicolons. It is important to separate the addresses with only semicolons, and do not include any spaces.
- toBeFaxed To Be Faxed: boolean
-
Check this box if you want to fax this cash sale receipt. Enter the fax number in the space to the right of the check box if it doesn't already appear. To fax NetSuite forms, an administrator must first set up fax service at Setup > Company > Printing, Fax and E-mail Preferences.
- toBePrinted To Be Printed: boolean
-
Check this box if you wish to save this in a queue of sales receipts to print. Otherwise, you can click Print below to submit and print this sales receipt at once.
- total Total: number (double)
-
NetSuite computes the total of line items, tax and shipping charges, and then enters it here.
- totalAfterTaxes Total After Taxes: number (double)
- totalCostEstimate Est. Cost: number (double)
-
Estimated Cost: Estimated cost of the specific number of items; estimated rate x quantity = estimated cost.
- trackingNumbers Tracking Numbers: string
-
Enter the shipment tracking number from the shipping company. If a tracking number is entered in the exact format used by UPS or FedEx and the transaction is saved, the tracking number will show on the transaction as a link to the UPS or FedEx website. You can click the link to check the status of the shipment.
- tranDate Date: string (date)
-
NetSuite inserts today's date as the date of this cash sale. You can type or pick another date.
- tranId Sale #: string
-
NetSuite increases the largest sale number by one. You can also type another number. Then, the next sale number reverts to the standard pattern. You can also enter non-numerical characters in this field. The maximum number of characters you can enter in this field is 45.
- tranIsVsoeBundle Transaction Is VSOE Bundle: boolean
-
Check this box to include all items added to this transaction as a VSOE bundle.
- transactionToRefund: nsResource
- undepFunds: object
-
- id Internal identifier.: string
- refName Reference Name: string
- vsoeAutoCalc Auto Calculate VSOE Allocation: boolean
-
The VSOE allocation amount for a sale can be calculated automatically by checking the Auto Calculate VSOE Allocation box. Allocation is the process to determine the VSOE price for items on a sale. The total VSOE amount allocated is the revenue amount to be recognized for the bundle.
- webSite: string
- whichChargesToAdd: object
-
- id Internal identifier.: string , ALL , TRANSACTION_DATE , AS_OF_DATE
- refName Reference Name: string
cashSale-accountingBookDetailCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: cashSale-accountingBookDetailElement
-
cashSale-accountingBookDetailElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
cashSale-accountingBookDetailElement
- accountingBook: accountingBook
- exchangeRate Exchange Rate: number (double)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- revRecOnRevCommitment Rev Rec on Rev Commit.: boolean
- subsidiary: subsidiary
- tranIsVsoeBundle Transaction Is VSOE Bundle: boolean
cashSale-appliedRulesCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: cashSale-appliedRulesElement
-
cashSale-appliedRulesElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
cashSale-billingAddress
- addr1 Address 1: string
-
Enter the address the way it should appear on forms. For employees, customers, partners, and vendors, what you enter here autofills on forms if this address is marked default for Shipping or Billing. Enter up to 50 characters. This field is required for the Online Bill Pay feature.
- addr2 Address 2: string
-
Enter an optional second address line the way it should appear on forms. For employees, customers, partners, and vendors, what you enter here autofills on forms if this address is marked default for Shipping or Billing. Enter up to 50 characters.
- addr3 Address 3: string
- addrPhone Phone: string
-
Enter the phone number.
- addrText Address: string
-
The values entered in the other address fields are displayed here.
- addressee Addressee: string
-
Enter the name of the entity that should appear on the shipping label here. This name appears on the shipping label below what you enter in the Attention field.
- attention Attention: string
-
Enter the name of the person to whom a shipment is addressed, as it should appear on shipping labels. This field is required for UPS Integration.
- city City: string
-
Enter the city the way it should appear on all forms except checks.
- country: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- externalId External ID: string
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - override Override: boolean
-
Check this box to disable the free-form address text field. When this field is disabled, text entered in the other address fields does not display in the Address text field. Clear this box to allow text entered in the address component fields to appear in the free-form address text field.
- refName Reference Name: string
- state State/Province: string
-
Enter your company's state or province the way it should appear on all forms except checks.
- zip Zip: string
-
Enter the postal code the way it should appear on all forms except checks.
cashSale-expCostCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: cashSale-expCostElement
-
cashSale-expCostElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
cashSale-expCostElement
- amortizationperiod Amortization Period: string
- amortizationtype Amortization Type: string
- amount Bill Amount: number (double)
- apply Apply: boolean
- billedDate Date: string (date)
- category: expenseCategory
- class: classification
- department: department
- doc: nsResource
- employee: employee
- job: string
- jobDisp Project: string
- line Line: integer (int64)
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
- originalAmount Original Amount: number (double)
- prevRevRecSched: boolean
- prevRevRecTemp: boolean
- processedByRevCommit Processed by Rev Commit: boolean
- refName Reference Name: string
- revRecDefRevAcct Deferred Revenue Account: integer (int64)
- taxAmount Tax Amount: number (double)
- taxDetailsReference Tax Details Reference: string
- url URL: string
cashSale-giftCertRedemptionCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: cashSale-giftCertRedemptionElement
-
cashSale-giftCertRedemptionElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
cashSale-giftCertRedemptionElement
- authCode: giftCertificate
- authCodeApplied Amount Applied: number (double)
- links Links: nsLink
-
nsLink - refName Reference Name: string
cashSale-item-inventoryDetail
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- externalId External ID: string
- inventoryassignment: cashSale-item-inventoryDetail-inventoryassignmentCollection
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemDescription Description: string
-
A more complete Description of the item.
- links Links: nsLink
-
nsLink - location: location
- quantity Quantity: number (float)
-
In the Quantity to Build field, enter the number of assembly items you want to build. You cannot enter a quantity that exceeds the amount displayed in the Buildable Quantity field.
- refName Reference Name: string
- toLocation: location
- unit Units: string
-
If the assembly uses Units of Measure, the base units are displayed in the Units field.
cashSale-item-inventoryDetail-inventoryassignmentCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: cashSale-item-inventoryDetail-inventoryassignmentElement
-
cashSale-item-inventoryDetail-inventoryassignmentElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
cashSale-item-inventoryDetail-inventoryassignmentElement
- binNumber: bin
- expirationDate Expiration Date: string (date)
- internalId Internal ID: integer (int64)
- inventoryDetail Inventory Detail: integer (int64)
- inventoryStatus: inventoryStatus
- issueInventoryNumber: inventoryNumber
- links Links: nsLink
-
nsLink - packCarton Pack Carton: string
- pickCarton Pick Carton: string
- quantity Quantity: number (float)
- quantityAvailable Unpicked Bin Qty: number (float)
- receiptInventoryNumber Serial/Lot Number: string
- refName Reference Name: string
- secondaryQuantity Secondary Quantity: number (float)
- toBinNumber: bin
- toInventoryStatus: inventoryStatus
cashSale-itemCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: cashSale-itemElement
-
cashSale-itemElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
cashSale-itemCost-inventoryDetail
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- externalId External ID: string
- inventoryassignment: cashSale-itemCost-inventoryDetail-inventoryassignmentCollection
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemDescription Description: string
-
A more complete Description of the item.
- links Links: nsLink
-
nsLink - location: location
- quantity Quantity: number (float)
-
In the Quantity to Build field, enter the number of assembly items you want to build. You cannot enter a quantity that exceeds the amount displayed in the Buildable Quantity field.
- refName Reference Name: string
- toLocation: location
- unit Units: string
-
If the assembly uses Units of Measure, the base units are displayed in the Units field.
cashSale-itemCost-inventoryDetail-inventoryassignmentCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: cashSale-itemCost-inventoryDetail-inventoryassignmentElement
-
cashSale-itemCost-inventoryDetail-inventoryassignmentElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
cashSale-itemCost-inventoryDetail-inventoryassignmentElement
- binNumber: bin
- expirationDate Expiration Date: string (date)
- internalId Internal ID: integer (int64)
- inventoryDetail Inventory Detail: integer (int64)
- inventoryStatus: inventoryStatus
- issueInventoryNumber: inventoryNumber
- links Links: nsLink
-
nsLink - packCarton Pack Carton: string
- pickCarton Pick Carton: string
- quantity Quantity: number (float)
- quantityAvailable Unpicked Bin Qty: number (float)
- receiptInventoryNumber Serial/Lot Number: string
- refName Reference Name: string
- secondaryQuantity Secondary Quantity: number (float)
- toBinNumber: bin
- toInventoryStatus: inventoryStatus
cashSale-itemCostCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: cashSale-itemCostElement
-
cashSale-itemCostElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
cashSale-itemCostElement
- amortizationperiod Amortization Period: string
- amortizationtype Amortization Type: string
- amount Total: number (double)
- apply Apply: boolean
- billedDate Date: string (date)
- binNumbers Bin Numbers: string
- class: classification
- cost Rate: number (double)
- department: department
- doc: nsResource
- inventoryDetail: cashSale-itemCost-inventoryDetail
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemCostCount Qty: string
- job: string
- jobDisp Project: string
- line Line: integer (int64)
- links Links: nsLink
-
nsLink - location: location
- memo Description: string
- options Options: string
- prevRevRecSched: boolean
- prevRevRecTemp: boolean
- processedByRevCommit Processed by Rev Commit: boolean
- rateSchedule Rate Schedule: string
- refName Reference Name: string
- revRecDefRevAcct Deferred Revenue Account: integer (int64)
- serialNumbers Serial/Lot Numbers: string
- taxAmount Tax Amount: number (double)
- taxDetailsReference Tax Details Reference: string
- unit Unit: string
- unitDisp Units: string
- url URL: string
cashSale-itemElement
- amount Amount: number (double)
- catchUpPeriod: accountingPeriod
- chargeType: nsResource
- class: classification
- costEstimate Est. Cost: number (double)
- costEstimateRate Est. Rate: number (double)
- costEstimateType: object
-
- id Internal identifier.: string PREFVENDORRATE , AVGCOST , PURCHORDERRATE , LASTPURCHPRICE , MEMBERDEFINED , CUSTOM , ITEMDEFINED , PURCHPRICE
- refName Reference Name: string
- deferRevRec Deferred Revenue: boolean
- department: department
- description Description: string
- doNotCreateRevenueElement Do Not Create Revenue Element: boolean
- estGrossProfit Est. Gross Profit: number (double)
- estGrossProfitPercent Est. Gross Profit Percent: number (double)
- excludeFromRateRequest Exclude Item from Rate Request: boolean
- giftCertFrom From: string
- giftCertMessage Gift Message: string
- giftCertNumber Code: string
- giftCertRecipientEmail Recipient Email: string
- giftCertRecipientName Recipient Name: string
- initOqpBucket Initial OQP Bucket: string
- inventoryDetail: cashSale-item-inventoryDetail
- isClosed Closed: boolean
- isOpen Is Opened: boolean
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemFulfillmentChoice: object
-
- id Internal identifier.: string 1 , 2
- refName Reference Name: string
- itemSubtype: object
-
- id Internal identifier.: string Sale , Purchase , Resale
- refName Reference Name: string
- itemType: object
-
- job: job
- licenseCode License Code: string
- line Transaction Line: integer (int64)
- linked Linked: boolean
- links Links: nsLink
-
nsLink - location: location
- marginal Marginal: boolean
- matrixType Matrix Type: string
- minQty Minimum Quantity: number (float)
- options Options: string
- oqpBucket Oqp Bucket: string
- orderDoc: nsResource
- orderLine Order Line: integer (int64)
- price: priceLevel
- printItems Print Items: boolean
- processedByRevCommit Processed by Rev Commit: boolean
- quantity Quantity: number (float)
- quantityAllocated Quantity Allocated: number (float)
- quantityAvailable Available: number (float)
- quantityCommitted Committed: number (float)
- quantityDemandAllocated Allocated Demand: number (float)
- quantityOnHand On Hand: number (float)
- rate Rate: number (double)
- rateIncludingTax Rate: number (double)
- rateSchedule Rate Schedule: string
- refName Reference Name: string
- revRecEndDate Rev. Rec. End Date: string (date)
- revRecSchedule: revRecSchedule
- revRecStartDate Rev. Rec. Start Date: string (date)
- revrec_recurrencetype Rev Rec Recurrence Type: string
- shipAddress: nsResource
- shipCarrier: object
-
- id Internal identifier.: string ups , nonups
- refName Reference Name: string
- shipMethod: shipItem
- subscription: subscription
- subscriptionLine: subscriptionLine
- subsidiary: subsidiary
- taxAmount Tax Amount: number (double)
- taxDetailsReference Tax Details Reference: string
- units Units: string
- vsoeAllocation Allocation Amount: number (double)
- vsoeAmount Calculated Amount: number (double)
- vsoeDeferral: object
-
- id Internal identifier.: string DEFERALLUNTIL , DEFERUNTIL
- refName Reference Name: string
- vsoeDelivered Delivered: boolean
- vsoeIsEstimate Estimate: boolean
- vsoePermitDiscount: object
-
- id Internal identifier.: string IFDELIVERED , NEVER
- refName Reference Name: string
- vsoePrice Allocation Price: number (double)
- vsoeSOPGroup: object
-
- id Internal identifier.: string EXCLUDE , NORMAL , SOFTWARE
- refName Reference Name: string
cashSale-partnersCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: cashSale-partnersElement
-
cashSale-partnersElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
cashSale-partnersElement
- contribution Contribution %: number (double)
- isPrimary Primary: boolean
- links Links: nsLink
-
nsLink - partner: partner
- partnerRole: partnerCategory
- refName Reference Name: string
cashSale-salesTeamCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: cashSale-salesTeamElement
-
cashSale-salesTeamElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
cashSale-shipGroupCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: cashSale-shipGroupElement
-
cashSale-shipGroupElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
cashSale-shipGroupElement
- destinationAddress Ship To: string
- handlingRate Handling Rate: number (double)
- id ID: integer (int64)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- shippingMethod Ship Via: string
- shippingRate Shipping Rate: number (double)
- sourceAddress Ship From: string
- uniqueKey Unique Key: integer (int64)
- weight Weight: number (float)
cashSale-shippingAddress
- addr1 Address 1: string
-
Enter the address the way it should appear on forms. For employees, customers, partners, and vendors, what you enter here autofills on forms if this address is marked default for Shipping or Billing. Enter up to 50 characters. This field is required for the Online Bill Pay feature.
- addr2 Address 2: string
-
Enter an optional second address line the way it should appear on forms. For employees, customers, partners, and vendors, what you enter here autofills on forms if this address is marked default for Shipping or Billing. Enter up to 50 characters.
- addr3 Address 3: string
- addrPhone Phone: string
-
Enter the phone number.
- addrText Address: string
-
The values entered in the other address fields are displayed here.
- addressee Addressee: string
-
Enter the name of the entity that should appear on the shipping label here. This name appears on the shipping label below what you enter in the Attention field.
- attention Attention: string
-
Enter the name of the person to whom a shipment is addressed, as it should appear on shipping labels. This field is required for UPS Integration.
- city City: string
-
Enter the city the way it should appear on all forms except checks.
- country: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- externalId External ID: string
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - override Override: boolean
-
Check this box to disable the free-form address text field. When this field is disabled, text entered in the other address fields does not display in the Address text field. Clear this box to allow text entered in the address component fields to appear in the free-form address text field.
- refName Reference Name: string
- state State/Province: string
-
Enter your company's state or province the way it should appear on all forms except checks.
- zip Zip: string
-
Enter the postal code the way it should appear on all forms except checks.
cashSale-taxDetailsCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: cashSale-taxDetailsElement
-
cashSale-taxDetailsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
cashSale-taxDetailsElement
- calcDetail Details: string
- lineName Name: string
- lineType Line type: string
- links Links: nsLink
-
nsLink - netAmount Net Amount: number (double)
- refName Reference Name: string
- taxAmount Tax Amount: number (double)
- taxBasis Tax Basis: number (double)
- taxCode: salesTaxItem
- taxDetailsReference: object
-
- id Internal identifier.: string
- refName Reference Name: string
- taxRate Tax Rate: number (double)
- taxType Tax Type: string
cashSale-timeCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: cashSale-timeElement
-
cashSale-timeElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
cashSale-timeElement
- amortizationperiod Amortization Period: string
- amortizationtype Amortization Type: string
- amount Amount: number (double)
- apply Apply: boolean
- billedDate Date: string (date)
- class: classification
- department: department
- doc: timeBill
- employee: employee
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- job: string
- jobDisp Project: string
- links Links: nsLink
-
nsLink - location: location
- memo Description: string
- prevRevRecSched: boolean
- prevRevRecTemp: boolean
- processedByRevCommit Processed by Rev Commit: boolean
- rate Rate: number (double)
- rateSchedule Rate Schedule: string
- refName Reference Name: string
- revRecDefRevAcct Deferred Revenue Account: integer (int64)
- taxAmount Tax Amount: number (double)
- taxDetailsReference Tax Details Reference: string
- unit Unit: string
- url URL: string
cashSaleCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: cashSale
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
cashSale - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
charge
- amount Amount: number (double)
-
The charge amount is shown here. The charge amount is calculated as charge rate multiplied by charge quantity. You can manually override the charge amount.
- billDate Bill Date: string (date)
-
The bill date for this charge is displayed here.
- billTo: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- billingAccount: billingAccount
- billingItem: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- billingMode: object
-
- id Internal identifier.: string IN_ARREARS , IN_ADVANCE , IMMEDIATE
- refName Reference Name: string
- billingSchedule: billingSchedule
- chargeDate Date: string (date)
-
This is the date this charge was generated or created.
- chargeEmployee: employee
- chargeType: nsResource
- class: classification
- createdDate Date Created: string (date-time)
-
This is the date this charge was created either manually or by a charge run.
- creditMemo: nsResource
- creditMemoLine Credit Memo Item Line: string
-
If this charge is the result of a credit memo, the line number from the corresponding memo is displayed here.
- currency: currency
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- department: department
- description Description: string
-
Enter a description of this charge.
- externalId External ID: string
- groupOrder Group Order: integer (int64)
-
Choose the order in which you want this charge to appear on invoice lines.
- id Internal ID: string
- invoice: nsResource
- invoiceLine Invoice Item Line: string
-
If this charge has been billed, the invoice line containing this charge is shown here.
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
-
This field is used to log information from Recurring Billing,.
- projectTask: projectTask
- quantity Quantity: number (float)
-
The quantity for this charge is shown here. The quantity for a project charge is set to 1.
- rate Rate: number (double)
-
The rate for this charge is shown here. The charge rates for project charges are determined by charge rules.
- refName Reference Name: string
- rule: chargeRule
- runId Charge Run ID: string
- salesOrder: nsResource
- salesOrderLine Sales Order Line: string
-
If this charge has been included on a sales order, the sales order line is shown here.
- serviceEndDate Service End Date: string (date)
-
If this service has an end date, enter it here.
- serviceStartDate Service Start Date: string (date)
-
If this charge has a start date, enter it here.
- stage: object
-
- id Internal identifier.: string NON_BILLABLE , READY_FOR_BILLING , HOLD_FOR_BILLING
- refName Reference Name: string
- subscriptionLine: subscriptionLine
- subsidiary: subsidiary
- timeRecord: timeBill
- transaction: nsResource
- transactionLine Transaction Line: string
- units Units: string
-
Units of measure.
- use: object
-
- id Internal identifier.: string Forecast , Actual
- refName Reference Name: string
chargeCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: charge
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
charge - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
chargeRule
This record is available as a beta record.
- chargeRuleType: object
-
- id Internal identifier.: string PROJECTPROGRESS , MILESTONE , FIXEDDATE , TIMEBASED , EXPENSEBASED , PURCHASE
- refName Reference Name: string
- description Description: string
-
Enter a description for this charge rule.
- externalId External ID: string
- id Internal ID: string
- isInactive Inactive: boolean
-
Check this box to inactivate this rule. This rule will no longer generate charges for the project.
- links Links: nsLink
-
nsLink - name Name: string
-
Enter the name of this charge rule.
- project: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- refName Reference Name: string
chargeRuleCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: chargeRule
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
chargeRule - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
check
This record is available as a beta record.
- account: account
- accountingBookDetail: check-accountingBookDetailCollection
- address Pay To: string
-
NetSuite inserts the address of the payee from the payee record. To enable or disable the Auto Fill preference, go to > Set Preferences. If you want, you can change it here for just this transaction by typing up to five rows of information.
- availableBalance Available Balance: number (double)
-
This field displays the available balance in the selected account.
- balance Balance: number (double)
-
NetSuite displays the balance of the selected bank account.
- checklinkdisplay: string
- class: classification
- cleared Cleared: boolean
- clearedDate Date Cleared: string (date)
- createdDate Date Created: string (date-time)
- currency: currency
- customForm: object
-
- id Internal identifier.: string -9951
- refName Reference Name: string
- department: department
- entity: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- entitybillpay: string
- exchangeRate Exchange Rate: number (double)
-
The currency's exchange rate is shown in this field. You can edit the exchange rate for this transaction only, or you can update the currency record with the exchange rate you enter here.
- excludeFromGLNumbering Exclude from GL Audit Numbering: boolean
- expense: check-expenseCollection
- externalId External ID: string
- id Internal ID: string
- item: check-itemCollection
- landedCostMethod: object
-
- id Internal identifier.: string WEIGHT , QUANTITY , VALUE
- refName Reference Name: string
- lastModifiedDate Date Last Modified: string (date-time)
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
-
If you want, enter a memo. What you enter here will print on the memo line of the check.
- nexus: nexus
- oldaccount: string
- payeeAddress: check-payeeAddress
- payeeAddressList: nsResource
- payeeAddress_text Pay To: string
- postingPeriod: accountingPeriod
- prevDate Previous Effective Date: string (date)
- refName Reference Name: string
- status: object
-
- id Internal identifier.: string V , Z
- refName Reference Name: string
- subsidiary: subsidiary
- taxTotal Tax: number (double)
-
Here, NetSuite enters the total amount of GST based on the line items you enter below.
- toBePrinted To Be Printed: boolean
-
If you want to save this in a queue of checks to print, check this box. Otherwise, to save and print this check now, you can click Save & Print.
- total Amount: number (double)
- tranDate Date: string (date)
-
NetSuite inserts today's date for the posting date of this check. You can type or pick another date. What you enter here determines the date range in which this transaction appears on the Bank register. You can select or enter custom date ranges on registers.
- tranId Check #: string
-
NetSuite automatically fills this field. If you checked the To Be Printed box, this field autofills with To Print. You choose starting numbers when you print those checks. If you are immediately printing this check, NetSuite increases the largest check number by one. You can type another number here, but the next number reverts to the standard pattern. You can also use this field to record ACH, ATM, or other reference numbers.
- userTotal Amount: number (double)
-
You can enter the dollar amount of the check, but NetSuite will update this amount as you add or edit line items.
- voidjournal: nsResource
check-accountingBookDetailCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: check-accountingBookDetailElement
-
check-accountingBookDetailElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
check-accountingBookDetailElement
This record is available as a beta record.
- accountingBook: accountingBook
- exchangeRate Exchange Rate: number (double)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- revRecOnRevCommitment Rev Rec on Rev Commit.: boolean
- subsidiary: subsidiary
- tranIsVsoeBundle Transaction Is VSOE Bundle: boolean
check-expenseCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: check-expenseElement
-
check-expenseElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
check-expenseElement
This record is available as a beta record.
- account: account
- amount Amount: number (double)
- category: expenseCategory
- class: classification
- customer: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- customer_sub: string
- department: department
- isBillable Billable: boolean
- line Line: integer (int64)
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
- projecttask: projectTask
- refName Reference Name: string
check-item-inventoryDetail
This record is available as a beta record.
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- externalId External ID: string
- inventoryassignment: check-item-inventoryDetail-inventoryassignmentCollection
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemDescription Description: string
-
A more complete Description of the item.
- links Links: nsLink
-
nsLink - location: location
- quantity Quantity: number (float)
-
In the Quantity to Build field, enter the number of assembly items you want to build. You cannot enter a quantity that exceeds the amount displayed in the Buildable Quantity field.
- refName Reference Name: string
- toLocation: location
- unit Units: string
-
If the assembly uses Units of Measure, the base units are displayed in the Units field.
check-item-inventoryDetail-inventoryassignmentCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: check-item-inventoryDetail-inventoryassignmentElement
-
check-item-inventoryDetail-inventoryassignmentElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
check-item-inventoryDetail-inventoryassignmentElement
This record is available as a beta record.
- binNumber: bin
- expirationDate Expiration Date: string (date)
- internalId Internal ID: integer (int64)
- inventoryDetail Inventory Detail: integer (int64)
- inventoryStatus: inventoryStatus
- issueInventoryNumber: inventoryNumber
- links Links: nsLink
-
nsLink - packCarton Pack Carton: string
- pickCarton Pick Carton: string
- quantity Quantity: number (float)
- quantityAvailable Unpicked Bin Qty: number (float)
- receiptInventoryNumber Serial/Lot Number: string
- refName Reference Name: string
- secondaryQuantity Secondary Quantity: number (float)
- toBinNumber: bin
- toInventoryStatus: inventoryStatus
check-itemCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: check-itemElement
-
check-itemElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
check-itemElement
This record is available as a beta record.
- amount Amount: number (double)
- billVarianceStatus: object
-
- id Internal identifier.: string NOVARIANCES , JOURNALNOTPOSTED , JOURNALPOSTED
- refName Reference Name: string
- class: classification
- customer: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- department: department
- description Description: string
- initOqpBucket Initial OQP Bucket: string
- inventoryDetail: check-item-inventoryDetail
- isBillable Billable: boolean
- isClosed Closed: boolean
- isOpen Is Opened: boolean
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemSubtype: object
-
- id Internal identifier.: string Sale , Purchase , Resale
- refName Reference Name: string
- itemType: object
-
- job: job
- licenseCode License Code: string
- line Transaction Line: integer (int64)
- linked Linked: boolean
- links Links: nsLink
-
nsLink - location: location
- marginal Marginal: boolean
- matrixType Matrix Type: string
- minQty Minimum Quantity: number (float)
- options Options: string
- oqpBucket Oqp Bucket: string
- printItems Print Items: boolean
- projecttask: projectTask
- quantity Quantity: number (float)
- rate Rate: number (double)
- rateIncludingTax Rate: number (double)
- rateSchedule Rate Schedule: string
- refName Reference Name: string
- subsidiary: subsidiary
- units Units: string
- vendorName Vendor Name: string
check-payeeAddress
This record is available as a beta record.
- addr1 Address 1: string
- addr2 Address 2: string
- addr3 Address 3: string
- addrPhone Phone: string
- addrText Address: string
- addressee Addressee: string
- attention Attention: string
- city City: string
- country: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- externalId External ID: string
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - override Override: boolean
- refName Reference Name: string
- state State/Province: string
- zip Zip: string
checkCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: check
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
check - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
classification
This record is available as a beta record.
- classtranslation: classification-classtranslationCollection
- externalId External ID: string
- fullName Full Name: string
- id Internal ID: string
- includeChildren Include Children: boolean
-
Check the Include Children box to associate the class with all the sub-subsidiaries associated with each subsidiary selected in the Subsidiary field.
- internalId Internal ID: integer (int64)
- isInactive Class is Inactive: boolean
-
Check this box to inactivate this class record. Inactive classes do not show in lists of classes on records and transactions.
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - name Name: string
-
Enter a name for this class. The name you enter here shows in lists of classes on records and transactions. The name can be alphanumeric. The maximum number of characters is 31.
- parent: classification
- refName Reference Name: string
- subsidiary: subsidiaryCollection
classification-classtranslationCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: classification-classtranslationElement
-
classification-classtranslationElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
classification-classtranslationElement
This record is available as a beta record.
- language Language: string
- links Links: nsLink
-
nsLink - locale: object
-
- id Internal identifier.: string it_CH , en_TC , af_ZA , es_EA , es_EC , pt_BR , en_CY , fr_LU , nl_AN , es_UY , en_TT , es_ES , pt_ST , en_DM , en_TZ , es_ES_EURO , fr_ML , de_DE_onLQA , es_VE , nl_BE , da_DK , pt_AO , to_TO , en_UG , am_ET , ss_SZ , nl_BQ , ar , pt_AW , ko_KR , en_US , fr_BE_EURO , ko_KP , si_AQ , fr_MG , el_GR , be_BY , en_AU , he_IL , en_AW , es_SV , en_BB , ar_YE , es_CO , es_CL , en_BM , es_CR , pa_IN , en_SC , en_BS , sm_WS , it_IT_EURO , fr_KM , es_CU , en_SB , en_SG , en_BW , en_SH , en_BZ , en_SL , az_AZ , fi_FI , en_SS , sr_YU , en_CD , en_CA , ka_GE , lv_LV , uk_UA , es_DO , ur_PK , ar_IQ , fr_LU_EURO , pt_PT , fr_FR_EURO , en_PH , th_TH , bn_BD , si_LK , en_PG , hu_HU , ar_SA , ar_SD , ru_KZ , ar_BH , nl_BE_EURO , ro_MD , en_QA , ru_KG , es_AR , ta_IN , sr_RS , aa_ER , en , de_DE_EURO , zh_MO , en_AE , ar_SY , es_BO , en_AI , no_NO , en_AG , nl_SR , fr_VU , en_MW , gu_AQ , ar_TN , nl_SX , hi_IN , en_NA , mn_MN , en_NG , fr_FR , ms_MY , nl_CW , uz_UZ , ar_DJ , sr_CS , de_AT_EURO , en_NZ , es_PE , es_PA , fa_IR , ar_DZ , fr_GN , lb_LU , xx_US , pt_CV , sh_RS , ht_HT , fr_WF , es_AR_onLQA , es_PR , ar_EG , es_PY , fr_GA , en_KW , de_AT , ro_RO , en_KY , fr_FR_onLQA , fr_DJ , ca_ES_EURO , cs_CZ , en_LC , pl_AQ , fr_TD , fr_TG , es_MX , sv_AX , sk_SK , en_LR , en_LS , ar_OM , dz_BT , te_IN , de_LU_EURO , sq_AL , sv_SE , sn_ZW , es_NI , en_IE_EURO , my_MM , en_MF , en_MU , it_IT , pl_PL , fr_BE , fr_BF , tr_TR , fr_BI , fr_BJ , id_ID , fr_RW , en_ZM , km_KH , ja_JP , de_DE , fr_BL , tg_TJ , ar_QA , de_CH , zh_HK , pt_PT_EURO , en_JO , en_JM , fr_CA , nl_NL_EURO , fr_CF , fr_CG , fr_CD , pa_AQ , fr_CH , xx_US_wthId , fr_CI , pt_GW , vi_VN , ru_MD , fr_CM , fr_SC , en_KE , ne_NP , bs_BA , sl_SI , en_KN , fr_SN , ar_AE , en_GY , tl_PH , ca_ES , es_IC , lo_LA , kn_IN , so_SO , fr_PF , ar_JO , nl_NL , is_IS , fi_FI_EURO , pt_MZ , sk_SK_EURO , sl_SI_EURO , en_IE , ms_BN , hr_HR , ar_KW , de_LU , lt_LT , en_IN , ps_AF , en_ZA , en_VC , ru_RU , sh_YU , ar_LB , mr_IN , dv_MV , fj_FJ , zh_TW , tk_TM , ar_LY , en_VU , fr_NE , en_FK , es_GT , fr_NC , es_GQ , fa_AF , bg_BG , hy_AM , en_CY_EURO , mk_MK , ar_MA , en_GD , en_GB , es_HN , gu_IN , en_GH , et_EE , en_GI , zh_CN , en_GM , ar_MR
- refName Reference Name: string
- name Name: string
- refName Reference Name: string
classificationCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: classification
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
classification - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
cmscontent
This record is available as a beta record.
- tags: cmscontent-tagsCollection
- areaname Area Name: string
-
Specifies the name of the area on the page where this content is placed. This name is the value of the data-cms-area attribute from the page template file.
- changeurl Change URL: string
-
Specifies the URL used when the content was created or changed. This URL does not necessarily reflect the only URL where the content is displayed. For example, content with page type and global context, can display on many pages. The URL in this field reflects only the URL of the page where the content was added or last edited.
- cmscontenttype: cmscontenttype
- createdBy: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- createddate Date Created: string (date)
- description Description: string
-
Enter the description for this record.
- enddate End Date: string (date-time)
-
This identifies the end date and time for the record. When this date is passed, the content is no longer be visible the site. If there is no end date, the content does not expire. This relates to Content Visibility topic in the Help. Enter the date and time in the same format as specified in your preferences.
- externalId External ID: string
- global Global Context: string
-
This corresponds with the SMT All Pages area type. When content is configured to display in all pages, this field contains the *.
- hidden Hidden: boolean
- id Internal ID: string
- internalId Internal ID: integer (int64)
-
This is the system-assigned internal identifier for the record.
- lastmodifiedby: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- lastmodifieddate Last Modified: string (date)
- links Links: nsLink
-
nsLink - matchcount Match Count: integer (int64)
- matchtype Match Type: string
-
SMT version 3 does not use this field.
- name Name: string
-
Enter the name for this record.
- pagetype Page Type Context: string
-
This corresponds with the SMT This Page area scope and is used for content that you want to place on a specific type of page such as a product detail page or a facet browse page. Available options are: * Product Details — denotes a product detail page. * facet-browse — denotes a facet browse page or a category page. * cms-landing-page — denotes a landing page.
- path Path Context: string
-
The corresponds with the This Page area type and denotes the URL to the page.
- refName Reference Name: string
- sequencenumber Sequence Number: integer (int64)
- settings Settings: integer (int64)
-
Identifies the ID for the custom record that stores the content. The ID links the custom record for the content instance to the corresponding CMS Content record.
- site: webSite
- startdate Start Date: string (date-time)
-
This identifies the start date and time for the record you are viewing. If this is a future date, the content does not display until that date. This related to the Content Visibility topic in the help. Enter the date and time in the same format as specified in your preferences.
- template Template: string
-
Identifies the template used when rendering content. This should be set to default.
- translationenabled Enable Translation: boolean
- translations: cmscontent-translationsCollection
cmscontent-translationsCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: cmscontent-translationsElement
-
cmscontent-translationsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
cmscontentCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: cmscontent
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
cmscontent - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
cmscontenttype
This record is available as a beta record.
- customrecordid: nsResource
- customrecordscriptid Custom Record Script Id: string
- description Description: string
-
Enter the description for this record.
- externalId External ID: string
- iconimagepath Icon Image Path: string
-
Specify the icon to use for this content type in the Site Management Tools user interface. The icon file must be in SVG format. Enter the relative path and filename.
- id Internal ID: string
- internalId Internal ID: integer (int64)
-
This is the system-assigned internal identifier for the record.
- label Label: string
-
Specify the label to use for this content type in the Site Management Tools user interface.
- links Links: nsLink
-
nsLink - name Name: string
-
Enter the name for this record.
- package App ID: string
- publisherid Publisher ID: string
- refName Reference Name: string
- scriptid Script ID: string
cmscontenttypeCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: cmscontenttype
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
cmscontenttype - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
commerceCategory
This record is available as a beta record.
- tags: commerceCategory-tagsCollection
- addtohead Addition to <head>: string
-
The addition to head field lets you specify code such as HTML, CSS, or JavaScript to include between the head tags on this category page.
- catalog: nsResource
- created Creation Date/Time: string (date)
- customersegments: commerceCategory-customersegmentsCollection
- description Description: string
-
Specify a description for this record.
- displayinsite: object
-
- id Internal identifier.: string T , F
- refName Reference Name: string
- enddate End Date: string (date-time)
-
This identifies the end date and time for the record. When this date is passed, the content is no longer be visible the site. If there is no end date, the content does not expire. This relates to Content Visibility topic in the Help. Enter the date and time in the same format as specified in your preferences.
- externalId External ID: string
- id Internal ID: string
- internalId Internal ID: integer (int64)
-
This is the system-assigned internal identifier for the record.
- isInactive Inactive: boolean
-
Mark a category as inactive when you want to prevent it from displaying on the website and also prevent any other activity from occurring with that category. For example, when a category is inactive, it cannot be assigned as a subcategory of another category. You cannot mark a category as inactive if it has subcategories assigned to it. When a category as marked as inactive, it is omitted, by default, from the Commerce Categories list. To include inactive categories in the list, select the Show Inactives box on the categories list page.
- items: commerceCategory-itemsCollection
- lastmodified Last Modified: string (date)
- lastmodifiedby: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- links Links: nsLink
-
nsLink - metadescription Meta Description: string
-
The description you enter here is an important SEO consideration. It is normally the description that is included on search results pages.
- metakeywords Meta Keywords: string
-
This field lets you specify the meta keywords for the page.
- name Name: string
-
Specify the name for this record.
- pagebanner: nsResource
- pageheading Heading: string
-
This heading displays at the top of the category page. The page template must be configured to display the heading.
- pagetitle Page Title: string
-
Enter a title for the page. This value populates the <title> element for an category page.
- primaryparent: commerceCategory
- refName Reference Name: string
- sequencenumber Sequence Number: integer (int64)
-
This number controls the order of how categories are displayed in SMT. If you leave this blank, sequence numbers are assigned automatically based on any manual ordering of categories in SMT.
- sitemappriority: object
-
- id Internal identifier.: string 0.0 , 0.1 , 0.2 , 0.3 , 0.4 , 0.5 , 0.6 , 0.7 , 0.8 , 0.9 , 1.0
- refName Reference Name: string
- startdate Start Date: string (date-time)
-
This identifies the start date and time for the record you are viewing. If this is a future date, the content does not display until that date. This related to the Content Visibility topic in the help. Enter the date and time in the same format as specified in your preferences.
- subcategories: commerceCategory-subcategoriesCollection
- thumbnail: nsResource
- translations: commerceCategory-translationsCollection
- urlfragment URL Fragment: string
-
The URL Fragment lets you specify the section of the URL that can be used to navigate to the category page. If the category is a subcategory, then it is prepended with the URL fragments from all categories in that branch of the hierarchy. Enter the URL with no slashes, for example. For a category of shoes, enter shoes. In turn, the shoes category may be assigned as a subcategory of the category mens. If the mens category has a URL fragment of mens, the full URL to the shoes category page is /mens/shoes. URLs are case sensitive so be consistent with the way you specify URL fragments. Best practice suggests always entering URLs as lower case.
- urlfragmentaliases: commerceCategory-urlfragmentaliasesCollection
- urls: commerceCategory-urlsCollection
- version Version: integer (int64)
commerceCategory-customersegmentsCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: commerceCategory-customersegmentsElement
-
commerceCategory-customersegmentsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
commerceCategory-customersegmentsElement
This record is available as a beta record.
- customerSegmentSize Size: string
- customersegment: nsResource
- links Links: nsLink
-
nsLink - refName Reference Name: string
commerceCategory-itemsCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: commerceCategory-itemsElement
-
commerceCategory-itemsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
commerceCategory-itemsElement
This record is available as a beta record.
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- links Links: nsLink
-
nsLink - primarycategory Primary Category: boolean
- refName Reference Name: string
- sequencenumber Sequence Number: integer (int64)
commerceCategory-subcategoriesCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: commerceCategory-subcategoriesElement
-
commerceCategory-subcategoriesElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
commerceCategory-subcategoriesElement
This record is available as a beta record.
- addtoheadoverride Addition to <head> Override: string
- descriptionoverride Description Override: string
- displayinsiteoverride: object
-
- id Internal identifier.: string , T , F
- refName Reference Name: string
- links Links: nsLink
-
nsLink - metadescriptionoverride Meta Description Override: string
- metakeywordsoverride Meta Keywords Override: string
- nameoverride Name Override: string
- pagebanneroverride: nsResource
- pageheadingoverride Heading Override: string
- pagetitleoverride Title Override: string
- refName Reference Name: string
- sequencenumber Sequence Number: integer (int64)
- sitemappriorityoverride: object
-
- subcategory: commerceCategory
- thumbnailoverride: nsResource
- urlfragmentoverride URL Fragment Override: string
commerceCategory-translationsCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: commerceCategory-translationsElement
-
commerceCategory-translationsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
commerceCategory-translationsElement
This record is available as a beta record.
- addtohead Addition to <head>: string
- description Description: string
- language Language: string
- links Links: nsLink
-
nsLink - locale: object
-
- id Internal identifier.: string
- refName Reference Name: string
- metadescription Meta Description: string
- metakeywords Meta Keywords: string
- name Name: string
- pagebanner: nsResource
- pageheading Heading: string
- pagetitle Page Title: string
- refName Reference Name: string
- thumbnail: nsResource
commerceCategory-urlfragmentaliasesCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: commerceCategory-urlfragmentaliasesElement
-
commerceCategory-urlfragmentaliasesElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
commerceCategory-urlsCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: commerceCategory-urlsElement
-
commerceCategory-urlsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
commerceCategory-urlsElement
This record is available as a beta record.
- actualenddate Actual End Date: string (date-time)
- actualstartdate Actual Start Date: string (date-time)
- catalog: nsResource
- fullurl Full Url: string
- id Internal ID: integer (int64)
- idpath ID Path: string
- isprimary Primary: boolean
- links Links: nsLink
-
nsLink - nestlevel Level: integer (int64)
- parentcategory: commerceCategory
- refName Reference Name: string
commerceCategoryCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: commerceCategory
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
commerceCategory - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
competitor
This record is available as a beta record.
- customForm: object
-
- id Internal identifier.: string -10300
- refName Reference Name: string
- description Description: string
-
Enter a description of this competitor.
- externalId External ID: string
- id Internal ID: string
- isInactive Inactive: boolean
-
Check this box to inactivate this competitor record. Inactive competitors do not appear on sales transactions.
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - name Name: string
-
Enter the name of your competitor here. You will select this name on the Competitors subtab of opportunity records.
- opportunities: competitor-opportunitiesCollection
- productservice Products/Services: string
-
Enter information about the products or services offered by this competitor.
- refName Reference Name: string
- strategy Strategy: string
-
Describe a strategy sales reps can use to win an opportunity over this competitor. Information entered here is only displayed on this record.
- strengths Strengths: string
-
Describe or list the strengths of this competitor. Information entered here is only displayed on this record.
- url Web Address: string
-
Enter the URL of the competitor's Web site.
- weaknesses Weaknesses: string
-
Describe or list the weaknesses of this competitor. Information entered here is only displayed on this record.
competitor-opportunitiesCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: competitor-opportunitiesElement
-
competitor-opportunitiesElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
competitor-opportunitiesElement
This record is available as a beta record.
- links Links: nsLink
-
nsLink - notes Opportunity Notes: string
- opportunity: opportunity
- refName Reference Name: string
- winner Winner: boolean
competitorCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: competitor
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
competitor - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
consolidatedExchangeRate
This record is available as a beta record.
- accountingbook: accountingBook
- averagerate Average Exchange Rate: number (double)
-
This is the average exchange rate. This rate is calculated from a weighted average of the exchange rates for transactions applied during the period to accounts with a general rate type of Average. This rate is used to translate accounts in the income statement and to build retained earnings.
- currentrate Current Exchange Rate: number (double)
-
This is the current exchange rate. Also referred to as ending rate. This rate is based on the currency exchange rate that is effective at the end of the reported upon period. This rate is used for most asset and liability accounts in the balance sheet.
- externalId External ID: string
- fromcurrency: currency
- fromsubsidiary: subsidiary
- historicalrate Historical Exchange Rate: number (double)
-
This is the historical exchange rate. This rate is calculated from a weighted average of the exchange rates for transactions applied during the period to accounts with a general rate type of Historical. This rate is used for equity accounts, or owner's investments, in the balance sheet.
- id Internal ID: string
- isderived Exchange Rate Derived: boolean
-
If this box is checked, the exchange rate is indirect. Indirect rates are rates set between subsidiaries more than one hierarchical level removed from each other, such as a child and grandchild. Indirect rates are always set by the system and cannot be edited or auto calculated by users.
- iseliminationsubsidiary Is Elimination Subsidiary: boolean
-
If this box is checked, the subsidiary associated with this consolidated exchange rate is an elimination subsidiary. You cannot edit the rates for an elimination subsidiary.
- isperiodclosed Period Closed: boolean
-
If this box is checked, the accounting period is closed.
- links Links: nsLink
-
nsLink - periodStartDate Period Start Date: string (date)
-
This is the date on which the accounting period began.
- postingperiod: accountingPeriod
- refName Reference Name: string
- tocurrency: currency
- tosubsidiary: subsidiary
consolidatedExchangeRateCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: consolidatedExchangeRate
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
consolidatedExchangeRate - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
contact
- altEmail Alt. Email: string
-
<p>Enter an alternate email address for this contact. If you use the Capture Email Replies, email sent with the alternate email address are automatically attached to the contact record.
- assistant: contact
- assistantPhone Assist. Phone: string
-
Enter the phone number for this contact's assistant. This number appears only on this record.
- category: contactCategoryCollection
- comments Comments: string
-
Enter any other information you want to note about this contact. These notes appears only on this record. You can enter up to 999 characters of text.
- company: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- contactCampaignEvent: nsResource
- contactSource: nsResource
- contactSourceCampaignCategory: nsResource
- customForm: object
-
- id Internal identifier.: string -10041 , -10040 , -40
- refName Reference Name: string
- dateCreated Date Created: string (date-time)
-
In this field, NetSuite automatically records the date you created this record.
- email Email: string
-
Enter the contact's e-mail address. If you enter an e-mail address, you can e-mail this contact directly from the Contacts list. Also, If you invite this contact to an event, the contact receives e-mail with the event details.
- entityId Entity ID: string
-
NetSuite automatically completes this field as you enter first, middle and last names below. This is how the contact's name appears in all lists.
- externalId External ID: string
- fax Fax: string
-
Enter a fax number for this record. You should enter the fax number exactly as it must be dialed. If a '1' is required to fax to this number, be sure to include it at the beginning of the number. The number you enter automatically appears in the To Be Faxed field of transactions when you select this customer. To fax NetSuite forms, an administrator must first set up fax service at Setup > Set Up Printing, Fax and E-mail > Fax.
- firstName First Name: string
-
Enter the contact's name. What you enter here automatically appears first in the Contact field. This field is required for the Online Bill Pay feature.
- globalSubscriptionStatus: object
-
- id Internal identifier.: string 1 , 2 , 3 , 4
- refName Reference Name: string
- homePhone Home Phone: string
-
Enter the contact's home phone number. This number appears only on this record.
- id Internal ID: string
-
The internal ID for this record is shown here. If you do not want to show internal IDs, clear the Show Internal IDs box at Home > Set Preferences.
- image: nsResource
- isInactive Contact is Inactive: boolean
-
When you check this box, this contact no longer appears on the Contacts list unless you check the Show Inactives box at the bottom of the page. Also, you can no longer select this contact from lists on transactions, company records, task records or events records.
- isPrivate Private: boolean
-
Check this box if this is a private contact. Private contacts can only be viewed by the person that entered the contact record. They are also excluded from the Duplicate Detection process.
- lastModifiedDate Last Modified Date: string (date-time)
- lastName Last Name: string
-
Enter the contact's last name. What you enter here automatically appears last in the Contact field. This field is required for the Online Bill Pay feature.
- links Links: nsLink
-
nsLink - middleName Middle Name: string
-
Enter the contact's middle name or initial. This field is optional. What you enter here automatically appears second in the Contact field.
- mobilePhone Mobile Phone: string
-
Enter the contact's mobile or cell phone number. This number appears only on this record.
- officePhone Office Phone: string
-
Enter the contact's work phone number. This number appears only on this record.
- owner: integer (int64)
- phone Main Phone: string
-
Enter the phone number you primarily use to reach this contact. This number appears in the Contacts list and in the Contact section of company records. This field is required for the Online Bill Pay feature.
- phoneticName Furigana: string
-
Enter the furigana character you want to use to sort this record.
- refName Reference Name: string
- salutation Mr./Ms...: string
-
Enter the contact's salutation. Examples are Mr., Mrs., Ms. and Miss.
- subsidiary: subsidiary
- supervisor: contact
- supervisorPhone Sup. Phone: string
-
Enter the phone number for this contact's supervisor.
- title Job Title: string
-
Enter this contact's title at his or her company. On the record for this contact's company, in the Contacts section, this title appears next to the contacts name.
contactCategory
- externalId External ID: string
- id Internal ID: string
- isInactive Inactive: boolean
-
Check this box to inactivate this contact category.
- links Links: nsLink
-
nsLink - name Contact Category: string
-
Enter the name for this contact category.
- private Private: boolean
-
Check this box if you want to be the only one to use this contact category.
- refName Reference Name: string
contactCategoryCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: contactCategory
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
contactCategory - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
contactCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: contact
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
contact - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
contactRole
- description Description: string
-
Enter a description of this note type.
- externalId External ID: string
- id Internal ID: string
- isInactive Inactive: boolean
-
Check this box to inactivate this contact category.
- links Links: nsLink
-
nsLink - name Role: string
-
Enter the name for this contact category.
- refName Reference Name: string
contactRoleCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: contactRole
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
contactRole - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
costCategory
This record is available as a beta record.
- account: account
- accountrequired: string
- externalId External ID: string
- id Internal ID: string
- isInactive Inactive: boolean
-
Check this box to remove all references to this record from your account. You can reactivate the record at any time.
- itemCostType: object
-
- links Links: nsLink
-
nsLink - longitemtype: string
- name Name: string
-
Enter the name for this record. This name appears in lists that include this record.
- refName Reference Name: string
- tname: string
costCategoryCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: costCategory
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
costCategory - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
couponCode
This record is available as a beta record.
- code Code: string
-
The coupon code that is entered on a sales transaction to apply the promotion. Coupon codes can be multiple-use or single-use. Multiple-use codes can be used any number of times by any number of customers. Each single-use code can only be used in one transaction by a single customer.
- dateSent Date Sent: string (date)
-
This field shows the date the coupon code was sent to the recipient.
- externalId External ID: string
- id Internal ID: string
- links Links: nsLink
-
nsLink - promotion: promotionCode
- recipient: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- refName Reference Name: string
- usecount: string
- used Used: boolean
-
The coupon has been used by the recipient when the Used box is checked.
couponCodeCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: couponCode
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
couponCode - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
creditCardCharge
This record is available as a beta record.
- account: account
- accountingBookDetail: creditCardCharge-accountingBookDetailCollection
- appliedRules: creditCardCharge-appliedRulesCollection
- balance Balance: number (double)
-
NetSuite displays the balance in this account.
- class: classification
- cleared Cleared: boolean
- clearedDate Date Cleared: string (date)
- createdDate Date Created: string (date-time)
- currency: currency
- customForm: object
-
- id Internal identifier.: string -9953
- refName Reference Name: string
- department: department
- entity: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- entityTaxRegNum Vendor Tax Reg. Number: string
- exchangeRate Exchange Rate: number (double)
-
NetSuite displays the currency's exchange rate in this field. You can edit the exchange rate for this transaction only, or you can update the currency record with the exchange rate you enter here.
- excludeFromGLNumbering Exclude from GL Audit Numbering: boolean
- expense: creditCardCharge-expenseCollection
- externalId External ID: string
- id Internal ID: string
- inventorydetailtrantype: string
- item: creditCardCharge-itemCollection
- landedCostMethod: object
-
- id Internal identifier.: string WEIGHT , QUANTITY , VALUE
- refName Reference Name: string
- lastModifiedDate Date Last Modified: string (date-time)
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
-
If you want, type a memo to describe this credit card transaction. It will appear on reports.
- nexus: nexus
- postingPeriod: accountingPeriod
- prevDate Previous Effective Date: string (date)
- refName Reference Name: string
- subsidiary: subsidiary
- subsidiaryTaxRegNum Subsidiary Tax Reg. Number: string
- taxDetails: creditCardCharge-taxDetailsCollection
- taxDetailsOverride Tax Details Override: boolean
-
Check this box to override the tax information on the Tax Details subtab of the transaction. Only roles with at least the Edit level of the Tax Details Tab permission can override the tax details.
- taxPointDate Tax Point Date: string (date)
- taxPointDateOverride Tax Point Date Override: boolean
- taxRegOverride Tax Registration Override: boolean
- taxTotal Tax: number (double)
-
Here, NetSuite enters the total amount of GST based on the line items you enter below.
- total Amount: number (double)
- totalAfterTaxes Total After Taxes: number (double)
- tranDate Date: string (date)
-
NetSuite inserts today's date for the posting date of this credit card transaction. You can type or pick another date. What you enter here determines the date range in which this transaction appears on the Credit Card Register. You can select or enter custom date ranges on registers.
- tranId Reference No.: string
-
If required, type the transaction number from your credit card transaction. The maximum number of characters you can enter in this field is 45.
- userTotal Amount: number (double)
-
You can type the dollar amount of the transaction, but NetSuite updates the amount as you add or edit line items. If you choose Credit, credits appear as positive numbers.
creditCardCharge-accountingBookDetailCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: creditCardCharge-accountingBookDetailElement
-
creditCardCharge-accountingBookDetailElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
creditCardCharge-accountingBookDetailElement
This record is available as a beta record.
- accountingBook: accountingBook
- exchangeRate Exchange Rate: number (double)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- revRecOnRevCommitment Rev Rec on Rev Commit.: boolean
- subsidiary: subsidiary
- tranIsVsoeBundle Transaction Is VSOE Bundle: boolean
creditCardCharge-appliedRulesCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: creditCardCharge-appliedRulesElement
-
creditCardCharge-appliedRulesElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
creditCardCharge-expenseCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: creditCardCharge-expenseElement
-
creditCardCharge-expenseElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
creditCardCharge-expenseElement
This record is available as a beta record.
- account: account
- amount Amount: number (double)
- category: expenseCategory
- class: classification
- customer: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- department: department
- isBillable Billable: boolean
- line Line: integer (int64)
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
- projecttask: projectTask
- refName Reference Name: string
- taxAmount Tax Amount: number (double)
- taxDetailsReference Tax Details Reference: string
creditCardCharge-item-inventoryDetail
This record is available as a beta record.
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- externalId External ID: string
- inventoryassignment: creditCardCharge-item-inventoryDetail-inventoryassignmentCollection
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemDescription Description: string
-
A more complete Description of the item.
- links Links: nsLink
-
nsLink - location: location
- quantity Quantity: number (float)
-
In the Quantity to Build field, enter the number of assembly items you want to build. You cannot enter a quantity that exceeds the amount displayed in the Buildable Quantity field.
- refName Reference Name: string
- toLocation: location
- unit Units: string
-
If the assembly uses Units of Measure, the base units are displayed in the Units field.
creditCardCharge-item-inventoryDetail-inventoryassignmentCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: creditCardCharge-item-inventoryDetail-inventoryassignmentElement
-
creditCardCharge-item-inventoryDetail-inventoryassignmentElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
creditCardCharge-item-inventoryDetail-inventoryassignmentElement
This record is available as a beta record.
- binNumber: bin
- expirationDate Expiration Date: string (date)
- internalId Internal ID: integer (int64)
- inventoryDetail Inventory Detail: integer (int64)
- inventoryStatus: inventoryStatus
- issueInventoryNumber: inventoryNumber
- links Links: nsLink
-
nsLink - packCarton Pack Carton: string
- pickCarton Pick Carton: string
- quantity Quantity: number (float)
- quantityAvailable Unpicked Bin Qty: number (float)
- receiptInventoryNumber Serial/Lot Number: string
- refName Reference Name: string
- secondaryQuantity Secondary Quantity: number (float)
- toBinNumber: bin
- toInventoryStatus: inventoryStatus
creditCardCharge-itemCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: creditCardCharge-itemElement
-
creditCardCharge-itemElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
creditCardCharge-itemElement
This record is available as a beta record.
- amount Amount: number (double)
- billVarianceStatus: object
-
- id Internal identifier.: string NOVARIANCES , JOURNALNOTPOSTED , JOURNALPOSTED
- refName Reference Name: string
- class: classification
- customer: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- department: department
- description Description: string
- initOqpBucket Initial OQP Bucket: string
- inventoryDetail: creditCardCharge-item-inventoryDetail
- isBillable Billable: boolean
- isClosed Closed: boolean
- isOpen Is Opened: boolean
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemSubtype: object
-
- id Internal identifier.: string Sale , Purchase , Resale
- refName Reference Name: string
- itemType: object
-
- job: job
- landedCostCategory: costCategory
- licenseCode License Code: string
- line Transaction Line: integer (int64)
- linked Linked: boolean
- links Links: nsLink
-
nsLink - location: location
- marginal Marginal: boolean
- matrixType Matrix Type: string
- minQty Minimum Quantity: number (float)
- options Options: string
- oqpBucket Oqp Bucket: string
- orderLine Order Line: integer (int64)
- printItems Print Items: boolean
- projecttask: projectTask
- quantity Quantity: number (float)
- rate Rate: number (double)
- rateIncludingTax Rate: number (double)
- rateSchedule Rate Schedule: string
- refName Reference Name: string
- subsidiary: subsidiary
- taxAmount Tax Amount: number (double)
- taxDetailsReference Tax Details Reference: string
- units Units: string
- vendorName Vendor Name: string
creditCardCharge-taxDetailsCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: creditCardCharge-taxDetailsElement
-
creditCardCharge-taxDetailsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
creditCardCharge-taxDetailsElement
This record is available as a beta record.
- calcDetail Details: string
- lineName Name: string
- lineType Line type: string
- links Links: nsLink
-
nsLink - netAmount Net Amount: number (double)
- refName Reference Name: string
- taxAmount Tax Amount: number (double)
- taxBasis Tax Basis: number (double)
- taxCode: salesTaxItem
- taxDetailsReference: object
-
- id Internal identifier.: string
- refName Reference Name: string
- taxRate Tax Rate: number (double)
- taxType Tax Type: string
creditCardChargeCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: creditCardCharge
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
creditCardCharge - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
creditCardRefund
This record is available as a beta record.
- account: account
- accountingBookDetail: creditCardRefund-accountingBookDetailCollection
- appliedRules: creditCardRefund-appliedRulesCollection
- balance Balance: number (double)
-
NetSuite displays the balance in this account.
- class: classification
- cleared Cleared: boolean
- clearedDate Date Cleared: string (date)
- createdDate Date Created: string (date-time)
- currency: currency
- customForm: object
-
- id Internal identifier.: string -9953
- refName Reference Name: string
- department: department
- entity: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- entityTaxRegNum Vendor Tax Reg. Number: string
- exchangeRate Exchange Rate: number (double)
-
NetSuite displays the currency's exchange rate in this field. You can edit the exchange rate for this transaction only, or you can update the currency record with the exchange rate you enter here.
- excludeFromGLNumbering Exclude from GL Audit Numbering: boolean
- expense: creditCardRefund-expenseCollection
- externalId External ID: string
- id Internal ID: string
- inventorydetailtrantype: string
- item: creditCardRefund-itemCollection
- landedCostMethod: object
-
- id Internal identifier.: string WEIGHT , QUANTITY , VALUE
- refName Reference Name: string
- lastModifiedDate Date Last Modified: string (date-time)
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
-
If you want, type a memo to describe this credit card transaction. It will appear on reports.
- nexus: nexus
- postingPeriod: accountingPeriod
- prevDate Previous Effective Date: string (date)
- refName Reference Name: string
- subsidiary: subsidiary
- subsidiaryTaxRegNum Subsidiary Tax Reg. Number: string
- taxDetails: creditCardRefund-taxDetailsCollection
- taxDetailsOverride Tax Details Override: boolean
- taxPointDate Tax Point Date: string (date)
- taxPointDateOverride Tax Point Date Override: boolean
- taxRegOverride Tax Registration Override: boolean
- taxTotal Tax: number (double)
- total Amount: number (double)
- totalAfterTaxes Total After Taxes: number (double)
- tranDate Date: string (date)
-
NetSuite inserts today's date for the posting date of this credit card transaction. You can type or pick another date. What you enter here determines the date range in which this transaction appears on the Credit Card Register. You can select or enter custom date ranges on registers.
- tranId Reference No.: string
-
If required, type the transaction number from your credit card transaction. The maximum number of characters you can enter in this field is 45.
- userTotal Amount: number (double)
-
You can type the dollar amount of the transaction, but NetSuite updates the amount as you add or edit line items. If you choose Credit, credits appear as positive numbers.
creditCardRefund-accountingBookDetailCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: creditCardRefund-accountingBookDetailElement
-
creditCardRefund-accountingBookDetailElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
creditCardRefund-accountingBookDetailElement
This record is available as a beta record.
- accountingBook: accountingBook
- exchangeRate Exchange Rate: number (double)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- revRecOnRevCommitment Rev Rec on Rev Commit.: boolean
- subsidiary: subsidiary
- tranIsVsoeBundle Transaction Is VSOE Bundle: boolean
creditCardRefund-appliedRulesCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: creditCardRefund-appliedRulesElement
-
creditCardRefund-appliedRulesElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
creditCardRefund-expenseCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: creditCardRefund-expenseElement
-
creditCardRefund-expenseElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
creditCardRefund-expenseElement
This record is available as a beta record.
- account: account
- amount Amount: number (double)
- category: expenseCategory
- class: classification
- customer: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- department: department
- isBillable Billable: boolean
- line Line: integer (int64)
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
- projecttask: projectTask
- refName Reference Name: string
- taxAmount Tax Amount: number (double)
- taxDetailsReference Tax Details Reference: string
creditCardRefund-item-inventoryDetail
This record is available as a beta record.
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- externalId External ID: string
- inventoryassignment: creditCardRefund-item-inventoryDetail-inventoryassignmentCollection
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemDescription Description: string
-
A more complete Description of the item.
- links Links: nsLink
-
nsLink - location: location
- quantity Quantity: number (float)
-
In the Quantity to Build field, enter the number of assembly items you want to build. You cannot enter a quantity that exceeds the amount displayed in the Buildable Quantity field.
- refName Reference Name: string
- toLocation: location
- unit Units: string
-
If the assembly uses Units of Measure, the base units are displayed in the Units field.
creditCardRefund-item-inventoryDetail-inventoryassignmentCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: creditCardRefund-item-inventoryDetail-inventoryassignmentElement
-
creditCardRefund-item-inventoryDetail-inventoryassignmentElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
creditCardRefund-item-inventoryDetail-inventoryassignmentElement
This record is available as a beta record.
- binNumber: bin
- expirationDate Expiration Date: string (date)
- internalId Internal ID: integer (int64)
- inventoryDetail Inventory Detail: integer (int64)
- inventoryStatus: inventoryStatus
- issueInventoryNumber: inventoryNumber
- links Links: nsLink
-
nsLink - packCarton Pack Carton: string
- pickCarton Pick Carton: string
- quantity Quantity: number (float)
- quantityAvailable Unpicked Bin Qty: number (float)
- receiptInventoryNumber Serial/Lot Number: string
- refName Reference Name: string
- secondaryQuantity Secondary Quantity: number (float)
- toBinNumber: bin
- toInventoryStatus: inventoryStatus
creditCardRefund-itemCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: creditCardRefund-itemElement
-
creditCardRefund-itemElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
creditCardRefund-itemElement
This record is available as a beta record.
- amount Amount: number (double)
- billVarianceStatus: object
-
- id Internal identifier.: string NOVARIANCES , JOURNALNOTPOSTED , JOURNALPOSTED
- refName Reference Name: string
- class: classification
- customer: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- department: department
- description Description: string
- initOqpBucket Initial OQP Bucket: string
- inventoryDetail: creditCardRefund-item-inventoryDetail
- isBillable Billable: boolean
- isClosed Closed: boolean
- isOpen Is Opened: boolean
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemSubtype: object
-
- id Internal identifier.: string Sale , Purchase , Resale
- refName Reference Name: string
- itemType: object
-
- job: job
- landedCostCategory: costCategory
- licenseCode License Code: string
- line Transaction Line: integer (int64)
- linked Linked: boolean
- links Links: nsLink
-
nsLink - location: location
- marginal Marginal: boolean
- matrixType Matrix Type: string
- minQty Minimum Quantity: number (float)
- options Options: string
- oqpBucket Oqp Bucket: string
- orderLine Order Line: integer (int64)
- printItems Print Items: boolean
- projecttask: projectTask
- quantity Quantity: number (float)
- rate Rate: number (double)
- rateIncludingTax Rate: number (double)
- rateSchedule Rate Schedule: string
- refName Reference Name: string
- subsidiary: subsidiary
- taxAmount Tax Amount: number (double)
- taxDetailsReference Tax Details Reference: string
- units Units: string
- vendorName Vendor Name: string
creditCardRefund-taxDetailsCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: creditCardRefund-taxDetailsElement
-
creditCardRefund-taxDetailsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
creditCardRefund-taxDetailsElement
This record is available as a beta record.
- calcDetail Details: string
- lineName Name: string
- lineType Line type: string
- links Links: nsLink
-
nsLink - netAmount Net Amount: number (double)
- refName Reference Name: string
- taxAmount Tax Amount: number (double)
- taxBasis Tax Basis: number (double)
- taxCode: salesTaxItem
- taxDetailsReference: object
-
- id Internal identifier.: string
- refName Reference Name: string
- taxRate Tax Rate: number (double)
- taxType Tax Type: string
creditCardRefundCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: creditCardRefund
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
creditCardRefund - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
creditMemo
- account: account
- accountingBookDetail: creditMemo-accountingBookDetailCollection
- altHandlingCost Handling Cost: number (double)
-
The handling cost automatically calculates depending on the shipping method you select in the Ship Via field. To change the cost of handling, go to Lists > Shipping Items and select the shipping method with the handling cost you want to change.
- altShippingCost Shipping Cost: number (double)
-
The shipping cost automatically calculates depending on the shipping method you select in the Ship Via field above. To change the cost of a shipping method, go to Lists > Shipping Items and select the shipping method you want to change. If you use UPS Real-Time rates, shipments over 150lbs are broken up into shipments less than or equal to 150lbs for charging.
- amountPaid Amount Paid: number (double)
- amountRemaining Amount Remaining: number (double)
- amountRemainingTotalBox Amount Remaining: number (double)
- applied Applied: number (double)
-
NetSuite displays the amount of credit you applied below.
- appliedRules: creditMemo-appliedRulesCollection
- asOfDate As of Date: string (date)
-
Type an as of date for this customer credit.
- billAddr1 Billing Address Line 1: string
- billAddr2 Billing Address Line 2: string
- billAddr3 Billing Address Line 3: string
- billAddress Bill To: string
-
The default billing address autofills this field from the customer's record at Lists > Relationships > Customers. . To enter a different address: * Select another address in the Bill To Select field. * Select New in the Bill To Select field to enter a new billing address.
- billAddressList: nsResource
- billAddressee Billing Addressee: string
- billAttention Billing Attention: string
- billCity Billing Address City: string
- billCountry: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- billOverride Override: string
- billPhone Billing Phone: string
- billState Billing Address State: string
- billZip Billing Address Zip Code: string
- billingAccount: billingAccount
- billingAddress: creditMemo-billingAddress
- billingAddress_text Billing Address: string
- bulkProcSubmission: nsResource
- class: classification
- contribPct Contribution Percentage: string
- createdDate Date Created: string (date-time)
- createdFrom: nsResource
- currency: currency
- customForm: object
-
- id Internal identifier.: string -9906
- refName Reference Name: string
- defaultILBAShipAddrVal: string
- defaultILBAShippingAddressKey: string
- defaultILShipMethKey Default Shipping Method Key: integer (int64)
- deferredRevenue Deferred Revenue: number (double)
-
Deferred Revenue: amount of revenue deferred on this transaction
- department: department
- discountAmount Discount Amount: number (double)
- discountDate Discount Date: string (date)
- dueDate Due Date: string (date)
- email Email: string
- endDate End Date: string (date)
- entity: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- entityTaxRegNum Customer Tax Reg. Number: string
- estGrossProfit Est. Gross Profit: number (double)
-
Estimated Gross Profit: Read-only field that equals the revenue amount minus the Est. Cost. At the transaction level, it equals the gross profit of all lines, factoring transaction-level discounts and markups.
- estGrossProfitPercent Est. Gross Profit Percent: number (double)
-
Estimated Gross Profit Margin, as a percentage: Read-only field that equals the Est. Gross Profit divided by revenue, expressed as a percentage. At the transaction level, it equals the gross profit percent of all lines, factoring transaction-level discounts and markups.
- exchangeRate Exchange Rate: number (double)
-
The currency's exchange rate is shown in this field. You can edit the exchange rate for this transaction only, or you can update the currency record with the exchange rate you enter here.
- excludeCommission Exclude Commissions: boolean
-
Check this option to exclude this transaction and its subordinate transactions from inclusion in all commission calculations.
- excludeFromGLNumbering Exclude from GL Audit Numbering: boolean
- externalId External ID: string
- handlingCost Handling Cost: number (double)
-
Enter the amount the customer was charged for handling.
- handlingTaxAmount Handling Tax Amount: number (double)
- id Internal ID: string
- intercoStatus: object
-
- id Internal identifier.: string 1 , 2 , 3
- refName Reference Name: string
- intercoTransaction: nsResource
- isMultiShipTo Enable Item Line Shipping: boolean
-
Check this box if you want to allow shipping to more than one address, using alternative shipping methods, for this transaction. Checking this box adds the fields Ship To, Carrier and Ship Via fields to the Item line. Search "Multiple Shipping Routes" in the Help Center for more information.
- item: creditMemo-itemCollection
- job: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- lastModifiedDate Date Last Modified: string (date-time)
- leadSource: nsResource
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
-
If you wish, enter a memo to describe this credit. It will appear on reports such as the 2-line Accounts Receivable register that your customers can see if you give them permission to log in and view their transaction history.
- message Customer Message: string
-
Select a customer message that will appear on the Credit Memo form. To add additional choices to this list, go to Setup > Accounting > Accounting Lists > New > Customer Message.
- messageSel: customerMessage
- nexus: nexus
- originator Originator: string
- otherRefNum PO/Check Number: string
-
For your customers' convenience, you can enter their purchase order number here.
- partner: partner
- partners: creditMemo-partnersCollection
- postingPeriod: accountingPeriod
- prevDate Previous Effective Date: string (date)
- prevPartner Previous Partner: integer (int64)
- prevRep Previous Representative: integer (int64)
- recognizedRevenue Recognized Revenue: number (double)
-
Recognized Revenue: cumulative amount of revenue recognized for this transaction
- recurringBill Recurring Bill: boolean
- refName Reference Name: string
- revCommitStatus Revenue Commitment Status: string
- revCommitStatusDescr Revenue Commitment Status: string
- revRecOnRevCommitment Rev Rec on Rev Commit.: boolean
-
Check this check box to create a Revenue Commitment or Revenue Commitment Reversal. * On a Sales Order, the Revenue Commitment replaces an invoice * On a Return Authorization, the Revenue Commitment Reversal replaces a credit memo. NetSuite creates all applicable Revenue Recognition schedules the Revenue Commitment or Revenue Commitment Reversal.
- revenueStatus Revenue Status: string
-
The possible values for this field are: 1. Pending: indicates that no recognition has occurred. All revenue is still deferred. 2. In Progress: indicates that some recognition has occurred. 3. Completed: indicates that all recognition has occurred. No deferred revenue remains.
- revenueStatusDescr Revenue Status: string
- salesEffectiveDate Sales Effective Date: string (date)
-
You can change the sales effective date for this transaction. The sales effective date determines which commission plan and historical sales team this transaction applies to. If this credit memo is created from a return authorization, the sales effective date from the return shown in the Created From field is set by default for this credit memo.
- salesRep: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- salesReturn Sales Return: string
- salesTeam: creditMemo-salesTeamCollection
- shipAddress Ship To: string
- shipAddressList: nsResource
- shipDate Ship Date: string (date)
- shipGroup: creditMemo-shipGroupCollection
- shipIsResidential Shipping address is residential: boolean
- shipMethod: shipItem
- shipOverride Override: boolean
- shippingAddress: creditMemo-shippingAddress
- shippingAddress_text Shipping Address: string
- shippingCost Shipping Cost: number (double)
-
Enter the amount the customer was charged for shipping.
- shippingCostOverridden Shipping Cost Overridden: boolean
- shippingTaxAmount Shipping Tax Amount: number (double)
- source: object
-
- startDate Start Date: string (date)
- status: object
-
- id Internal identifier.: string A , B , V
- refName Reference Name: string
- storeOrder: string
- subsidiary: subsidiary
- subsidiaryTaxRegNum Subsidiary Tax Reg. Number: string
-
This field shows the tax registration number of the transaction nexus. NetSuite automatically populates this field based on the nexus lookup logic. You can override the transaction nexus and tax registration number that NetSuite automatically selects by checking the Nexus Override box. When you select a different tax registration number in the dropdown list, the corresponding nexus is automatically selected in the Nexus field.
- subtotal Subtotal: number (double)
-
This field shows the total of the items on this credit memo. This is the total before any discounts, shipping cost, handling cost or tax is added to the order.
- taxDetails: creditMemo-taxDetailsCollection
- taxDetailsOverride Tax Details Override: boolean
-
Check this box to override the tax information on the Tax Details subtab of the transaction. Only roles with at least the Edit level of the Tax Details Tab permission can override the tax details.
- taxPointDate Tax Point Date: string (date)
- taxPointDateOverride Tax Point Date Override: boolean
- taxRegOverride Tax Registration Override: boolean
-
Check this box to override the values in the Nexus and Subsidiary Tax Reg. Number fields. Only roles with at least the Edit level of the Tax Details Tab permission can override the values that NetSuite automatically selects in these fields.
- taxTotal Tax: number (double)
-
NetSuite multiplies the tax rate by the taxable total of line items and enters it here.
- terms: term
- toBeEmailed To Be Emailed: boolean
-
Check this box if you want to e-mail this credit memo. Then enter the e-mail address in the space to the right of the check box. If you don't check this box, the credit memo won't be e-mailed. You can enter multiple e-mail addresses separated by a semicolon with no spaces.
- toBeFaxed To Be Faxed: boolean
-
Check this box if you want to fax this credit memo. Enter the fax number in the space to the right of the check box if it doesn't already appear. To fax NetSuite forms, an administrator must first set up fax service at Setup > Company > Printing, Fax and Email Preferences.
- toBePrinted To Be Printed: boolean
-
Check this box if you wish to save this in a queue of credit memos to print. Otherwise, you can click Print below to submit and print this credit memo at once.
- total Total: number (double)
-
NetSuite computes the total of line items and tax and then enters it here.
- totalAfterTaxes Total After Taxes: number (double)
- totalCostEstimate Est. Cost: number (double)
-
Estimated Cost: Estimated cost of the specific number of items; estimated rate x quantity = estimated cost.
- tranDate Date: string (date)
-
NetSuite inserts today's date as the date of this order. You can type or pick another date.
- tranId Credit #: string
-
NetSuite increases the largest credit memo number by one. If you wish, you can type another number. The next credit memo number will revert to the standard pattern. You can enter a maximum of 45 characters in this field.
- tranIsVsoeBundle Transaction Is VSOE Bundle: boolean
-
Check this box to include all items added to this transaction as a VSOE bundle.
- unapplied Unapplied: number (double)
-
NetSuite displays the remaining amount of credit to be applied.
- vsoeAutoCalc Auto Calculate VSOE Allocation: boolean
-
The VSOE allocation amount can be calculated automatically by checking the Auto Calculate VSOE Allocation box. Allocation is the process to determine the VSOE price for items. The total VSOE amount allocated is the revenue amount to be recognized for the bundle.
- webSite: string
- whichChargesToAdd: object
-
- id Internal identifier.: string , ALL , TRANSACTION_DATE , AS_OF_DATE
- refName Reference Name: string
creditMemo-accountingBookDetailCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: creditMemo-accountingBookDetailElement
-
creditMemo-accountingBookDetailElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
creditMemo-accountingBookDetailElement
- accountingBook: accountingBook
- exchangeRate Exchange Rate: number (double)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- revRecOnRevCommitment Rev Rec on Rev Commit.: boolean
- subsidiary: subsidiary
- tranIsVsoeBundle Transaction Is VSOE Bundle: boolean
creditMemo-appliedRulesCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: creditMemo-appliedRulesElement
-
creditMemo-appliedRulesElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
creditMemo-billingAddress
- addr1 Address 1: string
-
Enter the address the way it should appear on forms. For employees, customers, partners, and vendors, what you enter here autofills on forms if this address is marked default for Shipping or Billing. Enter up to 50 characters. This field is required for the Online Bill Pay feature.
- addr2 Address 2: string
-
Enter an optional second address line the way it should appear on forms. For employees, customers, partners, and vendors, what you enter here autofills on forms if this address is marked default for Shipping or Billing. Enter up to 50 characters.
- addr3 Address 3: string
- addrPhone Phone: string
-
Enter the phone number.
- addrText Address: string
-
The values entered in the other address fields are displayed here.
- addressee Addressee: string
-
Enter the name of the entity that should appear on the shipping label here. This name appears on the shipping label below what you enter in the Attention field.
- attention Attention: string
-
Enter the name of the person to whom a shipment is addressed, as it should appear on shipping labels. This field is required for UPS Integration.
- city City: string
-
Enter the city the way it should appear on all forms except checks.
- country: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- externalId External ID: string
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - override Override: boolean
-
Check this box to disable the free-form address text field. When this field is disabled, text entered in the other address fields does not display in the Address text field. Clear this box to allow text entered in the address component fields to appear in the free-form address text field.
- refName Reference Name: string
- state State/Province: string
-
Enter your company's state or province the way it should appear on all forms except checks.
- zip Zip: string
-
Enter the postal code the way it should appear on all forms except checks.
creditMemo-item-inventoryDetail
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- externalId External ID: string
- inventoryassignment: creditMemo-item-inventoryDetail-inventoryassignmentCollection
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemDescription Description: string
-
A more complete Description of the item.
- links Links: nsLink
-
nsLink - location: location
- quantity Quantity: number (float)
-
In the Quantity to Build field, enter the number of assembly items you want to build. You cannot enter a quantity that exceeds the amount displayed in the Buildable Quantity field.
- refName Reference Name: string
- toLocation: location
- unit Units: string
-
If the assembly uses Units of Measure, the base units are displayed in the Units field.
creditMemo-item-inventoryDetail-inventoryassignmentCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: creditMemo-item-inventoryDetail-inventoryassignmentElement
-
creditMemo-item-inventoryDetail-inventoryassignmentElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
creditMemo-item-inventoryDetail-inventoryassignmentElement
- binNumber: bin
- expirationDate Expiration Date: string (date)
- internalId Internal ID: integer (int64)
- inventoryDetail Inventory Detail: integer (int64)
- inventoryStatus: inventoryStatus
- issueInventoryNumber: inventoryNumber
- links Links: nsLink
-
nsLink - packCarton Pack Carton: string
- pickCarton Pick Carton: string
- quantity Quantity: number (float)
- quantityAvailable Unpicked Bin Qty: number (float)
- receiptInventoryNumber Serial/Lot Number: string
- refName Reference Name: string
- secondaryQuantity Secondary Quantity: number (float)
- toBinNumber: bin
- toInventoryStatus: inventoryStatus
creditMemo-itemCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: creditMemo-itemElement
-
creditMemo-itemElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
creditMemo-itemElement
- account: account
- amount Amount: number (double)
- catchUpPeriod: accountingPeriod
- chargeType: nsResource
- class: classification
- costEstimate Est. Cost: number (double)
- costEstimateRate Est. Rate: number (double)
- costEstimateType: object
-
- id Internal identifier.: string PREFVENDORRATE , AVGCOST , PURCHORDERRATE , LASTPURCHPRICE , MEMBERDEFINED , CUSTOM , ITEMDEFINED , PURCHPRICE
- refName Reference Name: string
- deferRevRec Deferred Revenue: boolean
- department: department
- description Description: string
- doNotCreateRevenueElement Do Not Create Revenue Element: boolean
- estGrossProfit Est. Gross Profit: number (double)
- estGrossProfitPercent Est. Gross Profit Percent: number (double)
- giftCertFrom From: string
- giftCertMessage Gift Message: string
- giftCertNumber Code: string
- giftCertRecipientEmail Recipient Email: string
- giftCertRecipientName Recipient Name: string
- initOqpBucket Initial OQP Bucket: string
- inventoryDetail: creditMemo-item-inventoryDetail
- isClosed Closed: boolean
- isDropShipment Drop Shipment: boolean
- isOpen Is Opened: boolean
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemSubtype: object
-
- id Internal identifier.: string Sale , Purchase , Resale
- refName Reference Name: string
- itemType: object
-
- job: job
- licenseCode License Code: string
- line Transaction Line: integer (int64)
- linked Linked: boolean
- links Links: nsLink
-
nsLink - location: location
- marginal Marginal: boolean
- matrixType Matrix Type: string
- minQty Minimum Quantity: number (float)
- options Options: string
- oqpBucket Oqp Bucket: string
- orderDoc: nsResource
- orderLine Order Line: integer (int64)
- price: priceLevel
- printItems Print Items: boolean
- processedByRevCommit Processed by Rev Commit: boolean
- quantity Quantity: number (float)
- quantityAllocated Quantity Allocated: number (float)
- quantityAvailable Available: number (float)
- quantityCommitted Committed: number (float)
- quantityDemandAllocated Allocated Demand: number (float)
- quantityOnHand On Hand: number (float)
- rate Rate: number (double)
- rateIncludingTax Rate: number (double)
- rateSchedule Rate Schedule: string
- refName Reference Name: string
- revRecEndDate Rev. Rec. End Date: string (date)
- revRecSchedule: revRecSchedule
- revRecStartDate Rev. Rec. Start Date: string (date)
- revrec_recurrencetype Rev Rec Recurrence Type: string
- shipAddress: nsResource
- shipCarrier: object
-
- id Internal identifier.: string ups , nonups
- refName Reference Name: string
- shipMethod: shipItem
- subscription: subscription
- subscriptionLine: subscriptionLine
- subsidiary: subsidiary
- taxAmount Tax Amount: number (double)
- taxDetailsReference Tax Details Reference: string
- units Units: string
- vsoeAllocation Allocation Amount: number (double)
- vsoeAmount Calculated Amount: number (double)
- vsoeDeferral: object
-
- id Internal identifier.: string DEFERALLUNTIL , DEFERUNTIL
- refName Reference Name: string
- vsoeDelivered Delivered: boolean
- vsoeIsEstimate Estimate: boolean
- vsoePermitDiscount: object
-
- id Internal identifier.: string IFDELIVERED , NEVER
- refName Reference Name: string
- vsoePrice Allocation Price: number (double)
- vsoeSOPGroup: object
-
- id Internal identifier.: string EXCLUDE , NORMAL , SOFTWARE
- refName Reference Name: string
creditMemo-partnersCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: creditMemo-partnersElement
-
creditMemo-partnersElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
creditMemo-partnersElement
- contribution Contribution %: number (double)
- isPrimary Primary: boolean
- links Links: nsLink
-
nsLink - partner: partner
- partnerRole: partnerCategory
- refName Reference Name: string
creditMemo-salesTeamCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: creditMemo-salesTeamElement
-
creditMemo-salesTeamElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
creditMemo-shipGroupCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: creditMemo-shipGroupElement
-
creditMemo-shipGroupElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
creditMemo-shipGroupElement
- destinationAddress Ship To: string
- handlingRate Handling Rate: number (double)
- id ID: integer (int64)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- shippingMethod Ship Via: string
- shippingRate Shipping Rate: number (double)
- sourceAddress Ship From: string
- uniqueKey Unique Key: integer (int64)
- weight Weight: number (float)
creditMemo-shippingAddress
- addr1 Address 1: string
-
Enter the address the way it should appear on forms. For employees, customers, partners, and vendors, what you enter here autofills on forms if this address is marked default for Shipping or Billing. Enter up to 50 characters. This field is required for the Online Bill Pay feature.
- addr2 Address 2: string
-
Enter an optional second address line the way it should appear on forms. For employees, customers, partners, and vendors, what you enter here autofills on forms if this address is marked default for Shipping or Billing. Enter up to 50 characters.
- addr3 Address 3: string
- addrPhone Phone: string
-
Enter the phone number.
- addrText Address: string
-
The values entered in the other address fields are displayed here.
- addressee Addressee: string
-
Enter the name of the entity that should appear on the shipping label here. This name appears on the shipping label below what you enter in the Attention field.
- attention Attention: string
-
Enter the name of the person to whom a shipment is addressed, as it should appear on shipping labels. This field is required for UPS Integration.
- city City: string
-
Enter the city the way it should appear on all forms except checks.
- country: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- externalId External ID: string
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - override Override: boolean
-
Check this box to disable the free-form address text field. When this field is disabled, text entered in the other address fields does not display in the Address text field. Clear this box to allow text entered in the address component fields to appear in the free-form address text field.
- refName Reference Name: string
- state State/Province: string
-
Enter your company's state or province the way it should appear on all forms except checks.
- zip Zip: string
-
Enter the postal code the way it should appear on all forms except checks.
creditMemo-taxDetailsCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: creditMemo-taxDetailsElement
-
creditMemo-taxDetailsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
creditMemo-taxDetailsElement
- calcDetail Details: string
- lineName Name: string
- lineType Line type: string
- links Links: nsLink
-
nsLink - netAmount Net Amount: number (double)
- refName Reference Name: string
- taxAmount Tax Amount: number (double)
- taxBasis Tax Basis: number (double)
- taxCode: salesTaxItem
- taxDetailsReference: object
-
- id Internal identifier.: string
- refName Reference Name: string
- taxRate Tax Rate: number (double)
- taxType Tax Type: string
creditMemoCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: creditMemo
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
creditMemo - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
currency
This record is available as a beta record.
- currencyPrecision Currency Precision: integer (int64)
-
Displays the precision of the currency, which designates the number of digits to the right of the decimal point used in currency transactions. Precision can be zero or two. The level of decimal precision indicated is used for inventory costing calculations to maintains consistency between inventory costing and reporting. Values in report results are rounded to the base currency precision. This rounding applies to currency values and non-currency values, including formula column values. To change this read-only field to a dropdown list through which you can change the precision from zero or two, contact NetSuite Technical Support.
- displaySymbol Symbol: string
-
Enter the currency symbol and text to use for this currency. Include spaces if you want to separate the symbol from the currency value. For example, $ USD or $CAD.
- exchangeRate Default Exchange Rate: number (double)
-
Enter an exchange rate for this currency against the base currency of this company, or if you use OneWorld, for this currency against the base currency of the root parent subsidiary. The exchange rate is equal to the base currency amount divided by the foreign currency amount. For example, if your company is located in Canada (base currency) and you are defining the U.S. dollar (foreign currency), and the current exchange rate is 1.02 Canadian dollars to 1.00 U.S. dollar, the Default Exchange Rate for the U.S. dollar is 1.02/1.00, or 1.02. This rate is the basis for rates in the Currency Exchange Rates table that are used in foreign currency transactions. If you use OneWorld, this rate also is the basis for rates in the Consolidated Exchange Rates table that are used in consolidated financials. For more information, see the help topic Currency Exchange Rates.
- externalId External ID: string
- formatSample Format Sample: string
-
This field displays a sample of how currency amounts display for the selected format. The decimal precision shown cannot be changed. Note: The decimal precision shown is the precision used for both inventory reporting and for costing calculations.
- fxRateUpdateTimezone: object
-
- id Internal identifier.: string 1 , 2 , 3 , 4
- refName Reference Name: string
- id Internal ID: string
- includeInFxRateUpdates Automatic Update: boolean
-
Check this box to update currency exchange rates daily.
- isAnchorCurrency Is Anchor Currency: boolean
-
A check in this box indicates that the currency has been selected as an anchor currency in the accounting preferences. To clear the box, change the selection in the accounting preference under Use Triangulation Calculation by NetSuite. If this currency is a designated anchor currency and has been used in an exchange rate calculation, you cannot delete this currency. For more information about triangulation and anchor currencies, see the help topics Methods for Obtaining Exchange Rates andAnchor Currencies.
- isBaseCurrency Is Base Currency: boolean
-
Indicates that this currency is the company's base currency or in OneWorld accounts, the base currency for a subsidiary. Note: After you have entered transactions in foreign currencies, you cannot change a base currency.
- isInactive Inactive: boolean
-
Check this box to make the currency record is inactive, or clear it to make the record active. You cannot make a currency inactive if any open transactions exist in that currency.
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - locale: object
-
- id Internal identifier.: string it_CH , en_TC , af_ZA , es_EA , es_EC , pt_BR , en_CY , fr_LU , nl_AN , es_UY , en_TT , es_ES , pt_ST , en_DM , en_TZ , es_ES_EURO , fr_ML , de_DE_onLQA , es_VE , nl_BE , da_DK , pt_AO , to_TO , en_UG , am_ET , ss_SZ , nl_BQ , ar , pt_AW , ko_KR , en_US , fr_BE_EURO , ko_KP , si_AQ , fr_MG , el_GR , be_BY , en_AU , he_IL , en_AW , es_SV , en_BB , ar_YE , es_CO , es_CL , en_BM , es_CR , pa_IN , en_SC , en_BS , sm_WS , it_IT_EURO , fr_KM , es_CU , en_SB , en_SG , en_BW , en_SH , en_BZ , en_SL , az_AZ , fi_FI , en_SS , sr_YU , en_CD , en_CA , ka_GE , lv_LV , uk_UA , es_DO , ur_PK , ar_IQ , fr_LU_EURO , pt_PT , fr_FR_EURO , en_PH , th_TH , bn_BD , si_LK , en_PG , hu_HU , ar_SA , ar_SD , ru_KZ , ar_BH , nl_BE_EURO , ro_MD , en_QA , ru_KG , es_AR , ta_IN , sr_RS , aa_ER , en , de_DE_EURO , zh_MO , en_AE , ar_SY , es_BO , en_AI , no_NO , en_AG , nl_SR , fr_VU , en_MW , gu_AQ , ar_TN , nl_SX , hi_IN , en_NA , mn_MN , en_NG , fr_FR , ms_MY , nl_CW , uz_UZ , ar_DJ , sr_CS , de_AT_EURO , en_NZ , es_PE , es_PA , fa_IR , ar_DZ , fr_GN , lb_LU , xx_US , pt_CV , sh_RS , ht_HT , fr_WF , es_AR_onLQA , es_PR , ar_EG , es_PY , fr_GA , en_KW , de_AT , ro_RO , en_KY , fr_FR_onLQA , fr_DJ , ca_ES_EURO , cs_CZ , en_LC , pl_AQ , fr_TD , fr_TG , es_MX , sv_AX , sk_SK , en_LR , en_LS , ar_OM , dz_BT , te_IN , de_LU_EURO , sq_AL , sv_SE , sn_ZW , es_NI , en_IE_EURO , my_MM , en_MF , en_MU , it_IT , pl_PL , fr_BE , fr_BF , tr_TR , fr_BI , fr_BJ , id_ID , fr_RW , en_ZM , km_KH , ja_JP , de_DE , fr_BL , tg_TJ , ar_QA , de_CH , zh_HK , pt_PT_EURO , en_JO , en_JM , fr_CA , nl_NL_EURO , fr_CF , fr_CG , fr_CD , pa_AQ , fr_CH , xx_US_wthId , fr_CI , pt_GW , vi_VN , ru_MD , fr_CM , fr_SC , en_KE , ne_NP , bs_BA , sl_SI , en_KN , fr_SN , ar_AE , en_GY , tl_PH , ca_ES , es_IC , lo_LA , kn_IN , so_SO , fr_PF , ar_JO , nl_NL , is_IS , fi_FI_EURO , pt_MZ , sk_SK_EURO , sl_SI_EURO , en_IE , ms_BN , hr_HR , ar_KW , de_LU , lt_LT , en_IN , ps_AF , en_ZA , en_VC , ru_RU , sh_YU , ar_LB , mr_IN , dv_MV , fj_FJ , zh_TW , tk_TM , ar_LY , en_VU , fr_NE , en_FK , es_GT , fr_NC , es_GQ , fa_AF , bg_BG , hy_AM , en_CY_EURO , mk_MK , ar_MA , en_GD , en_GB , es_HN , gu_IN , en_GH , et_EE , en_GI , zh_CN , en_GM , ar_MR
- refName Reference Name: string
- name Name: string
-
Enter a unique name for the currency. Because many countries use the same name for their currencies, you should use a combined name that includes the country name or abbreviation as well as the name of the currency. For example, pesos are the currency in the Philippines, Uruguay, and Mexico. In the Name field, you might enter “Mexican peso.” This name appears in the Currency field on records and transactions.
- overrideCurrencyFormat Override Currency Format: boolean
-
Check this box to customize the currency format.
- refName Reference Name: string
- symbol ISO Code: string
-
Enter the three-letter International Standards Organization (ISO) code for this currency. For example, you would use PHP for Philippines pesos, UYU for Uruguayan pesos, and MXN for Mexican pesos.
- symbolPlacement: object
-
- id Internal identifier.: string 1 , 2
- refName Reference Name: string
currencyCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: currency
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
currency - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
customer
- accountNumber Account: string
-
If you assign accounts to your customers, enter an account number for this customer here.
- addressBook: customer-addressBookCollection
- aging Current: number (double)
-
The overdue A/R balance is shown here with the balance totals for each aging period.
- aging1 1-30 Days: number (double)
-
The overdue A/R balance is shown here with the balance totals for each aging period.
- aging2 31-60 Days: number (double)
-
The overdue A/R balance is shown here with the balance totals for each aging period.
- aging3 61-90 Days: number (double)
-
The overdue A/R balance is shown here with the balance totals for each aging period.
- aging4 Over 90 Days: number (double)
-
The overdue A/R balance is shown here with the balance totals for each aging period.
- alcoholRecipientType: object
-
- id Internal identifier.: string CONSUMER , LICENSEE
- refName Reference Name: string
- altEmail Alt. Email: string
-
Enter an alternate email address for this customer. If you use the Capture Email Replies, email sent with the alternate email address are automatically attached to the customer record.
- altPhone Alt. Phone: string
-
If applicable, enter an alternate phone number for this record.
- assignedWebSite: webSite
- autoName Auto: boolean
-
Clear this box to manually enter a name for this record. If you leave this box marked, NetSuite assigns a name or number for this record based on your settings at Setup > Set Up Auto-Generated Numbers.
- balance Balance: number (double)
-
The customer's current accounts receivable balance due appears here. If you use the Multiple Currencies feature, the amount in this field is shown in the customer's currency.
- billingRateCard: billingRateCard
- billingSchedule: billingSchedule
- billingTransactionForm: object
-
- id Internal identifier.: string 88 , 89 , -9960 , 90 , 91 , -9965 , 92 , -9966 , 93 , -9967 , 94 , -9968 , 95 , -9961 , 96 , -9962 , 97 , 98 , 10 , -9964 , 99 , 11 , 12 , 13 , 14 , 18 , 1 , -9970 , -9971 , -9976 , -9977 , -9978 , -9979 , -9972 , 20 , -9974 , 21 , -9975 , -9907 , 22 , -9908 , 23 , -9909 , 24 , -9903 , -9904 , -9905 , 28 , -9906 , -9980 , -9981 , -9982 , -9987 , -9988 , -9989 , -9901 , -9902 , -9983 , 30 , -9984 , -9985 , -9986 , -9918 , -9919 , 35 , 36 , -9914 , -9915 , 39 , -9916 , -9917 , -9990 , -9991 , -9992 , -9993 , -9910 , -9998 , -9999 , -9911 , -9912 , -9913 , 40 , -9994 , 41 , -9995 , -9996 , -9997 , 44 , -9929 , 45 , 46 , 47 , -9925 , 48 , -9926 , 49 , -9927 , -9928 , -9921 , -9922 , -9923 , -9924 , 50 , 52 , -9920 , 55 , 56 , 57 , 58 , 59 , -9936 , -9938 , -9939 , -9892 , -9893 , -9894 , -9932 , -9899 , -9933 , 60 , -9934 , 61 , -9935 , 62 , -9895 , 63 , -9896 , 64 , -9930 , -9931 , -9898 , 66 , 67 , 68 , 69 , -9947 , -9948 , -9943 , 70 , -9944 , 71 , -9945 , 72 , -9946 , 73 , 74 , -9940 , 75 , -9941 , 76 , -9942 , 77 , 78 , 79 , -9958 , -9959 , -9954 , 80 , -9955 , 81 , -9956 , 82 , 83 , -9957 , -9950 , 84 , -9951 , 85 , -9952 , 86 , -9953 , 87
- refName Reference Name: string
- billingTransactionType: object
-
- id Internal identifier.: string CashSale , CustInvc
- refName Reference Name: string
- buyingReason: nsResource
- buyingTimeFrame: nsResource
- campaignCategory: nsResource
- campaignEvent: nsResource
- campaigns: customer-campaignsCollection
- category: customerCategory
- clickStream Click-Stream (1st Visit): string
-
This field lists the pages this customer visited on his or her first visit to your Web site in chronological order.
- comments Comments: string
-
Enter any other information you wish to track for this customer.
- companyName Company Name: string
-
Enter the legal name of the customer. If you use Auto-Generated Numbering, it is important that you enter the customer's name here, as the Customer Name field fills with the number or code for this record.
- consolAging Consolidated Current: number (double)
-
The overdue consolidated A/R balance is shown here with the balance totals for each aging period. These totals include the balance from all the customers and subcustomers in this hierarchy.
- consolAging1 1-30 Days: number (double)
-
The overdue consolidated A/R balance is shown here with the balance totals for each aging period. These totals include the balance from all the customers and subcustomers in this hierarchy.
- consolAging2 31-60 Days: number (double)
-
The overdue consolidated A/R balance is shown here with the balance totals for each aging period. These totals include the balance from all the customers and subcustomers in this hierarchy.
- consolAging3 61-90 Days: number (double)
-
The overdue consolidated A/R balance is shown here with the balance totals for each aging period. These totals include the balance from all the customers and subcustomers in this hierarchy.
- consolAging4 Over 90 Days: number (double)
-
The overdue consolidated A/R balance is shown here with the balance totals for each aging period. These totals include the balance from all the customers and subcustomers in this hierarchy.
- consolBalance Consolidated: number (double)
-
The current accounts receivable balance due for the customer-subcustomer hierarchy this customer is a part of is shown here.
- consolDaysOverdue Consolidated: integer (int64)
-
This field shows the number of days overdue the consolidated overdue balance is.
- consolDepositBalance Consolidated: number (double)
-
This field displays the total amount of unapplied deposits for the customer-subcustomer hierarchy this customer is a member of. Deposits are recorded in the general ledger, as a liability, when the customer makes an advance payment before delivery of goods or services. A deposit balance exists until the goods or services are delivered. Deposits do not affect the customer's accounts receivable balance.
- consolOverdueBalance Consolidated: number (double)
-
This field shows the consolidated total owed for open transactions for this customer-subcustomer hierarchy that are past their due date based on the invoice terms. Note: For open transactions that do not have a due date, the transaction date is used as the due date to calculate this total.
- consolUnbilledOrders Consolidated: number (double)
-
This field displays the total amount of orders that have been entered but not yet billed for the customer-subcustomer hierarchy this customer is a part of. If you have enabled the preference Customer Credit Limit Includes Orders, then this total is included in credit limit calculations. Set this preference at Setup > Accounting > Preferences > Accounting Preferences > General.
- contact: contact
- contactList: contactCollection
- contactRoles: customer-contactRolesCollection
- contribPct Contribution Percentage: string
- creditHoldOverride: object
-
- id Internal identifier.: string AUTO , OFF , ON
- refName Reference Name: string
- creditLimit Credit Limit: number (double)
-
Enter a credit limit to define the maximum currency amount the customer is allowed to accrue in outstanding receivables. When you meet or exceed this customer's limit while you are entering transactions, NetSuite can warn you or block the transaction. To set preferences for credit limit handling, an administrator must go to Setup > Accounting > Accounting Preferences > General > Customer Credit Limit Handling. For more information, click Help at the top of the page and search for Customer Credit Limits and Holds.
- currency: currency
- currencyList: customer-currencyListCollection
- customForm: object
-
- id Internal identifier.: string -10002 , -2 , -10005 , -8 , -10004 , -10008
- refName Reference Name: string
- dateCreated Date Created: string (date-time)
-
In this field, NetSuite automatically records the date you created this record.
- daysOverdue Days: integer (int64)
-
The number of days overdue this balance is overdue is shown here.
- defaultAddress Default Address: string
-
This field automatically shows the default billing address that you enter and add using the Address subtab.
- defaultAllocationStrategy: nsResource
- defaultBankAccount: account
- defaultOrderPriority Default Order Priority: number (float)
-
Enter a number to designate the priority for this customer.
- defaultShippingAddress Default Shipping Address: string
- defaultTaxReg Default Tax Reg. Number: string
-
Select the default tax registration number for this entity.
- depositBalance Deposit Balance: number (double)
-
The Customer Deposit Balance field displays the total amount of unapplied deposits for the customer. Deposits are recorded in the general ledger, as a liability, when the customer makes an advance payment before delivery of goods or services. A deposit balance exists until the goods or services are delivered. Deposits do not affect the customer's accounts receivable balance. If you use the Multiple Currencies feature, the amount in this field is shown in the customer's currency.
- displaySymbol Currency Symbol: string
-
Enter a currency symbol and text to use for this currency. Include spaces if you want to separate the symbol from the currency value. For example, $ USD or $CAD. Use the Symbol Placement field to select where the symbol appears.
- drAccount: account
- email Email: string
-
Enter your customer's email address. If you allow your customers to access their accounts online, this becomes part of their access codes.
- emailPreference: object
-
- id Internal identifier.: string PDF , HTML , DEFAULT
- refName Reference Name: string
- emailTransactions Email Transactions: boolean
-
Set a preferred transaction delivery method for this customer. Choose to send transactions by regular mail, by email, by fax, or by a combination of the three. Then, when you select the customer on a transaction, their preferred delivery method is marked by default. * Email – Check this box to check the To Be Emailed box by default on transactions when this customer is selected. * Print – Check this box to check the To Be Printed box by default on transactions when this customer is selected. * Fax – Check this box to check the To Be Faxed box by default on transactions when this customer is selected. Once you enter these settings on the customer record, these boxes are checked by default for transactions created from the customer record or for transactions that are copied or converted. Note: These settings override any customized settings on transaction forms you use. There are also preferences to set default values for new customer records at Setup > Company > Preferences > Printing, Fax,& Email Preferences. On the Print subtab, Fax subtab, or Email subtab, check Customers Default to [Print/Fax/Email] Transactions. You can also set these fields using the Mass Update function. Go to Lists > Mass Updates > Mass Updates > General and click Customer.
- endDate End Date: string (date)
-
If you have a contract with this customer, enter the end date here. If you are entering a job record, enter the projected end date of the job here.
- entityId Entity ID: string
-
Enter the name of this customer, prospect or lead the way it should appear in all lists and on the Pay to the Order of line of checks. If you use Auto-Generated Numbering, the customer number or code fills here. Enter the customer name in the Company Name field.
- entityStatus: customerStatus
- estimatedBudget Estimated Budget: number (double)
-
Enter the estimated budget the prospect or customer has for this opportunity.
- externalId External ID: string
- fax Fax: string
-
Enter a fax number for this record. You should enter the fax number exactly as it must be dialed. If a '1' is required to fax to this number, be sure to include it at the beginning of the number. The number you enter automatically appears in the To Be Faxed field of transactions when you select this customer. To fax NetSuite forms, an administrator must first set up fax service at Setup > Set Up Printing, Fax and E-mail > Fax.
- faxTransactions Fax Transactions: boolean
-
Set a preferred transaction delivery method for this customer. Choose to send transactions by regular mail, by email, by fax, or by a combination of the three. Then, when you select the customer on a transaction, their preferred delivery method is marked by default. * Email – Check this box to check the To Be Emailed box by default on transactions when this customer is selected. * Print – Check this box to check the To Be Printed box by default on transactions when this customer is selected. * Fax – Check this box to check the To Be Faxed box by default on transactions when this customer is selected. Once you enter these settings on the customer record, these boxes are checked by default for transactions created from the customer record or for transactions that are copied or converted. Note: These settings override any customized settings on transaction forms you use. There are also preferences to set default values for new customer records at Setup > Company > Preferences > Printing, Fax,& Email Preferences. On the Print subtab, Fax subtab, or Email subtab, check Customers Default to [Print/Fax/Email] Transactions. You can also set these fields using the Mass Update function. Go to Lists > Mass Updates > Mass Updates > General and click Customer.
- firstName First Name: string
-
Enter this customer's name.
- firstOrderDate First Sales Order Date: string (date)
- firstSaleDate First Sale Date: string (date)
- firstVisit First Visit: string (date-time)
-
This is the date this customer first viewed your Web site.
- fxAccount: account
- giveAccess Login Access: boolean
-
Check this box to give your customer access to NetSuite. The Customer Center role gives a customer access to view estimates, orders, invoices and payments.
- globalSubscriptionStatus: object
-
- id Internal identifier.: string 1 , 2 , 3 , 4
- refName Reference Name: string
- groupInvoices Group Invoices: boolean
- groupPricing: customer-groupPricingCollection
- homePhone Home Phone: string
-
Enter a home phone number for this person.
- id Internal ID: string
-
The internal ID for this record is shown here. If you do not want to show internal IDs, clear the Show Internal IDs box at Home > Set Preferences.
- image: nsResource
- isAutogeneratedRepresentingEntity Is Autogenerated Representing Entity: boolean
-
This field indicates that this entity was automatically generated by NetSuite to represent a specific subsidiary.
- isBudgetApproved Budget Approved: boolean
-
Check this box if the customer's budget has been approved.
- isInactive Inactive: boolean
-
When you check this box, this customer will no longer appear on customer, prospect or lead list unless you check the Show Inactives box at the bottom of the list page. This customer's name will also no longer appear in other dropdown lists containing customers, and the customer will no longer have access to NetSuite or be able to sign into your Web store.
- isPerson Is Individual: boolean
-
Choose the type of customer record you are creating by selecting Company or Individual in the Type field. This selection determines which fields and subtabs are used on this record.
- itemPricing: customer-itemPricingCollection
- keywords Search Engine Keywords (1st Visit): string
-
If this customer was referred to your Web site by a search engine on the first visit, this field lists the keywords the customer used with the search engine.
- language: object
-
- id Internal identifier.: string ro_RO , af_ZA , tl_PH , pt_BR , th_TH , bn_BD , cs_CZ , ca_ES , hu_HU , kn_IN , sk_SK , es_ES , nl_NL , is_IS , te_IN , sv_SE , sq_AL , es_AR , da_DK , ta_IN , sr_RS , en , ar , hr_HR , ko_KR , en_US , lt_LT , no_NO , el_GR , it_IT , ru_RU , pl_PL , en_AU , tr_TR , id_ID , hi_IN , mr_IN , fr_FR , he_IL , ja_JP , de_DE , ms_MY , zh_TW , fr_CA , pa_IN , fa_IR , bg_BG , vi_VN , hy_AM , lb_LU , xx_US , sh_RS , ht_HT , fi_FI , en_GB , gu_IN , et_EE , en_CA , lv_LV , uk_UA , bs_BA , zh_CN , sl_SI , pt_PT
- refName Reference Name: string
- lastModifiedDate Last Modified Date: string (date-time)
- lastName Last Name: string
-
Optionally enter a last name here.
- lastOrderDate Last Sales Order Date: string (date)
- lastPageVisited Last Page Visited: string
-
This field displays the last page this customer viewed on his or her most recent visit to your Web site.
- lastSaleDate Last Sales Date: string (date)
- lastVisit Last Visit: string (date-time)
-
This is the date this customer most recently visited your Web site.
- leadSource: nsResource
- links Links: nsLink
-
nsLink - middleName Middle Name: string
- mobilePhone Mobile Phone: string
-
Enter a mobile or cell phone number for this person.
- negativeNumberFormat: object
-
- id Internal identifier.: string 0 , 1
- refName Reference Name: string
- numberFormat: object
-
- id Internal identifier.: string 0 , 1 , 2 , 3 , 4 , 5
- refName Reference Name: string
- openingBalance Opening Balance: number (double)
-
Enter the opening balance of this customer's account.
- openingBalanceAccount: account
- openingBalanceDate Opening Balance Date: string (date)
-
Enter the date of the balance entered in the Opening Balance field.
- overdueBalance Overdue: number (double)
-
The Overdue field shows the total amount owed for open transactions that are past their due date based on the invoice terms. Note: For open transactions that do not have a due date, the transaction date is used as the due date to calculate this total. If you use the Multiple Currencies feature, the amount in this field is shown in the customer's currency.
- overrideCurrencyFormat Override Currency Format: boolean
-
Check this box to customize the currency format.
- parent: customer
- partner: partner
- partners: customer-partnersCollection
- password Password: string
-
Assign a password to give this customer access to NetSuite. The Password Criteria fields will ensure that you create a password that meets the password policy in effect in your account. You will need to tell the user the password you assign. For more information, see the help topic NetSuite Password Requirements.
- password2 Confirm Password: string
-
Reenter the password in this field to verify that you entered the same password twice.
- phone Phone: string
-
Enter a phone number for your customer. It will appear on the Customer List report.
- phoneticName Furigana: string
-
Enter the furigana character you want to use to sort this record.
- prefCcProcessor: nsResource
- priceLevel: priceLevel
- printOnCheckAs Print on Check As: string
-
What you enter here prints on the Pay to the Order of line of a check instead of what you entered in the Customer field.
- printTransactions Print Transactions: boolean
-
Set a preferred transaction delivery method for this customer. Choose to send transactions by regular mail, by email, by fax, or by a combination of the three. Then, when you select the customer on a transaction, their preferred delivery method is marked by default. * Email – Check this box to check the To Be Emailed box by default on transactions when this customer is selected. * Print – Check this box to check the To Be Printed box by default on transactions when this customer is selected. * Fax – Check this box to check the To Be Faxed box by default on transactions when this customer is selected. Once you enter these settings on the customer record, these boxes are checked by default for transactions created from the customer record or for transactions that are copied or converted. Note: These settings override any customized settings on transaction forms you use. There are also preferences to set default values for new customer records at Setup > Company > Preferences > Printing, Fax,& Email Preferences. On the Print subtab, Fax subtab, or Email subtab, check Customers Default to [Print/Fax/Email] Transactions. You can also set these fields using the Mass Update function. Go to Lists > Mass Updates > Mass Updates > General and click Customer.
- receivablesAccount: account
- refName Reference Name: string
- referrer Referrer (1st Visit): string
-
This field diplays the URL for the site the customer used to first access your Web site. For example, if this customer clicked a link to your site from the results of a search engine, the URL is provided for the results of that search.
- reminderDays Reminder Days: integer (int64)
-
Enter how many days before the end date you want to be reminded that this customer's contract or job service needs renewing. You can set the reminder to appear in the Reminders portlet on your Home, Lists and Transactions pages by clicking Customize Page on each page. On the Layout tab, click the Right Side Content subtab, and check the Reminders box. Then click the Reminders subtab, and check the Customers to Review box. Click Save.
- representingSubsidiary: subsidiary
- resaleNumber Resale Number: string
-
If you do not collect sales tax from this customer because your merchandise will be resold, enter your customer's valid tax license number here. Make sure that you also set the Not Taxable tax code for this customer.
- salesGroup: nsResource
- salesReadiness: nsResource
- salesRep: employee
- salesTeam: customer-salesTeamCollection
- salutation Mr./Ms...: string
-
Enter the title of this person, such as Mr., Mrs., Ms., Dr., Rev., etc.
- searchStage Stage: string
- sendEmail Send New Access Notification Email: boolean
-
Check this box to automatically send an email notifying this customer that you have them access to NetSuite. The standard NetSuite email message also contains a link to let the user create a password. If you do not check this box, you must check the Manually Assign or Change Password box. You must create the password, and tell the user the password, and when and how to log in. For security reasons, do not send the password by email.
- shipComplete Ship Complete: boolean
-
Check this box if you only want to ship orders to this customer when they are completely fulfilled.
- shippingCarrier: object
-
- id Internal identifier.: string
- refName Reference Name: string
- shippingItem: shipItem
- sourceWebSite: webSite
- startDate Start Date: string (date)
-
Enter the date this person or company became a customer, lead or prospect. If this person or company has a contract with you, enter the start date of the contract. If you enter an estimate or an opportunity for this customer, this field will be updated with the date of that transaction.
- subscriptionMessageHistory: customer-subscriptionMessageHistoryCollection
- subscriptions: customer-subscriptionsCollection
- subsidiary: subsidiary
- symbolPlacement: object
-
- id Internal identifier.: string 1 , 2
- refName Reference Name: string
- syncPartnerTeams Update Transactions: boolean
-
Check this box if you want to update this customer's transactions to reflect the changes you make to the partner team.
- syncSalesTeams Update Transactions: boolean
- taxRegistration: customer-taxRegistrationCollection
- terms: term
- territory: nsResource
- thirdPartyAcct 3rd Party Billing Account Number: string
-
Enter this customer’s FedEx® or UPS® account number in the 3rd Party Billing Account Number field. This account number is used if you select Consignee Billing on item fulfillments using UPS or select Bill Recipient on item fulfillments using FedEx.
- thirdPartyCarrier: object
-
- id Internal identifier.: string fedex , ups , usps
- refName Reference Name: string
- thirdPartyCountry: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- thirdPartyZipCode 3rd Party Billing Zip: string
-
Enter the zip code associated with the customer’s UPS or FedEx account number.
- title Job Title: string
-
Enter the job title for this person's position at his or her company.
- unbilledOrders Unbilled Orders: number (double)
-
This field displays the total amount of orders that have been entered but not yet billed. If you have enabled the preference Customer Credit Limit Includes Orders, then this total is included in credit limit calculations. Set this preference at Setup > Accounting > Preferences > Accounting Preferences > General. If you use the Multiple Currencies feature, the amount in this field is shown in the customer's currency.
- url URL: string
- visits Number of Visits: integer (int64)
-
This field displays the total number of visits this customer has made to your Web site. A new visit is counted after the customer leaves your site and returns.
customer-addressBook-addressBookAddress
- addr1 Address 1: string
- addr2 Address 2: string
- addr3 Address 3: string
- addrPhone Phone: string
- addrText Address: string
- addressee Addressee: string
- attention Attention: string
- city City: string
- country: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- externalId External ID: string
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - override Override: boolean
- refName Reference Name: string
- state State/Province: string
- zip Zip: string
customer-addressBookCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: customer-addressBookElement
-
customer-addressBookElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
customer-addressBookElement
- addressBookAddress: customer-addressBook-addressBookAddress
- addressBookAddress_text Address: string
- addressId Internal ID: string
- defaultBilling Default Billing: boolean
- defaultShipping Default Shipping: boolean
- id ID: integer (int64)
- internalId Internal ID: integer (int64)
- isResidential Residential Address: boolean
- label Label: string
- links Links: nsLink
-
nsLink - refName Reference Name: string
customer-campaignsCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: customer-campaignsElement
-
customer-campaignsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
customer-contactRolesCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: customer-contactRolesElement
-
customer-contactRolesElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
customer-contactRolesElement
- contact: contact
- contactName Contact: string
- email Email: string
- giveAccess Access: boolean
- links Links: nsLink
-
nsLink - password Password: string
- passwordConfirm Confirm Password: string
- refName Reference Name: string
- role: nsResource
customer-currencyListCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: customer-currencyListElement
-
customer-currencyListElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
customer-currencyListElement
- balance Balance: number (double)
- consolBalance Consolidated Balance: number (double)
- consolDepositBalance Consolidated Deposit Balance: number (double)
- consolOverdueBalance Consolidated Overdue Balance: number (double)
- consolUnbilledOrders Consolidated Unbilled Orders: number (double)
- currency: currency
- depositBalance Deposit Balance: number (double)
- displaySymbol Symbol: string
- links Links: nsLink
-
nsLink - overdueBalance Overdue Balance: number (double)
- overrideCurrencyFormat Override Currency Format: boolean
- refName Reference Name: string
- symbolPlacement: object
-
- id Internal identifier.: string 1 , 2
- refName Reference Name: string
- unbilledOrders Unbilled Orders: number (double)
customer-groupPricingCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: customer-groupPricingElement
-
customer-groupPricingElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
customer-groupPricingElement
- group: pricingGroup
- level: priceLevel
- links Links: nsLink
-
nsLink - refName Reference Name: string
customer-itemPricingCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: customer-itemPricingElement
-
customer-itemPricingElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
customer-itemPricingElement
- currency: currency
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- level: priceLevel
- links Links: nsLink
-
nsLink - price Unit Price: number (double)
- refName Reference Name: string
customer-partnersCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: customer-partnersElement
-
customer-partnersElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
customer-partnersElement
- contribution Contribution %: number (double)
- id ID: string
- isPrimary Primary: boolean
- links Links: nsLink
-
nsLink - partner: partner
- partnerRole: partnerCategory
- refName Reference Name: string
customer-salesTeamCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: customer-salesTeamElement
-
customer-salesTeamElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
customer-subscriptionMessageHistoryCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: customer-subscriptionMessageHistoryElement
-
customer-subscriptionMessageHistoryElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
customer-subscriptionsCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: customer-subscriptionsElement
-
customer-subscriptionsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
customer-subscriptionsElement
- lastModifiedDate Last Modified: string (date-time)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- subscribed Subscribed: boolean
- subscription: nsResource
customer-taxRegistrationCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: customer-taxRegistrationElement
-
customer-taxRegistrationElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
customer-taxRegistrationElement
- address Address: string
- id ID: integer (int64)
- links Links: nsLink
-
nsLink - nexus: nexus
- nexusCountry: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- nexusState: nsResource
- refName Reference Name: string
- taxRegistrationNumber Tax Reg. Number: string
customerCategory
This record is available as a beta record.
- externalId External ID: string
- id Internal ID: string
- isInactive Inactive: boolean
-
Check this box to remove all references to this record from your account. You can reactivate the record at any time.
- links Links: nsLink
-
nsLink - name Customer: string
-
Enter the name for this record. This name appears in lists that include this record.
- refName Reference Name: string
customerCategoryCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: customerCategory
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
customerCategory - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
customerCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: customer
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
customer - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
customerDeposit
This record is available as a beta record.
- account: account
- accountingBookDetail: customerDeposit-accountingBookDetailCollection
- appliedRules: customerDeposit-appliedRulesCollection
- cardSwipe Card Swipe: string
- cardholderAuthentication: cardholderAuthentication
- checkNumber Check #: string
- class: classification
- cleared Cleared: boolean
- clearedDate Date Cleared: string (date)
- createdDate Date Created: string (date-time)
- currency: currency
- customForm: object
-
- id Internal identifier.: string -9933
- refName Reference Name: string
- customer: nsResource
- customerPaymentAuthorization: customerPaymentAuthorization
- debitKsn Debit KSN: string
- debitPinBlock Debit Pin Block: string
- department: department
- depositSufficient Deposit Sufficient: boolean
- dynamicDescriptor Soft Descriptor: string
- exchangeRate Exchange Rate: number (double)
-
The currency's exchange rate is shown in this field. You can edit the exchange rate for this transaction only, or you can update the currency record with the exchange rate you enter here.
- excludeFromGLNumbering Exclude from GL Audit Numbering: boolean
- externalId External ID: string
- handlingMode: object
-
- id Internal identifier.: string MIMIC , PROCESS , SAVE_ONLY
- refName Reference Name: string
- id Internal ID: string
- inputReferenceCode Input P/N Ref.: string
- integrationId: string
- lastModifiedDate Date Last Modified: string (date-time)
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
-
Enter a Memo to identify this deposit transaction.
- nexus: nexus
- outputAuthCode Auth. Code: string
- outputReferenceCode P/N Ref.: string
- payment Payment Amount: number (double)
-
Enter the curency amount of the deposit here.
- paymentCardCsc CSC: string
- paymentDeviceId Payment Device ID: string
- paymentInstrumentLimit Payment Instrument Limit: number (double)
- paymentOperation: object
-
- id Internal identifier.: string SALE , CAPTURE
- refName Reference Name: string
- paymentOption: nsResource
- paymentProcessingProfile: nsResource
- postingPeriod: accountingPeriod
- prevDate Previous Effective Date: string (date)
- refName Reference Name: string
- refundedamounttotalbox Refunded: number (double)
- salesOrder: salesOrder
- salesOrderRequiredDepositDue Sales Order Required Deposit Due: number (double)
- salesOrderUnpaidAmount Sales Order Unpaid Amount: number (double)
- status: object
-
- id Internal identifier.: string A , B , R , C , D
- refName Reference Name: string
- subsidiary: subsidiary
- toBeEmailed To Be Emailed: boolean
- total Total: number (double)
- tranDate Date: string (date)
-
NetSuite inserts today's date for this deposit. You can enter or select another date. What you enter here determines the date range in which this transaction appears on the Accounts Receivable Register. Deposits are recorded in your general ledger as a liability until the goods or services are actually delivered and do not affect the customer's accounts receivable balance.
- tranId Deposit #: string
-
The system generated deposit number.
- transactionToRefund: nsResource
- undepFunds: object
-
- id Internal identifier.: string
- refName Reference Name: string
customerDeposit-accountingBookDetailCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: customerDeposit-accountingBookDetailElement
-
customerDeposit-accountingBookDetailElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
customerDeposit-accountingBookDetailElement
This record is available as a beta record.
- accountingBook: accountingBook
- exchangeRate Exchange Rate: number (double)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- revRecOnRevCommitment Rev Rec on Rev Commit.: boolean
- subsidiary: subsidiary
- tranIsVsoeBundle Transaction Is VSOE Bundle: boolean
customerDeposit-appliedRulesCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: customerDeposit-appliedRulesElement
-
customerDeposit-appliedRulesElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
customerDepositCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: customerDeposit
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
customerDeposit - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
customerMessage
This record is available as a beta record.
- description Long Text: string
-
Enter a description of this other list item.
- externalId External ID: string
- id Internal ID: string
- isInactive Inactive: boolean
-
Check this box to remove all references to this record from your account. You can reactivate the record at any time.
- links Links: nsLink
-
nsLink - name Customer Message: string
-
Enter the name for this record. This name appears in lists that include this record.
- preferred Preferred: boolean
-
Check this box to make this term or message show by default on sales transactions you create. Note: Terms set on customer records override terms marked as preferred.
- refName Reference Name: string
customerMessageCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: customerMessage
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
customerMessage - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
customerPayment
This record is available as a beta record.
- account: account
- accountingBookDetail: customerPayment-accountingBookDetailCollection
- applied Applied: number (double)
-
NetSuite keeps track of the total applied payments here. You can apply payments by placing or clearing check marks in the Apply column next to the appropriate invoices at the bottom of the page. If you want, you can change dollar amounts in the Payment column next to these invoices. When you do this, the Applied field automatically updates.
- appliedRules: customerPayment-appliedRulesCollection
- apply: customerPayment-applyCollection
- aracct: account
- balance Current Balance: number (double)
-
NetSuite shows you the balance in this customer account.
- cardSwipe Card Swipe: string
- cardholderAuthentication: cardholderAuthentication
- checkNumber Check #: string
- class: classification
- cleared Cleared: boolean
- clearedDate Date Cleared: string (date)
- consolidatebalance Consolidated Balance: number (double)
-
The total of all open invoices for the entire customer-subcustomer hierarchy.
- createdDate Date Created: string (date-time)
- credit: customerPayment-creditCollection
- currency: currency
- customForm: object
-
- id Internal identifier.: string -9930
- refName Reference Name: string
- customer: nsResource
- customerPaymentAuthorization: customerPaymentAuthorization
- debitKsn Debit KSN: string
- debitPinBlock Debit Pin Block: string
- department: department
- deposit: customerPayment-depositCollection
- dynamicDescriptor Soft Descriptor: string
- exchangeRate Exchange Rate: number (double)
-
The currency's exchange rate is shown in this field. You can edit the exchange rate for this transaction only, or you can update the currency record with the exchange rate you enter here.
- excludeFromGLNumbering Exclude from GL Audit Numbering: boolean
- externalId External ID: string
- handlingMode: object
-
- id Internal identifier.: string MIMIC , PROCESS , SAVE_ONLY
- refName Reference Name: string
- id Internal ID: string
- inputReferenceCode Input P/N Ref.: string
- integrationId: string
- lastModifiedDate Date Last Modified: string (date-time)
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
-
If you wish, enter a memo to describe this payment. It will appear on reports such as the 2-line Accounts Receivable register that NetSuite merchants and their guest-customers can see (if given permission to log in and view their transaction history).
- nexus: nexus
- originator Originator: string
- outputAuthCode Auth. Code: string
- outputReferenceCode P/N Ref.: string
- payment Payment Amount: number (double)
-
Enter the currency amount of the payment here.
- paymentCardCsc CSC: string
- paymentDeviceId Payment Device ID: string
- paymentInstrumentLimit Payment Instrument Limit: number (double)
- paymentOperation: object
-
- id Internal identifier.: string SALE , CAPTURE
- refName Reference Name: string
- paymentOption: nsResource
- paymentProcessingProfile: nsResource
- pending Pending: number (double)
-
If your customer has unapproved credit card payments, NetSuite automatically fills in the sum amount of these payments here. If you validate credit card payments outside of NetSuite, these payments will be pending until they are approved. Once payments are approved, check the Card Approved box.
- postingPeriod: accountingPeriod
- prevDate Previous Effective Date: string (date)
- refName Reference Name: string
- refundedamounttotalbox Refunded: number (double)
- status: object
-
- id Internal identifier.: string A , R , B , C
- refName Reference Name: string
- subsidiary: subsidiary
- toBeEmailed To Be Emailed: boolean
- total To Apply: number (double)
-
NetSuite adds the payment amount from above plus any credits you have chosen to apply and displays the total here.
- tranDate Date: string (date)
-
NetSuite inserts today's date for the posting date of this payment. You can enter or select another date. What you enter here determines the date range in which this transaction appears on the Accounts Receivable Register.
- tranId Payment #: string
-
This is the document number automatically generated for the transaction by NetSuite.
- transactionToRefund: nsResource
- unapplied Unapplied: number (double)
-
NetSuite shows the difference between amounts available to apply to payments and payments you have actually applied. To make this equal to 0.00, you can (1) change the Payment Amount above, (2) check the Apply Existing Credits check box above, or (3) change Payment amounts below.
- undepFunds: object
-
- id Internal identifier.: string
- refName Reference Name: string
customerPayment-accountingBookDetailCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: customerPayment-accountingBookDetailElement
-
customerPayment-accountingBookDetailElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
customerPayment-accountingBookDetailElement
This record is available as a beta record.
- accountingBook: accountingBook
- exchangeRate Exchange Rate: number (double)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- revRecOnRevCommitment Rev Rec on Rev Commit.: boolean
- subsidiary: subsidiary
- tranIsVsoeBundle Transaction Is VSOE Bundle: boolean
customerPayment-appliedRulesCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: customerPayment-appliedRulesElement
-
customerPayment-appliedRulesElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
customerPayment-applyCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: customerPayment-applyElement
-
customerPayment-applyElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
customerPayment-applyElement
This record is available as a beta record.
- amount Payment: number (double)
- apply Apply: boolean
- applyDate Date: string (date)
- createdFrom: string
- currency Currency: string
- doc: nsResource
- due Amt. Due: number (double)
- jobName Subcustomer: string
- line: integer (int64)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- refNum Ref No.: string
- total Orig. Amt.: number (double)
- type Type: string
customerPayment-creditCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: customerPayment-creditElement
-
customerPayment-creditElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
customerPayment-creditElement
This record is available as a beta record.
- amount Payment: number (double)
- appliedTo Applied To: string
- apply Apply: boolean
- createdFrom: string
- creditDate Date: string (date)
- currency Currency: string
- doc: nsResource
- due Amt. Due: number (double)
- line: integer (int64)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- refNum Ref No.: string
- total Orig. Amt.: number (double)
- type Type: string
customerPayment-depositCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: customerPayment-depositElement
-
customerPayment-depositElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
customerPaymentAuthorization
This record is available as a beta record.
- cardSwipe Card Swipe: string
- cardholderAuthentication: cardholderAuthentication
- checkNumber Check #: string
- class: classification
- createdDate Date Created: string (date-time)
- currency: currency
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- customer: nsResource
- customerPaymentAuthorization: customerPaymentAuthorization
- debitKsn Debit KSN: string
- debitPinBlock Debit Pin Block: string
- department: department
- depositSufficient Deposit Sufficient: boolean
- dynamicDescriptor Soft Descriptor: string
- exchangeRate Exchange Rate: number (double)
- excludeFromGLNumbering Exclude from GL Audit Numbering: boolean
- externalId External ID: string
- handlingMode: object
-
- id Internal identifier.: string MIMIC , PROCESS , SAVE_ONLY
- refName Reference Name: string
- id Internal ID: string
- inputReferenceCode Input P/N Ref.: string
- integrationId: string
- lastModifiedDate Date Last Modified: string (date-time)
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
- outputAuthCode Auth. Code: string
- outputReferenceCode P/N Ref.: string
- payment Payment Amount: number (double)
- paymentCardCsc CSC: string
- paymentDeviceId Payment Device ID: string
- paymentInstrumentLimit Payment Instrument Limit: number (double)
- paymentOperation: object
-
- id Internal identifier.: string REFRESH , VOID , AUTHORIZATION
- refName Reference Name: string
- paymentOption: nsResource
- paymentProcessingProfile: nsResource
- prevDate Previous Effective Date: string (date)
- refName Reference Name: string
- salesOrder: salesOrder
- salesOrderRequiredDepositDue Sales Order Required Deposit Due: number (double)
- salesOrderUnpaidAmount Sales Order Unpaid Amount: number (double)
- status: object
-
- subsidiary: subsidiary
- tranDate Date: string (date)
- tranId Authorization #: string
- transactionToRefund: nsResource
customerPaymentAuthorizationCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: customerPaymentAuthorization
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
customerPaymentAuthorization - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
customerPaymentCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: customerPayment
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
customerPayment - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
customerRefund
This record is available as a beta record.
- account: account
- accountingBookDetail: customerRefund-accountingBookDetailCollection
- address Pay To: string
-
NetSuite inserts the billing address of the customer from the record at Lists > Relationships > Customers. You can change the address for just this transaction by typing up to 5 rows of information in this field.
- apply: customerRefund-applyCollection
- aracct: account
- balance Current Balance: number (double)
-
This field shows the current customer balance.
- cardSwipe Card Swipe: string
- cardholderAuthentication: cardholderAuthentication
- checkNumber Check #: string
- class: classification
- cleared Cleared: boolean
- clearedDate Date Cleared: string (date)
- consolidateBalance Consolidated Balance: number (double)
-
The total of all open invoices for the entire customer-subcustomer hierarchy.
- createdDate Date Created: string (date-time)
- currency: currency
- customForm: object
-
- id Internal identifier.: string -9959
- refName Reference Name: string
- customer: nsResource
- customerPaymentAuthorization: customerPaymentAuthorization
- debitKsn Debit KSN: string
- debitPinBlock Debit Pin Block: string
- department: department
- deposit: customerRefund-depositCollection
- dynamicDescriptor Soft Descriptor: string
- exchangeRate Exchange Rate: number (double)
-
The currency's exchange rate is shown in this field. You can edit the exchange rate for this transaction only, or you can update the currency record with the exchange rate you enter here.
- excludeFromGLNumbering Exclude from GL Audit Numbering: boolean
- externalId External ID: string
- handlingMode: object
-
- id Internal identifier.: string MIMIC , PROCESS , SAVE_ONLY
- refName Reference Name: string
- id Internal ID: string
- inputReferenceCode Input P/N Ref.: string
- integrationId: string
- lastModifiedDate Date Last Modified: string (date-time)
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
-
Enter an optional memo to describe this refund. For example, you may want to include the original transaction number on the refund. This memo appears on issued checks and register reports.
- nexus: nexus
- outputAuthCode Auth. Code: string
- outputReferenceCode P/N Ref.: string
- payeeAddress: customerRefund-payeeAddress
- payeeAddressList: nsResource
- payeeAddress_text Pay To: string
- paymentCardCsc CSC: string
- paymentDeviceId Payment Device ID: string
- paymentInstrumentLimit Payment Instrument Limit: number (double)
- paymentOperation: object
-
- id Internal identifier.: string CREDIT , REFUND
- refName Reference Name: string
- paymentOption: nsResource
- paymentProcessingProfile: nsResource
- postingPeriod: accountingPeriod
- prevDate Previous Effective Date: string (date)
- refName Reference Name: string
- status: object
-
- id Internal identifier.: string R , V
- refName Reference Name: string
- subsidiary: subsidiary
- toBePrinted To Be Printed: boolean
-
Check this box to queue this refund to be printed.
- total Refund Amount: number (double)
-
NetSuite updates the refund amount as you check or clear the Apply check boxes at the bottom of the form.
- tranDate Date: string (date)
-
NetSuite inserts today's date as the date of this refund. You can type or pick another date.
- tranId Check #: string
-
If you are issuing a check, NetSuite supplies the next consecutive number.
- transactionToRefund: nsResource
- voidjournal: nsResource
customerRefund-accountingBookDetailCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: customerRefund-accountingBookDetailElement
-
customerRefund-accountingBookDetailElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
customerRefund-accountingBookDetailElement
This record is available as a beta record.
- accountingBook: accountingBook
- exchangeRate Exchange Rate: number (double)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- revRecOnRevCommitment Rev Rec on Rev Commit.: boolean
- subsidiary: subsidiary
- tranIsVsoeBundle Transaction Is VSOE Bundle: boolean
customerRefund-applyCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: customerRefund-applyElement
-
customerRefund-applyElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
customerRefund-applyElement
This record is available as a beta record.
- amount Payment: number (double)
- apply Apply: boolean
- applyDate Date: string (date)
- createdFrom: string
- currency Currency: string
- doc: nsResource
- due Amt. Due: number (double)
- jobName Subcustomer: string
- line: integer (int64)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- refNum Ref No.: string
- total Orig. Amt.: number (double)
- type Type: string
customerRefund-depositCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: customerRefund-depositElement
-
customerRefund-depositElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
customerRefund-payeeAddress
This record is available as a beta record.
- addr1 Address 1: string
- addr2 Address 2: string
- addr3 Address 3: string
- addrPhone Phone: string
- addrText Address: string
- addressee Addressee: string
- attention Attention: string
- city City: string
- country: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- externalId External ID: string
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - override Override: boolean
- refName Reference Name: string
- state State/Province: string
- zip Zip: string
customerRefundCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: customerRefund
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
customerRefund - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
customerStatus
This record is available as a beta record.
- description Description: string
-
Enter a description of this customer status. This field can hold 199 characters.
- externalId External ID: string
- id Internal ID: string
- includeInLeadReports Include In Lead Reports: boolean
-
Check this box if you want records with this status to appear in leads reports.
- isInactive Inactive: boolean
-
Check this box to inactivate this status.
- links Links: nsLink
-
nsLink - name Status: string
-
Enter a title for this status. What you enter here appears in the Status field of lead, prospect or customer records, depending on the stage you select. If you select the stage Prospect, this status also appears in the Status field of Estimates.
- probability Probability: number (double)
-
Enter the likelihood a lead, prospect or customer with this status will purchase from your company.
- refName Reference Name: string
- stage: object
-
- id Internal identifier.: string CUSTOMER , PROSPECT , LEAD
- refName Reference Name: string
customerStatusCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: customerStatus
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
customerStatus - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
customerSubsidiaryRelationship
- balance Balance: number (double)
-
The customer's current accounts receivable balance due appears here. If you use the Multiple Currencies feature, the amount in this field is shown in the customer's currency.
- depositBalance Deposit Balance: number (double)
-
The Customer Deposit Balance field displays the total amount of unapplied deposits for the customer. Deposits are recorded in the general ledger, as a liability, when the customer makes an advance payment before delivery of goods or services. A deposit balance exists until the goods or services are delivered. Deposits do not affect the customer's accounts receivable balance. If you use the Multiple Currencies feature, the amount in this field is shown in the customer's currency.
- entity: customer
- externalId External ID: string
- id Internal ID: string
-
The internal ID for this record is shown here. If you do not want to show internal IDs, clear the Show Internal IDs box at Home > Set Preferences.
- isPrimarySub Is Primary Subsidiary: boolean
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - name Name: string
- primaryCurrency: currency
- refName Reference Name: string
- subsidiary: subsidiary
- unbilledOrders Unbilled Orders: number (double)
-
This field displays the total amount of orders that have been entered but not yet billed. If you have enabled the preference Customer Credit Limit Includes Orders, then this total is included in credit limit calculations. Set this preference at Setup > Accounting > Preferences > Accounting Preferences > General. If you use the Multiple Currencies feature, the amount in this field is shown in the customer's currency.
customerSubsidiaryRelationshipCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: customerSubsidiaryRelationship
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
customerSubsidiaryRelationship - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
department
This record is available as a beta record.
- classtranslation: department-classtranslationCollection
- externalId External ID: string
- fullName Full Name: string
- id Internal ID: string
- includeChildren Include Children: boolean
-
Check the Include Children box to associate the department with all the sub-subsidiaries associated with each subsidiary selected in the Subsidiary field.
- internalId Internal ID: integer (int64)
- isInactive Department is Inactive: boolean
-
Check this box to inactivate this department record. Inactive departments do not show in lists of departments on records and transactions.
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - name Name: string
-
Enter a name for this department. The name you enter here shows in lists of departments on records and transactions. The name can be alphanumeric. The maximum number of characters is 31.
- parent: department
- refName Reference Name: string
- subsidiary: subsidiaryCollection
department-classtranslationCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: department-classtranslationElement
-
department-classtranslationElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
department-classtranslationElement
This record is available as a beta record.
- language Language: string
- links Links: nsLink
-
nsLink - locale: object
-
- id Internal identifier.: string it_CH , en_TC , af_ZA , es_EA , es_EC , pt_BR , en_CY , fr_LU , nl_AN , es_UY , en_TT , es_ES , pt_ST , en_DM , en_TZ , es_ES_EURO , fr_ML , de_DE_onLQA , es_VE , nl_BE , da_DK , pt_AO , to_TO , en_UG , am_ET , ss_SZ , nl_BQ , ar , pt_AW , ko_KR , en_US , fr_BE_EURO , ko_KP , si_AQ , fr_MG , el_GR , be_BY , en_AU , he_IL , en_AW , es_SV , en_BB , ar_YE , es_CO , es_CL , en_BM , es_CR , pa_IN , en_SC , en_BS , sm_WS , it_IT_EURO , fr_KM , es_CU , en_SB , en_SG , en_BW , en_SH , en_BZ , en_SL , az_AZ , fi_FI , en_SS , sr_YU , en_CD , en_CA , ka_GE , lv_LV , uk_UA , es_DO , ur_PK , ar_IQ , fr_LU_EURO , pt_PT , fr_FR_EURO , en_PH , th_TH , bn_BD , si_LK , en_PG , hu_HU , ar_SA , ar_SD , ru_KZ , ar_BH , nl_BE_EURO , ro_MD , en_QA , ru_KG , es_AR , ta_IN , sr_RS , aa_ER , en , de_DE_EURO , zh_MO , en_AE , ar_SY , es_BO , en_AI , no_NO , en_AG , nl_SR , fr_VU , en_MW , gu_AQ , ar_TN , nl_SX , hi_IN , en_NA , mn_MN , en_NG , fr_FR , ms_MY , nl_CW , uz_UZ , ar_DJ , sr_CS , de_AT_EURO , en_NZ , es_PE , es_PA , fa_IR , ar_DZ , fr_GN , lb_LU , xx_US , pt_CV , sh_RS , ht_HT , fr_WF , es_AR_onLQA , es_PR , ar_EG , es_PY , fr_GA , en_KW , de_AT , ro_RO , en_KY , fr_FR_onLQA , fr_DJ , ca_ES_EURO , cs_CZ , en_LC , pl_AQ , fr_TD , fr_TG , es_MX , sv_AX , sk_SK , en_LR , en_LS , ar_OM , dz_BT , te_IN , de_LU_EURO , sq_AL , sv_SE , sn_ZW , es_NI , en_IE_EURO , my_MM , en_MF , en_MU , it_IT , pl_PL , fr_BE , fr_BF , tr_TR , fr_BI , fr_BJ , id_ID , fr_RW , en_ZM , km_KH , ja_JP , de_DE , fr_BL , tg_TJ , ar_QA , de_CH , zh_HK , pt_PT_EURO , en_JO , en_JM , fr_CA , nl_NL_EURO , fr_CF , fr_CG , fr_CD , pa_AQ , fr_CH , xx_US_wthId , fr_CI , pt_GW , vi_VN , ru_MD , fr_CM , fr_SC , en_KE , ne_NP , bs_BA , sl_SI , en_KN , fr_SN , ar_AE , en_GY , tl_PH , ca_ES , es_IC , lo_LA , kn_IN , so_SO , fr_PF , ar_JO , nl_NL , is_IS , fi_FI_EURO , pt_MZ , sk_SK_EURO , sl_SI_EURO , en_IE , ms_BN , hr_HR , ar_KW , de_LU , lt_LT , en_IN , ps_AF , en_ZA , en_VC , ru_RU , sh_YU , ar_LB , mr_IN , dv_MV , fj_FJ , zh_TW , tk_TM , ar_LY , en_VU , fr_NE , en_FK , es_GT , fr_NC , es_GQ , fa_AF , bg_BG , hy_AM , en_CY_EURO , mk_MK , ar_MA , en_GD , en_GB , es_HN , gu_IN , en_GH , et_EE , en_GI , zh_CN , en_GM , ar_MR
- refName Reference Name: string
- name Name: string
- refName Reference Name: string
departmentCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: department
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
department - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
deposit
This record is available as a beta record.
- account: account
- accountingBookDetail: deposit-accountingBookDetailCollection
- appliedRules: deposit-appliedRulesCollection
- cashback: deposit-cashbackCollection
- class: classification
- cleared Cleared: boolean
- clearedDate Date Cleared: string (date)
- createdDate Date Created: string (date-time)
- creditCardProcessor: nsResource
- currency: currency
- currencyPrecision: integer (int64)
- customForm: object
-
- id Internal identifier.: string 1 , -9999
- refName Reference Name: string
- department: department
- exchangeRate Exchange Rate: number (double)
-
The currency's exchange rate is shown in this field. If the bank account's currency is the same as the subsidiary's base currency, the exchange rate is a read-only field.
- excludeFromGLNumbering Exclude from GL Audit Numbering: boolean
- externalId External ID: string
- id Internal ID: string
- isBaseCurrency Base Currency: boolean
- lastModifiedDate Date Last Modified: string (date-time)
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
-
If you want, enter a memo to describe this deposit. It will appear on reports.
- other: deposit-otherCollection
- payment: deposit-paymentCollection
- postingPeriod: accountingPeriod
- prevDate Previous Effective Date: string (date)
- refName Reference Name: string
- subsidiary: subsidiary
- toBePrinted To Be Printed: boolean
-
If you enter multiple deposits before printing, you can print all the slips at one time. To do this, check the To Be Printed box on each transaction page as you enter deposits. To print the queued deposits, go to Transactions > Management > Print Checks and Forms > Print Deposits.
- total Amount: number (double)
-
Enter the Amount being deposited.
- tranDate Date: string (date)
-
NetSuite inserts today's date for the posting date of this deposit. You can type or pick another date. What you enter here determines the date range in which this transaction appears on the Bank register. You can select or enter custom date ranges on registers.
- tranId Deposit #: string
-
This field displays the system-generated number associated with this deposit.
- trancurrencyname: string
- updatecurrency Update Currency: string
deposit-accountingBookDetailCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: deposit-accountingBookDetailElement
-
deposit-accountingBookDetailElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
deposit-accountingBookDetailElement
This record is available as a beta record.
- accountingBook: accountingBook
- exchangeRate Exchange Rate: number (double)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- revRecOnRevCommitment Rev Rec on Rev Commit.: boolean
- subsidiary: subsidiary
- tranIsVsoeBundle Transaction Is VSOE Bundle: boolean
deposit-appliedRulesCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: deposit-appliedRulesElement
-
deposit-appliedRulesElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
deposit-cashbackCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: deposit-cashbackElement
-
deposit-cashbackElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
deposit-cashbackElement
This record is available as a beta record.
- account: account
- amount Amount: number (double)
- class: classification
- department: department
- line: string
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
- refName Reference Name: string
deposit-otherCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: deposit-otherElement
-
deposit-otherElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
deposit-otherElement
This record is available as a beta record.
- account: account
- amount Amount: number (double)
- class: classification
- department: department
- entity: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- line: string
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
- methcash: string
- methcheck: string
- paymentMethod: paymentMethod
- refName Reference Name: string
- refnum Number: string
deposit-paymentCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: deposit-paymentElement
-
deposit-paymentElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
deposit-paymentElement
This record is available as a beta record.
- class: classification
- currency: currency
- department: department
- deposit Deposit: boolean
- docdate Date: string (date)
- docnumber Number: string
- entity: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- lineid: integer (int64)
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
- paymentMethod: paymentMethod
- paymentamount Amount: number (double)
- pmtcurrencyprecision Currency Precision: string
- pmtmethcash: string
- pmtmethcheck: string
- pmturl: string
- refName Reference Name: string
- refnum Ref No.: string
- transactionamount Payment Amount: number (double)
- type: object
-
- id Internal identifier.: string
- refName Reference Name: string
depositApplication
This record is available as a beta record.
- accountingBookDetail: depositApplication-accountingBookDetailCollection
- applied Applied: number (double)
- appliedRules: depositApplication-appliedRulesCollection
- apply: depositApplication-applyCollection
- aracct: account
- class: classification
- createdDate Date Created: string (date-time)
- currency: currency
- customForm: object
-
- id Internal identifier.: string -9984
- refName Reference Name: string
- customer: nsResource
- department: department
- deposit: deposit
- depositDate Deposit Date: string (date)
-
This field shows the date of the original deposit.
- exchangeRate Exchange Rate: number (double)
-
This field displays the exchange rate of the deposit application.
- excludeFromGLNumbering Exclude from GL Audit Numbering: boolean
- externalId External ID: string
- id Internal ID: string
- lastModifiedDate Date Last Modified: string (date-time)
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
-
Enter a memo to identify this application transaction.
- postingPeriod: accountingPeriod
- prevDate Previous Effective Date: string (date)
- refName Reference Name: string
- status: object
-
- id Internal identifier.: string
- refName Reference Name: string
- subsidiary: subsidiary
- total To Apply: number (double)
- tranDate Date: string (date)
-
The current date defaults to show in this field. You can select or enter another date if necessary.
- tranId Deposit Application #: string
-
This field indicates that the deposit application number will be generated by NetSuite.
- unapplied Unapplied: number (double)
depositApplication-accountingBookDetailCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: depositApplication-accountingBookDetailElement
-
depositApplication-accountingBookDetailElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
depositApplication-accountingBookDetailElement
This record is available as a beta record.
- accountingBook: accountingBook
- exchangeRate Exchange Rate: number (double)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- revRecOnRevCommitment Rev Rec on Rev Commit.: boolean
- subsidiary: subsidiary
- tranIsVsoeBundle Transaction Is VSOE Bundle: boolean
depositApplication-appliedRulesCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: depositApplication-appliedRulesElement
-
depositApplication-appliedRulesElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
depositApplication-applyCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: depositApplication-applyElement
-
depositApplication-applyElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
depositApplication-applyElement
This record is available as a beta record.
- amount Payment: number (double)
- apply Apply: boolean
- applyDate Date: string (date)
- createdFrom: string
- currency Currency: string
- doc: nsResource
- due Amt. Due: number (double)
- jobName Subcustomer: string
- line: integer (int64)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- refNum Ref No.: string
- total Orig. Amt.: number (double)
- type Type: string
depositApplicationCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: depositApplication
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
depositApplication - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
depositCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: deposit
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
deposit - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
descriptionItem
This record is available as a beta record.
- availableToPartners Available to Adv. Partners: boolean
-
Check this box to make this item available to partners with the Advanced Partner Center role for viewing. These items are also available to partners with roles that are customized for the Advanced Partner Center and include view, create or edit access to item records.
- class: classification
- createdDate Date Created: string (date-time)
- customForm: object
-
- id Internal identifier.: string -10250 , -250
- refName Reference Name: string
- department: department
- description Description: string
-
Enter a description for this item. This description will appear in the Description column of sales forms.
- externalId External ID: string
- id Internal ID: string
- includeChildren Include Children: boolean
-
Check the Include Children box to share the item with all the sub-subsidiaries associated with each subsidiary selected in the Subsidiary field. Note: When sharing items across subsidiaries, all of the options selected on the item record must be compatible across subsidiaries. For example, when entering an inventory item to be shared across subsidiaries, you should select Income and Asset accounts on the item record that are also shared across the same subsidiaries.
- isInactive Inactive: boolean
-
When you check this box, this item will no longer appear on a list unless you check the Show All box at the bottom of the list page.
- issueProduct: issueProduct
- itemId Item Name/Number: string
-
Enter up to 250 characters for the name of this item. This name appears in lists on transactions. If you have the option of entering a display name and do not, the item name prints in the Item column of sales forms when Basic printing is used. If you have the option to enter a vendor name and do not, the item name prints in the Item column of purchase forms. If you have entered a display name, it will print on purchases instead of the item name when Basic printing is used.
- itemType: object
-
- lastModifiedDate Last Modified: string (date-time)
- links Links: nsLink
-
nsLink - location: location
- refName Reference Name: string
- subsidiary: subsidiaryCollection
descriptionItemCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: descriptionItem
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
descriptionItem - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
discountItem
This record is available as a beta record.
- account: account
- availableToPartners Available to Adv. Partners: boolean
-
Check this box to make this item available to partners with the Advanced Partner Center role for viewing. These items are also available to partners with roles that are customized for the Advanced Partner Center and include view, create or edit access to item records.
- class: classification
- createdDate Date Created: string (date-time)
- customForm: object
-
- id Internal identifier.: string -10230 , -230
- refName Reference Name: string
- department: department
- description Description: string
-
Enter a description for this item. This description will appear in the Description column of sales forms.
- displayName Display Name/Code: string
-
Enter an optional name of up to 250 characters for this item in addition to the Item Name. If you are integrating with a Yahoo! store, this field is imported from Yahoo!. The display name prints in the Item column of sales forms when Basic printing is used. If this item is a member of a kit, this name appears in the Item column when the Print Items box is checked. If you do not enter a display name, the item name appears on printed forms.
- externalId External ID: string
- id Internal ID: string
- includeChildren Include Children: boolean
-
Check the Include Children box to share the item with all the sub-subsidiaries associated with each subsidiary selected in the Subsidiary field. Note: When sharing items across subsidiaries, all of the options selected on the item record must be compatible across subsidiaries. For example, when entering an inventory item to be shared across subsidiaries, you should select Income and Asset accounts on the item record that are also shared across the same subsidiaries.
- isInactive Inactive: boolean
-
When you check this box, this item will no longer appear on a list unless you check the Show All box at the bottom of the list page.
- isPreTax Apply Before Tax: boolean
-
Check this box to apply this markup or discount before taxes are calculated. Important: This option is for use only in countries that levy sales tax, for example, the United States. In OneWorld accounts, this checkbox does not have any effect on countries that use value-added tax (VAT). However, this option can be used for Brazil, China, and India. For more information, see the Help topic Applying Sales Tax or VAT to Discount Items.
- issueProduct: issueProduct
- itemId Item Name/Number: string
-
Enter up to 250 characters for the name of this item. This name appears in lists on transactions. If you have the option of entering a display name and do not, the item name prints in the Item column of sales forms when Basic printing is used. If you have the option to enter a vendor name and do not, the item name prints in the Item column of purchase forms. If you have entered a display name, it will print on purchases instead of the item name when Basic printing is used.
- itemType: object
-
- lastModifiedDate Last Modified: string (date-time)
- links Links: nsLink
-
nsLink - location: location
- nonPosting: object
-
- id Internal identifier.: string T , F
- refName Reference Name: string
- parent: discountItem
- parentOnly Use as Category Only: boolean
- rate Rate: number (double)
-
Enter the rate for this discount or markup. The rate can be either a percentage or dollar amount. A percentage discount must be followed by a % sign. A dollar amount should be entered as a positive number.
- refName Reference Name: string
- subsidiary: subsidiaryCollection
- upcCode UPC Code: string
-
Enter a maximum of 999 characters in this field to identify an internal name or number to store the item's UPC Code. You can use the text you enter here when adding the item to transactions, searching, or viewing reports. * When you enter text in this field, the SKU/UPC field on item labels displays this UPC Code and prints in UPC bar code format. * When this field is clear, the SKU/UPC field on item labels displays the Item Name/Number and prints in Code-128 bar code format.
- vendorName Vendor Name/Code: string
-
If your vendor uses a name for this item that is different from the name you use, you can enter up to 60 characters as the vendor's name for this item here. The vendor's name for this item prints in the Item column of purchase forms. If you do not enter a vendor name, the item name prints in the Item column of purchase forms. If you have entered a display name, it will print on purchases instead of the item name.
discountItemCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: discountItem
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
discountItem - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
downloadItem
This record is available as a beta record.
- VSOEDeferral: object
-
- id Internal identifier.: string DEFERALLUNTIL , DEFERUNTIL
- refName Reference Name: string
- VSOEDelivered Default as Delivered: boolean
-
Check this box to automatically set this item to a Delivered status when this item is added to a transaction. Clear this box to leave the delivery status clear by default.
- VSOEPermitDiscount: object
-
- id Internal identifier.: string IFDELIVERED , NEVER
- refName Reference Name: string
- VSOEPrice Allocation Price: number (double)
-
Enter the VSOE Price for this item if it is known. Note: If you need to use more than one VSOE price for an item, you can set the most common price here and then change the price on each order manually.
- VSOESopGroup: object
-
- id Internal identifier.: string EXCLUDE , NORMAL , SOFTWARE
- refName Reference Name: string
- accountingBookDetail: downloadItem-accountingBookDetailCollection
- amortizationPeriod Amortization Period: integer (int64)
- amortizationTemplate: amortizationTemplate
- autoExpandKitForRevenuemgmt Auto-Expansion for Revenue Management: boolean
- availableToPartners Available to Adv. Partners: boolean
-
Check this box to make this item available to partners with the Advanced Partner Center role for viewing. These items are also available to partners with roles that are customized for the Advanced Partner Center and include view, create or edit access to item records.
- billingSchedule: billingSchedule
- class: classification
- contingentRevenueHandling Eligible For Contingent Revenue Handling: boolean
- correlatedItems: downloadItem-correlatedItemsCollection
- costEstimate Item Defined Cost: number (double)
-
Enter an Item Defined Cost amount.
- createExpensePlansOn: nsResource
- createRevenuePlansOn: nsResource
- createdDate Date Created: string (date-time)
- customForm: object
-
- id Internal identifier.: string -210 , -10211 , -10210
- refName Reference Name: string
- daysBeforeExpiration Days Before Expiration: integer (int64)
-
If you want this item to expire, enter the number of days it should remain active after purchase. If this item is downloadable and the same customer purchases this item more than once, the countdown to expiration restarts with each purchase. Note: If this item is a gift certificate and the buyer lives in California, Connecticut, Louisiana, Massachusetts, New Hampshire, Rhode Island or Washington, by law the gift certificate cannot expire.
- deferralAccount: account
- deferredRevenueAccount: account
- department: department
- description Description: string
-
Enter a description for this item. This description will appear in the Description column of sales forms.
- directRevenuePosting Direct Revenue Posting: boolean
-
Check this box to disable advanced revenue management for this item. When checked, posting transactions that include this item post directly to the item revenue account. No revenue element or revenue arrangement is created. When you check this box, the Deferred Revenue Account on the Accounting subtab is disabled. When you create sales transactions that include items that have this box checked, all the items in the transaction must have the box checked. You cannot mix items that post directly to revenue with items that post to deferred revenue in the same transaction. This restriction also applies to kit items. All items in a kit must post either to revenue or to deferred revenue. You cannot check or clear the box after the item has been used in a transaction with advanced revenue management. By default, this box is not checked.
- displayName Display Name/Code: string
-
Enter an optional name of up to 250 characters for this item in addition to the Item Name. If you are integrating with a Yahoo! store, this field is imported from Yahoo!. The display name prints in the Item column of sales forms when Basic printing is used. If this item is a member of a kit, this name appears in the Item column when the Print Items box is checked. If you do not enter a display name, the item name appears on printed forms.
- dontShowPrice Don't Show Price: boolean
-
Check this box to hide the price of this item online. This is useful for items you want to advertise but don't want to sell or for items that you track inventory for and want to display but are offered in combination with other items.
- excludeFromSiteMap Exclude from Sitemap: boolean
-
Check this box to exclude a tab, category or item page from the site map.
- expenseAmortizationRule: nsResource
- externalId External ID: string
- featuredDescription Featured Description: string
-
If this item is displayed on the home page of your Web site, enter a featured description for this item. This description appears below the item's store display name on the Home page of your store or site. You can enter up to 999 characters including basic HTML code. Enter and format text using the formatting options, or click the HTML Source Code link to enter HTML.
- id Internal ID: string
- immediateDownload Immediate Download: boolean
-
Check this box if you want customers to be able to download the item immediately after checking out. Clear this box to make download available after the order is billed. Customers then receive email that the download is available through the My Account tab of your site.
- includeChildren Include Children: boolean
-
Check the Include Children box to share the item with all the sub-subsidiaries associated with each subsidiary selected in the Subsidiary field. Note: When sharing items across subsidiaries, all of the options selected on the item record must be compatible across subsidiaries. For example, when entering an inventory item to be shared across subsidiaries, you should select Income and Asset accounts on the item record that are also shared across the same subsidiaries.
- incomeAccount: account
- internalId Internal ID: integer (int64)
-
Use this ID number to create smart tags for your item templates, site templates, and custom Web site that you host with NetSuite.
- isFulfillable Can be Fulfilled: boolean
-
Check the Can be Fulfilled/Received box to enable this item to be received and fulfilled during order processing. Clear this box if this item does not require being received and fulfilled. Note: Once this item has been added to transactions, this setting cannot be changed. This field is used when the Advanced Billing and Advanced Shipping features are both enabled.
- isGCoCompliant Google Checkout Compliant: boolean
- isInactive Inactive: boolean
-
When you check this box, this item will no longer appear on a list unless you check the Show All box at the bottom of the list page.
- isOnline Display in Website: boolean
-
Check this box to make this item available online in your Web site. You cannot sell this item online unless you check this box. If the item is of the Other Charge for Sale or Resale subtype, checking this box does not make it available in the web store catalog. However, it becomes available during web store checkout.
- issueProduct: issueProduct
- itemId Item Name/Number: string
-
Enter up to 250 characters for the name of this item. This name appears in lists on transactions. If you have the option of entering a display name and do not, the item name prints in the Item column of sales forms when Basic printing is used. If you have the option to enter a vendor name and do not, the item name prints in the Item column of purchase forms. If you have entered a display name, it will print on purchases instead of the item name when Basic printing is used.
- itemRevenueCategory: nsResource
- itemType: object
-
- lastModifiedDate Last Modified: string (date-time)
- links Links: nsLink
-
nsLink - location: location
- metaTagHtml Meta Tag HTML: string
-
Enter the Meta Tag HTML you want to appear in the < head > section of this item page. Meta tags enable your Web site to be found by search engines.
- noPriceMessage No Price Message: string
-
If you opted to not show a price online, enter the message that should show instead of the price. For example, you might enter "Call for Price."
- numOfAllowedDownloads Number Of Downloads: integer (int64)
-
Enter the maximum number of times a customer who has purchased this item can download it from the Customer Center. If the same customer purchases this item more than once, the number of available downloads is multiplied by the number of times the item has been purchased.
- offerSupport Offer Support: boolean
-
Check this box to offer support for this particular item. By offering support for items, customers can select on case records which item they are having trouble with.
- onSpecial On Special: boolean
-
If you want to put this item on special, check this box. The item then appears in the Specials category in your store or site.
- outOfStockBehavior: object
-
- id Internal identifier.: string DISABLE , ENABLENMSG , REMOVE , ENABLE , DEFAULT
- refName Reference Name: string
- outOfStockMessage Out Of Stock Message: string
-
You can enter a custom out of stock message for this item. The message here replaces the default out of stock message.
- overallQuantityPricingType: object
-
- id Internal identifier.: string ITEM , PARENT , SCHEDULE
- refName Reference Name: string
- pageTitle Page Title: string
-
Enter the text you want to appear as the page's title for this item. This text appears in the browser tab. Use a descriptive title for the item page, this can help achieve better results with search engine ranking.
- parent: downloadItem
- parentOnly Use as Category Only: boolean
- presentationItem: downloadItem-presentationItemCollection
- price: downloadItem-price
- pricesIncludeTax Prices Include Tax: boolean
- pricingGroup: pricingGroup
- quantityPricingSchedule: nsResource
- rate Price: number (double)
- rateIncludingTax Price Including Tax: number (double)
- refName Reference Name: string
- residual Residual: number (double)
- revRecForecastRule: nsResource
- revReclassFxAccount: account
- revenueAllocationGroup: nsResource
- revenueRecognitionRule: nsResource
- salesDescription Sales Description: string
-
Enter a sales description for this item. You can enter letters and numbers. There is a 999 character limit. The sales description displays on transactions such as sales orders, cash sales and invoices. If you use the Web Store feature, the sales description displays immediately under the item's store display name on item list pages in your store or site, if you have not entered a store description for an item. Enter the store description on the Store subtab of the item record. The sales description also displays by default when the item is in the Web store shopping cart.
- searchKeywords Search Keywords: string
-
Enter alternative search keywords that customers might use to find this item using your Web store’s internal search. These can include synonyms, acronyms, alternate languages or misspellings. These keywords are seen as equally important as the item name when searches are conducted.
- siteCategory: downloadItem-siteCategoryCollection
- siteMapPriority: object
-
- storeDescription Store Description: string
-
The store description appears under the item's store display name on item list pages in your store or site. You can enter letters, numbers, and basic HTML code. Note: To make the store description display when an item is in the Web store shopping cart, go to Setup > Web Site > Set Up Web Site. Click the Cart subtab, and check the box next to Store Description.
- storeDetailedDescription Detailed Description: string
-
Enter a detailed description for this item. When your customers click an item's store display name for more information, they see this description. You can enter letters, numbers or basic HTML code. If you are using Internet Explorer, you can also clear the View Source box below to enter and format text using the formatting options above. This eliminates the need for HTML code. If you do not see the View Source box, make sure Rich Text Editing is enabled at Home > Set Preferences > Appearance.
- storeDisplayImage: nsResource
- storeDisplayName Store Display Name: string
-
Enter the name of this item as you want it displayed in your Web site. You can enter up to 250 characters.
- storeDisplayThumbnail: nsResource
- subsidiary: subsidiaryCollection
- subtype: object
-
- id Internal identifier.: string Sale , Purchase , Resale
- refName Reference Name: string
- upcCode UPC Code: string
-
Enter a maximum of 999 characters in this field to identify an internal name or number to store the item's UPC Code. You can use the text you enter here when adding the item to transactions, searching, or viewing reports. * When you enter text in this field, the SKU/UPC field on item labels displays this UPC Code and prints in UPC bar code format. * When this field is clear, the SKU/UPC field on item labels displays the Item Name/Number and prints in Code-128 bar code format.
- urlComponent URL Component: string
-
Enter a short, descriptive name for this item to appear as part of its URL in the Web store. Setting a name to show in the URL can result in better ranking from search engines. If you leave this field blank, NetSuite terms and numbers are used as identifiers in the URL. Note: Descriptive URL components are case sensitive. Descriptive URLs must match the case used in the URL Component field of an item record to point to the correct page.
- useMarginalRates Use Marginal Rates: boolean
-
Check this box if you want the quantity discounts in the schedule to be applied to each pricing bracket separately. For example, a schedule offers no discount for the first 100 items sold and a 5% discount if more than 100 are sold. If 150 items are sold, the first 100 are at normal price, and the other fifty items are sold at 5% discount. Leave this box clear if you want the discount to apply to all of the items sold.
downloadItem-accountingBookDetailCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: downloadItem-accountingBookDetailElement
-
downloadItem-accountingBookDetailElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
downloadItem-accountingBookDetailElement
This record is available as a beta record.
- accountingBook: accountingBook
- amortizationTemplate: amortizationTemplate
- createExpensePlansOn: nsResource
- createRevenuePlansOn: nsResource
- links Links: nsLink
-
nsLink - refName Reference Name: string
- revRecForecastRule: nsResource
- revRecSchedule: revRecTemplate
- revenueRecognitionRule: nsResource
- sameAsPrimaryAmortization Same as Primary Book Amortization: boolean
- sameAsPrimaryRevRec Same as Primary Book Rev Rec: boolean
downloadItem-presentationItemCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: downloadItem-presentationItemElement
-
downloadItem-presentationItemElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
downloadItem-price
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: downloadItem-priceElement
-
downloadItem-priceElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
downloadItem-priceElement
This record is available as a beta record.
- currencyPage: currency
- discountDisplay Default Discount %: number (double)
- isInactive Inactive: boolean
-
When you check this box, this item will no longer appear on a list unless you check the Show All box at the bottom of the list page.
- links Links: nsLink
-
nsLink - price Amount: number (double)
- priceLevel: priceLevel
- priceLevelName Price Level: string
- priceQty Sequence Number: integer (int64)
- quantity: object
-
- value Value: string
- refName Reference Name: string
downloadItem-siteCategoryCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: downloadItem-siteCategoryElement
-
downloadItem-siteCategoryElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
downloadItem-siteCategoryElement
This record is available as a beta record.
- category: nsResource
- links Links: nsLink
-
nsLink - refName Reference Name: string
- webSite: webSite
downloadItemCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: downloadItem
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
downloadItem - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
emailTemplate
- addCompanyAddress Add Company Address to Message Footer in Bulk Merges: boolean
-
Check this box if you want your company's address shown in the footer of email sent with this template.
- addUnsubscribeLink Add Unsubscribe Link to Message Footer in Bulk Merges: boolean
-
Check this box if you want to have a link to the Campaign Subscription Center added to the footer of email messages sent with this template through bulk email operations.
- content Content: string
-
If you are using a prepared HTML or text file for your e-mail template, the text appears here. You can enter the template text in this field instead of preparing the template file beforehand. If your template contains HTML, you must check the View as HTML box below to enter or paste in your template. You can also clear the View as HTML box below to enter and format text using the formatting options above. This eliminates the need for HTML code. If you select a file after entering text in this field, the template file overrides what is entered in this field.
- description Description: string
-
Enter a description for this email template. This description does not appear in the email you send with the template.
- externalId External ID: string
- id Internal ID: string
- isAutoConverted Automatically Converted Template: boolean
-
This is selected if the template has been automatically converted from a different format.
- isInactive Inactive: boolean
-
Check this box to inactivate this template. Inactive templates cannot be used to send email.
- isPrivate Private: boolean
-
Check this box to make this template available only to you.
- links Links: nsLink
-
nsLink - mediaItem: nsResource
- name Name: string
-
Enter a name for this template. This name appears on the list of templates you select when sending an e-mail message to a contact.
- package App ID: string
- publisherid Publisher ID: string
- recordType Record Type: string
-
Entity – records relating to people or organizations such as company, contact, vendor, and employee records. e.g. most valuable customer emails, request for information replies, event invitations. Transaction - records containing or referring to financial exchanges between your business, customers, vendors etc. e.g. customer refund email, rebate information. Custom Record - any record type that you've created specifically for your business. e.g. warranty claims, new product feature updates. Case - records relating to Customer Service cases. e.g. requests for further information.
- refName Reference Name: string
- restrictToGroup: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- scriptid ID: string
-
Type a script ID for this email template.
- subject Subject: string
-
Enter a default subject for e-mail generated by this template. You can edit the subject for individual e-mail messages or e-mail merge operations.
- subscription: nsResource
- templateType Template Type: string
- templateVersion Version: string
- typeName: object
-
- id Internal identifier.: string GNCTEMPLATE , PDF , HCM , MAIL , KUDOS , SYSTEMEMAIL , EMAIL , ONLINEFORM , FAX , CAMPAIGN
- refName Reference Name: string
- usesMedia: object
-
- id Internal identifier.: string T , F
- refName Reference Name: string
emailTemplateCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: emailTemplate
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
emailTemplate - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
employee
- accountNumber Account: string
-
If you, your payroll service, or other benefits provider assigns account numbers to your employees, enter that account number here. This field is required for the Online Bill Pay feature.
- accruedTime: employee-accruedTimeCollection
- addressBook: employee-addressBookCollection
- adpid ADP Id: string
- aliennumber Alien Number: string
-
Enter the employee's alien number. This is required only if the employee's work status is Alien authorized to work. The alien number is located in Section 1 of the completed I-9 form.
- approvallimit Expense Approval Limit: number (double)
-
In the Expense Approval Limit field, enter the maximum amount this employee is allowed to approve on an expense report when specified as an approver for another employee. Expenses that exceed this amount must be approved by another supervisor or approver with a sufficient approval limit.
- approver: employee
- authworkdate Work Authorization Expiry Date: string (date)
-
Enter the date through which the employee is authorized to work until. This is required only if the employee's work status is Alien authorized to work. This date is located in Section 1 of the completed I-9 form.
- autoName Auto: boolean
-
Clear this box to manually enter an ID for this record. If you leave this box checked, NetSuite assigns an ID for this record based on your settings at Setup > Company > Auto-Generated Numbers.
- basewage Base Wage: number (float)
-
Enter the employee's base wage. Depending on the selected base wage type, enter the hourly, monthly, or yearly total.
- basewagetype: object
-
- id Internal identifier.: string annualsalary , hourly , monthlysalary
- refName Reference Name: string
- billingClass: billingClass
- birthdate Birth Date: string (date)
-
Enter the employee's date of birth.
- bonustarget Bonus Target: number (float)
-
Enter the employee's target bonus amount as either a percentage of the employee's base wage or a specific amount.
- bonustargetcomment Target Comments: string
-
Optionally, you can enter additional relevant information about the employee's bonus target here.
- bonustargetpayfrequency: object
-
- id Internal identifier.: string one_time , annually , monthly , quarterly
- refName Reference Name: string
- bonustargettype: object
-
- id Internal identifier.: string percentage , amount
- refName Reference Name: string
- btemplate Employee is Template: string
- campaigns: employee-campaignsCollection
- changedetails Change Reason Details: string
-
Enter details that further describe the effective-dated change.
- class: classification
- comments Notes: string
-
Enter other information you want to track for this employee.
- companyContribution: employee-companyContributionCollection
- concurrentwebservicesuser Concurrent Web Services User: boolean
-
A user type that allows concurrent web services access into NetSuite. Check this box to allow a user to have standard UI login access plus up to ten concurrent web services sessions.
- conflictresults: string
- corporatecards: employee-corporatecardsCollection
- currency: currency
- currencylist: employee-currencylistCollection
- customForm: object
-
- id Internal identifier.: string -10010 , -10011 , -10
- refName Reference Name: string
- dateCreated Date Created: string (date-time)
-
The date and time at which the Employee Record was created.
- deduction: employee-deductionCollection
- defaultAddress Default Address: string
- defaultBillingAddress Default Billing Address: string
- defaultJobResourceRole: nsResource
- defaultShippingAddress Default Shipping Address: string
- defaultacctcorpcardexp: account
- defaultexpensereportcurrency: currency
- department: department
- directDepositList: employee-directDepositListCollection
- driverslicensenumber Driver's License Number: string
- earning: employee-earningCollection
- effectivedatemode: object
-
- id Internal identifier.: string PAST , CURRENT , FUTURE
- refName Reference Name: string
- email Email: string
-
Enter your employee's email address. If you allow your employees to track time or enter expense reports online, this will become part of their access codes.
- empcenterqty Employee Center Current: string
- empcenterqtymax EMP_CENTER_MAX: string
- employeecertificate Reciprocal Agreement With {1}: boolean
- employeechangereason: nsResource
- employeeftestatus: object
-
- id Internal identifier.: string NOT_APPLICABLE , NOT_ASSIGNED , UNDER_ALLOCATED , FULLY_ALLOCATED , OVER_ALLOCATED
- refName Reference Name: string
- employeestatus: nsResource
- employeetype: nsResource
- empperms: employee-emppermsCollection
- enabledeductionlimits Preference Field: boolean
- entityId Entity ID: string
-
If the Auto box is not checked, manually enter an ID for this record. If the Auto box is checked, NetSuite assigns an ID for this record based on your settings at Setup > Company > Auto-Generated Numbers.
- ethnicity: nsResource
- expenselimit Expense Limit: number (double)
-
In the Expense Limit field, enter the amount this employee can expense without approval from a supervisor or approver.
- externalId External ID: string
- fax Fax: string
-
Enter a fax number for this record. You should enter the fax number exactly as it must be dialed. If a '1' is required to fax to this number, be sure to include it at the beginning of the number. The number you enter here automatically appears in the To Be Faxed field of transactions when you select this employee. To fax NetSuite forms, an administrator must first set up fax service at Setup > Company > Printing, Fax & Email Preferences.
- firstName First Name: string
-
Enter the employee's first name here. What you enter here automatically appears first in the Employee field. The first letter of what you enter here appears in the Initials field. This field is required for the Online Bill Pay feature.
- fulluserqty FullUser current: string
- fulluserqtymax FullUser max: string
- gender: object
-
- id Internal identifier.: string b , ns , nb , m , f
- refName Reference Name: string
- giveAccess Login Access: boolean
-
Check this box to give your employee access to NetSuite. Then, assign a role to customize the level of access. You can assign multiple roles. To let your employee track time and enter expense reports, select the Employee Center role.
- globalSubscriptionStatus: object
-
- id Internal identifier.: string 1 , 2 , 3 , 4
- refName Reference Name: string
- hireDate Hire Date: string (date)
-
Enter the date this employee was hired.
- homePhone Home Phone: string
-
Enter this employee's home phone number here.
- i9verified I-9 Verified: boolean
-
Check this box if the employee has completed an I-9 form.
- id Internal ID: string
- image: nsResource
- inheritiprules Inherit Allowed IP Addresses from Company: boolean
-
Check this box to allow this employee NetSuite login access at the IP addresses listed at Setup > Company Information. If you check this box, this employee has access to NetSuite at every company computer with access unless you specify IP address(es) in the IP Address Restriction field. If you do not check this box, you must enter an IP Address where this employee can log in in the field below, or this employee will not be able to log in to NetSuite.
- initials Initials: string
-
NetSuite automatically completes this field as you enter first, middle and last names. If you want to make changes to an employee's initials, enter up to three letters in this field.
- ipaddressrule Extra Allowed IP Addresses: string
-
Enter the IP address(es) where you want this employee to have access in the following formats: 1. A dotted decimal IP address such as 123.456.78.90 2. A range of IP addresses entered in dotted decimal with a dash and no spaces between such as 123.45.567.8-123.45.568.9 3. A list of IP address separated by spaces or commas such as 123.456.78.90, 123.546.768.97, . . . 4. An IP address and mask, such as 209.209.48.32/255.255.0.0. 5. The text "ALL" -- allows all IP addresses You can enter up to 1024 characters. If you do not enter an IP Address here, you must check the Inherit IP Rules from Company box, or this employee will no longer be able to log in to NetSuite.
- isInactive Is Inactive: boolean
-
Check this box to inactivate this employee record. Inactivated records no longer appear in lists or as choices anywhere in your account. To view inactivated employee records or reactivate them, go to Lists > Employees > Employees, and check the Show Inactives box.
- isJobManager Job Manager: boolean
-
Check this box to mark the employee as a Project Manager. The employee will be added to Project Manager dropdown list in Primary Information of the project record. (This field is enabled when employee is marked as Project Resource.)
- isJobResource Job Resource: boolean
-
Check this box to enable this employee to be added as a resource on projects and tasks.
- isempcenterqtyenforced Employee Center Enforce: string
- isfulluserqtyenforced FullUser enforce: string
- isretailuserqtyenforced RetailUser enforce: string
- issalesrep Sales Rep: boolean
-
Check this box to mark this employee as a sales representative. Sales representatives are listed in the sales rep dropdown list for sales order forms and for sales territory assignments.
- issupportrep Support Rep: boolean
-
Check this box to mark this employee as a support representative. Support representatives are listed in the assigned to dropdown list for case forms and in the support rep dropdown list for support territory assignments.
- job: nsResource
- jobdescription Job Description: string
-
Enter a description of the duties related to the job this person currently performs.
- jobemploymentcategory: object
-
- id Internal identifier.: string -10 , -11
- refName Reference Name: string
- jobid Job ID: string
- laborCost Labor Cost: number (double)
-
Enter the employee's hourly overhead labor rate. This rate is used to calculate the estimated cost of jobs this employee works on.
- laborcategory: nsResource
- lastModifiedDate Last Modified Date: string (date-time)
- lastName Last Name: string
-
Enter the employee's last name here. What you enter here automatically appears last in the Employee field. The first letter of what you enter here appears in the Initials field. This field is required for the Online Bill Pay feature.
- lastPaidDate Last Paid Date: string (date)
-
Enter the last paid date for this employee. The last paid date is the date of the actual pay run which usually take place before the checks are issued. For example, the date on your most recent paycheck is October 13. This check includes payment for hours worked September 24 - October 7. The pay run is processed on October 7 but the check is issued on October 13. However, since the last paid date is the date of the pay run, you shoud enter October 7 as the last paid date. Note: You only have to enter this date once for each employee. This field is auto-updated with the most recent last paid date each time you run payroll.
- lastReviewDate Last Review Date: string (date)
-
Enter the date of this person's last salary evaluation.
- links Links: nsLink
-
nsLink - location: location
- maritalstatus: nsResource
- middleName Middle Name: string
-
Enter a middle name or initial here. What you enter here automatically appears second in the Employee field. The first letter of what you enter here appears in the Initials field. Enter up to 25 characters in this field.
- mobilePhone Mobile Phone: string
-
Enter this employee's mobile or cell phone number here.
- nextReviewDate Next Review Date: string (date)
-
Enter the date of this person's next salary evaluation.
- officePhone Office Phone: string
-
Enter this employee's office phone number here.
- overridecatchupamount Override Catch-Up Limit: number (double)
- overridecatchupcheckbox Override Catch-Up Limit: boolean
- overrideelectivedeferralamount Override Elective Deferral Limit: number (double)
- overrideelectivedeferralcheckbox Override Elective Deferral Limit: boolean
- overtimepolicy: nsResource
- passportnumber Passport Number: string
- password Password: string
-
The Password and Confirm Password fields are only available if you checked the Manually Assign or Change Password box. Enter a password for the employee. As you type, the characters are validated against the password policy criteria, and the results displayed. You must tell the employee the password you assigned. Do not send the password by email. When you assign a password manually, you should also check the Require Password Change on Next Login box. For more information, see the help topic Password Requirements and Policies in NetSuite.
- password2 Confirm Password: string
-
Re-enter the employee's password for verification. When you manually assign a password, you need to tell the employee the login information. Do not send the password by email.
- payFrequency: object
-
- id Internal identifier.: string SEMIMONTHLY , WEEKLY , ANNUALLY , QUARTERLY , QUADWEEKLY , DAILY , NEVER , SEMIANNUALLY , MONTHLY , BIMONTHLY , BIWEEKLY
- refName Reference Name: string
- phone Phone: string
-
Enter a phone number for your employee. This field is required for Online Bill Pay enabled employees.
- phoneticName Furigana: string
-
Enter the furigana character you want to use to sort this record.
- purchaseorderapprovallimit Purchase Approval Limit: number (double)
-
In the Purchase Approval Limit field, enter the maximum amount an employee is allowed to approve on a purchase request when specified as an approver for an employee.
- purchaseorderapprover: employee
- purchaseorderlimit Purchase Limit: number (double)
-
In the Purchase Limit field, enter the amount this employee can purchase without approval from a supervisor or approver.
- rate Hourly Rate: number (double)
-
Enter the cost, in dollars, per hour.
- rates: employee-ratesCollection
- refName Reference Name: string
- releasedate Termination/Release Date: string (date)
-
Enter this person's last date of employment.
- requirePwdChange Require Password Change On Next Login: boolean
-
Check this box to require this user to change their password on their next login to NetSuite. When the user next logs in, they see the Change Password page and cannot access other NetSuite pages until a new password is created and saved. Requiring this action protects your account from unauthorized access using generic passwords and prepares your account for an audit. The Require Password Change on Next Login box never displays as checked. When you check this box and save the record, an internal flag is set. When the password change occurs, the flag is cleared. If you later check the box again and save the record, the internal flag is reset to require another password change.
- residentstatus: nsResource
- retailuserqty RetailUser current: string
- retailuserqtymax RetailUser max: string
- roles: employee-rolesCollection
- salesrole: salesRole
- salutation Mr./Ms...: string
-
Enter the employee's salutation, such as Mr. or Ms., here.
- sendEmail Send New Access Notification Email: boolean
-
Check this box to send an automatic email notifying this employee of access privileges to NetSuite. The standard NetSuite email message also contains a link to let the user create a password. If you do not check this box, you must check the Manually Assign or Change Password box. You must create the password, and tell the user the password, and when and how to log in. For security reasons, do not send the password by email.
- socialsecuritynumber Social Security Number: string
-
Enter this employee's social security number here in the following format: 123-45-6789.
- startdatetimeoffcalc Start Date for Time-Off Calculations: string (date)
-
Enter the start date for the purpose of time-off calculations. The date entered here is used to calculate the number of days this employee is entitled to time-off, based on the minimum and maximum tenures set in the time-off plan. If there is no value specified in this field, this employee cannot be assigned a time-off plan.
- subscriptionMessageHistory: employee-subscriptionMessageHistoryCollection
- subscriptions: employee-subscriptionsCollection
- subsidiary: subsidiary
- supervisor: employee
- targetUtilization Target Utilization: number (double)
-
Select the required utilization for this resource.
- template: employee
- terminationbydeath Termination Due To Death: boolean
- terminationcategory: object
-
- id Internal identifier.: string VOLUNTARY , INVOLUNTARY
- refName Reference Name: string
- terminationdetails Termination Details: string
-
Enter details of the termination.
- terminationreason: nsResource
- terminationregretted: object
-
- id Internal identifier.: string NO , UNSPECIFIED , YES
- refName Reference Name: string
- timeapprover: employee
- timeoffplan: nsResource
- title Job Title: string
-
Enter this employee's official job title here.
- usePerquest Include in Payroll: boolean
-
Include this employee in Payroll. To include an employee in Payroll, you also need to enter an address, a hire date, and a Social Security Number. For more information, see the help topic Including an Employee in Payroll. This employee will also be included in the Employee list on payroll forms and reports.
- useTimedata: object
-
- id Internal identifier.: string T , F
- refName Reference Name: string
- visaexpdate Visa Expiration Date: string (date)
-
Enter the expiration date of the employee's visa. This information can be obtained from the employee's passport.
- visatype: nsResource
- wasempcenterhasaccess Employee Center Has Access: string
- wasfulluserhasaccess FullUser hasaccess: string
- wasinactive wasinactive: string
- wasretailuserhasaccess RetailUser hasaccess: string
- workCalendar: nsResource
- workassignment: object
-
- id Internal identifier.: string job , position
- refName Reference Name: string
- workplace: workplace
employee-accruedTimeCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: employee-accruedTimeElement
-
employee-accruedTimeElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
employee-accruedTimeElement
- accrualMethod: object
-
- id Internal identifier.: string StartYear , EveryPeriod , Hourly
- refName Reference Name: string
- accrualRate Accrual Rate: number (float)
- accruedHours Accrued Hours: number (float)
- effectiveDate Effective Date: string (date)
- expirationDate Expiration Date: string (date)
- inactive Inactive: boolean
- links Links: nsLink
-
nsLink - maximumAccruedHours Maximum Hours: number (float)
- monetaryRate Monetary Rate: number (double)
- payType: object
-
- payrollItem: payrollItem
- peiKey ID: string
- piName Name: string
- refName Reference Name: string
- resetAccruedHoursAtYearEnd Reset at Year End: boolean
employee-addressBook-addressBookAddress
- addr1 Address 1: string
- addr2 Address 2: string
- addr3 Address 3: string
- addrPhone Phone: string
- addrText Address: string
- addressee Addressee: string
- attention Attention: string
- city City: string
- country: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- externalId External ID: string
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - override Override: boolean
- refName Reference Name: string
- state State/Province: string
- zip Zip: string
employee-addressBookCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: employee-addressBookElement
-
employee-addressBookElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
employee-addressBookElement
- addressBookAddress: employee-addressBook-addressBookAddress
- addressBookAddress_text Address: string
- addressId Internal ID: string
- defaultBilling Home: boolean
- defaultShipping Default Shipping: boolean
- id ID: integer (int64)
- internalId Internal ID: integer (int64)
- label Label: string
- links Links: nsLink
-
nsLink - refName Reference Name: string
employee-campaignsCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: employee-campaignsElement
-
employee-campaignsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
employee-companyContributionCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: employee-companyContributionElement
-
employee-companyContributionElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
employee-companyContributionElement
- derivedratemultiplier Rate Multiplier: number (double)
- effectiveDate Effective Date: string (date)
- expirationDate Expiration Date: string (date)
- inactive Inactive: boolean
- limit Limit: number (double)
- links Links: nsLink
-
nsLink - payrollItem: payrollItem
- peiKey ID: string
- piName Name: string
- pinamelinked Derived From: string
- rate Rate: number (double)
- refName Reference Name: string
- w2name W-2: string
employee-corporatecardsCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: employee-corporatecardsElement
-
employee-corporatecardsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
employee-corporatecardsElement
- corporatecardprofile: nsResource
- embossedname Name on Card: string
- expiration Expiration Date: string (date)
- links Links: nsLink
-
nsLink - refName Reference Name: string
employee-currencylistCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: employee-currencylistElement
-
employee-currencylistElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
employee-deductionCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: employee-deductionElement
-
employee-deductionElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
employee-deductionElement
- derivedratemultiplier Rate Multiplier: number (double)
- effectiveDate Effective Date: string (date)
- expirationDate Expiration Date: string (date)
- inactive Inactive: boolean
- limit Limit: number (double)
- links Links: nsLink
-
nsLink - payrollItem: payrollItem
- peiKey ID: string
- piName Name: string
- pinamelinked Derived From: string
- rate Rate: number (double)
- refName Reference Name: string
employee-directDepositListCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: employee-directDepositListElement
-
employee-directDepositListElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
employee-directDepositListElement
- accountprenoted Prenoted: boolean
- accountstatus Status: string
- amount Amount: number (double)
- bankName Bank Name: string
- bankaccountnumber Account Number: string
- bankroutingnumber Routing Number: string
- id ID: string
- inactive Inactive: boolean
- links Links: nsLink
-
nsLink - netaccount Net Account: boolean
- refName Reference Name: string
- savingsaccount Savings Account: boolean
employee-earningCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: employee-earningElement
-
employee-earningElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
employee-earningElement
- defaultEarning Default: boolean
- defaultHours Default Hours: number (float)
- derivedratemultiplier Rate Multiplier: number (float)
- effectiveDate Effective Date: string (date)
- expirationDate Expiration Date: string (date)
- inactive Inactive: boolean
- links Links: nsLink
-
nsLink - payrate Rate: number (float)
- payrollItem: payrollItem
- paytype: object
-
- peiKey ID: string
- piName Name: string
- pinamelinked Derived From: string
- primaryEarning Primary: boolean
- refName Reference Name: string
employee-emppermsCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: employee-emppermsElement
-
employee-emppermsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
employee-emppermsElement
- links Links: nsLink
-
nsLink - name Name: string
- permKey1: object
-
- id Internal identifier.: string LIST_UPSELLWIZARD , ADMI_PI_REMOVAL_RUN , REPO_BALANCESHEET , REPO_ISSUE , LIST_SALESCAMPAIGN , EDIT_FISCALCALENDAR , LIST_WORKPLACE , REPO_TAX , TRAN_ORDERRESERVATION , LIST_SCSNAPSHOT , LIST_RESOURCE , LIST_BASICGOVERNMENTISSUEDIDS , REGT_ACCTREC , REGT_DEFEREXPENSE , ADMI_EMPLOYEE_EXPENSE_SOURCE , LIST_FAXTEMPLATE , REPO_PROJECT_ACCOUNTING , ADMI_LOGIN_OAUTH2 , REPO_AR , TRAN_FXREVAL , REPO_AP , ADMI_CUSTOMSCRIPT , ADMI_ENTITYACCOUNTMAPPING , ADMI_MHLEVEL , TRAN_GENERATECHARGES , TRAN_SALESORDCOMMITREVENUE , ADMI_TELEPHONY_SETUP , LIST_SHIPPARTSHIPMENT , ADMI_MANAGEROLES , REGT_LONGTERMLIAB , ADMI_CASETYPE , REGT_DEFERREVENUE , ADMI_SFASETUP , ADMI_ADVANCED_TEMPLATES , LIST_TAXENGINESELECTION , REPO_PAYROLL , TRAN_CHARGE , ADMI_SUITEANALYTICSCONNECT , TRAN_BINWKSHT , REGT_EQUITY , TRAN_VPREPAPPRV , LIST_COMPANY_FEATURE_SETUP , REGT_ACCTPAY , TRAN_INTERCOADJ , TRAN_STATUSVP , REGT_INCOME , LIST_TIMEOFFADMIN , ADMI_CUSTCOLUMNFIELD , REPO_PAYROLLW2 , REPO_REVREC , LIST_ITEM_COLLECTION , LIST_ZONE , ADMI_CSP_SETUP , ADMI_PROJECTTEMPLATE , TRAN_SALESORDAPPRV , TRAN_ORDRESVAPPRV , ADMI_TIMEMODIFICATION , TRAN_TAXLIAB , ADMI_TWOFACTORAUTH , ADMI_IMPORTXML , LIST_ITEMPROCESSGROUP , REPO_WEBSITE , TRAN_PEJRNL , LIST_ALLGOVERNMENTISSUEDIDS , LIST_SUPPLY_REALLOCATION , TRAN_COPY_BUDGET , LIST_IMPORTED_EMPLOYEE_EXPENSE , ADMI_CUSTRECORDFORM , ADMI_OPENIDSSO , LIST_PDFTEMPLATE , TRAN_WORKORDISSUE , ADMI_CUSTOMER_SEGMENTS , TRAN_OPPRTNTY , ADMI_STATETAXIMPORT , ADMI_ACCTSETUP , LIST_PLANNEDSTANDARDCOST , ADMI_ENABLEFEATURES , LIST_REVRECFIELDMAPPING , LIST_PDFMESSAGE , SYSTEM_STATUS , TRAN_PRINTCHECKSFORMS , ADMI_ALLOW_JS_HTML_UPLOAD , LIST_ENTITY_DUPLICATES , TRAN_BLANKORDAPPRV , TRAN_TIMEBILL , TRAN_ITEMRCPT , ADMI_CONVERTCLASSES , ADMI_CUSTCATEGORY , ADMI_SUBSIDIARYSETTINGSMANAGER , TRAN_OWNTRNSF , ADMI_CUSTEMAILLAYOUT , ADMI_ACCOUNTINGBOOK , TRAN_RECEIVEINBOUND , LIST_SUBSCRIPTIONCHANGEORDER , ADMI_CUSTOMERRULE , ADMI_CUSTFORM , ADMI_FFTEXCEPTIONREASON , TRAN_FFTREQ , TRAN_RECOG_GIFTCERT_INCOME , LIST_BOM , LIST_REVENUEELEMENT , TRAN_CHECK , LIST_SITEEMAILTEMPLATE , ADMI_VIEWACHACCOUNT , TRAN_WOCLOSE , ADMI_PENDINGBOOKJOURNAL , ADMI_BANK_CONNECTIVITY_CONFIG , LIST_INTERNALPUBLISH , TRAN_YTDADJST , ADMI_CONSOLIDATED , LIST_ITEM_REVISION , REPO_INTEGRATION , ADMI_ADVANCED_ORDER_MANAGEMENT , LIST_STOREITEMLISTLA , TRAN_VENDBILL , ADMI_TWOFACTORAUTHBASE , LIST_STORETAB , ADMI_CASEPRIORITY , ADMI_CAMPAIGNEMAIL , ADMI_WORKFLOW , LIST_SHORTCUT , TRAN_XMLDETAIL , TRAN_STATEMENT , LIST_CARDHOLDERAUTHENTICATION , LIST_HCMPOSITION , LIST_TABLEAU_WORKBOOK_EXPORT , LIST_PRICEBOOK , LIST_PROMOTIONCODE , LIST_CRMGROUP , ADMI_EMPLCATEGORY , LIST_EARLIEST_AVAILABILITY , ADMI_ITEMACCOUNTMAPPING , REPO_PANDL , TRAN_RTNAUTHCREDIT , LIST_PHASEDPROCESS , LIST_REVRECTREATMENT , LIST_MATERIALREQUIREMENTSPLAN , ADMI_TAXPERIODS , ADMI_PROVSN_TSTDRV , TRAN_TRANSFER , ADMI_SALESCHANNEL , ADMI_CENTERLINK , LIST_ONBOARDING_TASK , ADMI_CUSTTRANFIELD , LIST_EMPLOYEECHANGEREASON , LIST_EMPLOYEE , TRAN_CUSTRFND , LIST_CONTACTROLE , REGT_OTHEXPENSE , REPO_CUSTOMIZATION , REPO_GL , LIST_CAMPAIGNHISTORY , LIST_INVCOSTTEMPLATE , LIST_UPSELL , TRAN_BLANKORD , LIST_EMPLOYEESSN , TRAN_EDITBANKINGINFO , ADMI_CASERULE , LIST_SYSTEMEMAILTEMPLATE , LIST_NEWSITEM , LIST_QUANTITYPRICINGSCHEDULE , TRAN_SALESORDFULFILL , REGT_OTHINCOME , TRAN_WORKORDCOMPLETE , GRAP_INC , ADMI_CUSTLIST , LIST_CASE , ADMI_ENTITYSTATUS , TRAN_CASHRFND , LIST_MAILMERGE , TRAN_PURCHCON , LIST_COSTEDBOMINQUIRY , LIST_INFOITEMFORM , TRAN_STATUSEFT , LIST_ITEM , LIST_RSSFEED , LIST_TAXSCHEDULE , LIST_RECOGNITIONEVENTTYPE , LIST_PAYMENT_CARD_TOKEN , ADMI_EMAILPWD , LIST_PRICEPLAN , ADMI_DEVICE_ID , LIST_TALENT_ADMINISTRATION , ADMI_CASESTATUS , ADMI_REPOLAYOUTS , LIST_TEGATAACCOUNT , LIST_ISSUE , ADMI_ESCALATIONTERRITORY , ADMI_STORESEARCH , REPO_EMAIL , TRAN_POSTVENDORBILLVARIANCE , TRAN_TRNFRORD , ADMI_TSTDRV_MASTER , ADMI_STORESETUP , ADMI_SUITEAPP_MANAGEMENT , LIST_VENDOR , ADMI_APPDEFPKG , LIST_FILECABINET , ADMI_SUBLIST , TRAN_PURCHREQAPPRV , LIST_COMPETITOR , TRAN_INVADJST , TRAN_MGRFORECAST , TRAN_SALESORDINVOICE , LIST_TRANNUMBERAUDITLOG , ADMI_LOGIN_OAUTH , LIST_ITEMTEMPLATE , TRAN_AUTO_CASH , ADMI_CREATEJOBSFROMSALESTRANS , LIST_CAMPAIGN , ADMI_NSASOIDCPROVIDER , REPO_PURCHASEORDER , ADMI_MANAGE_OAUTH2 , LIST_CONTACT , LIST_MAILMESSAGE , ADMI_INTEGRAPP , LIST_PLANNEDREVENUE , TRAN_TIMEPOST , LIST_REVRECTREATMENTRULE , REGT_OTHCURRASSET , LIST_WBS , TRAN_PAYMENTRESULTPREVIEW , TRAN_PURCHORDRECEIVE , ADMI_CSVIMPORTPREF , TRAN_INVREVAL , ADMI_BUNDLERAUDITTRAIL , LIST_FINHISTORY , TRAN_CUSTINVCAPPRV , ADMI_CUSTEVENTFIELD , LIST_MASSUPDATES , LIST_REVENUERECOGNITIONRULE , REPO_SNAPSHOTLEAD , ADMI_EMPLOYEECENTERPUBLISHING , ADMI_SWAPPRICES , ADMI_PERIODCLOSING , TRAN_FINCHRG , ADMI_PERIODOVERRIDE , ADMI_SUITECOMMERCEANALYTICS , TRAN_SALESORD , ADMI_ACCOUNTING , ADMI_CUSTRECORD , ADMI_ACCOUNTINGLIST , LIST_WORKCALENDAR , ADMI_FINCHARGEPREF , LIST_JOBREQUISITION , ADMI_CUSTOMSUBLIST , ADMI_MANAGEUSERS , TRAN_BALJRNAL , REGT_CREDCARD , LIST_COMPONENTWHEREUSEDINQUIRY , ADMI_MOBILE_ACCESS , LIST_WEBSITE , REPO_QUOTA , ADMI_RESTWEBSERVICES , REPO_SNAPSHOTCASE , LIST_EMPLOYEECHANGEREQUEST , LIST_REALLOCATE_ORDER_ITEM , ADMI_CLASSESTOLOCS , TRAN_WORKORDMARKBUILT , LIST_GLLINESAUDITLOGSEG , TRAN_ALLOCSCHEDULE , TRAN_TAXPYMT , ADMI_KEYS , LIST_INFOCATEGORY , ADMI_EMPLOYEELIST , REPO_CASHFLOW , LIST_PICKTASK , ADMI_PROJECT_ACCOUNTING_SETUP , LIST_COLORTHEME , REPO_WEBSTORE , ADMI_TRAN_ACCOUNTING_RULES , TRAN_APPROVEVP , TRAN_CARDRFND , TRAN_EXPREPT , ADMI_GAINLOSSACCTMAPPING , REPO_PAYROLLHIDEFINEMPINFO , LIST_COMPANY , LIST_CALENDAR , ADMI_CUSTFIELD , TRAN_LIABPYMT , REPO_WORKFORCEANALYTICS , ADMI_ORDERALLOCATIONSTRATEGY , ADMI_TEAMSELLINGCONTRIBUTION , TRAN_VENDAUTHAPPRV , LIST_REVENUEPLAN , REGT_UNBILLEDREC , ADMI_CERTIFICATES , ADMI_MANAGE_OAUTH_TOKENS , LIST_SUBSIDIARY , LIST_CRMTEMPLATE , ADMI_AUDITLOGIN , ADMI_ISSUEOBFUSCATEMASSUPDATE , REPO_SCHEDULE , ADMI_OPENIDSSOSETUP , ADMI_BALANCE_TRX_BY_SEGMENTS , LIST_EMPLOYEE_SELF , ADMI_SUPPORTSETUP , TRAN_NETTSTLM , TRAN_WORKORD , TRAN_RTNAUTHRECEIVE , ADMI_CASETERRITORY , ADMI_IMPORTCSVFILE , ADMI_PARTNERCONTRIBUTION , REPO_AUTHPARTNERCOMMISSION , REPO_PAYROLLHOURSEARNING , ADMI_CLOSE , ADMI_CREATEPEER , LIST_TAXDETAILSTAB , LIST_SHIPITEM , ADMI_KERNEL , LIST_BIG_SEARCH , GRAP_NETWORTH , ADMI_CUSTADDRESSFORM , NONE_NEEDED , ADMI_ACH , TRAN_REVARRNG , ADMI_GLOBALACCOUNTMAPPING , TRAN_REVCONTR , LIST_PROJECTTASK , TRAN_RTNAUTHAPPRV , ADMI_RECSYS , ADMI_CUSTBODYFIELD , TRAN_REVCOMRV , LIST_TEMPLATE_CATEGORY , LIST_REVRECVSOE , REPO_DEFERREDEXPENSE , LIST_KUDOS , LIST_BONUS , LIST_PARTNERCOMMISSNRULES , LIST_SENTEMAIL , TRAN_VENDAUTHRETURN , ADMI_PAYMENT_LINK_SETUP , REPO_PURCHASES , ADMI_SS_NLCORP , LIST_CUSTPROFILE , ADMI_NUMBERING , LIST_DEPARTMENT , TRAN_CARDHOLDERAUTHENTICATION , REGT_PAYROLL , REGT_EXPENSE , REPO_INVENTORY , ADMI_SUBSIDIARYHIERARCHYMOD , TRAN_JOURNALAPPRV , ADMI_PROVSN_NEW_TSTDRV , TRAN_RTNAUTH , TRAN_INVCOUNT , REPO_UNBILLED , TRAN_XCHGREQUEST , LIST_CUSTRECORDENTRY , LIST_MEDIAITEMFOLDER , TRAN_PRICELIST , ADMI_CUSTLAYOUT , ADMI_WEBSERVICES , ADMI_CUSTOTHERFIELD , TRAN_APPROVEEFT , TRAN_BUILD , TRAN_VENDAUTH , TRAN_CUSTDEP , LIST_WORKASSIGNMENT , LIST_ACCOUNT , TRAN_WAVE , ADMI_OUTLOOKINTEGRATION , LIST_LOCATION , ADMI_CREDITCARD , ADMI_IMPORTOVERRIDESSTRIG , ADMI_ANALYTICS , LIST_KEYS , REPO_TRIALBALANCE , LIST_ALLOCSCHEDULE , ADMI_CUSTENTRYFORM , LIST_RELATEDITEMS , REPO_TRAN , LIST_SUBSCRIPTIONPLAN , ADMI_TYPE , LIST_ADDRESS , LIST_SUBSCRIPTION , REGT_OTHCURRLIAB , TRAN_EDITPROFILE , TRAN_WORKORDBUILD , LIST_EXPENSEPLAN , ADMI_DELETEDRECORD , TRAN_TIMER , LIST_ONBOARDING_ADMINISTRATION , TRAN_POSTPERIODS , TRAN_TRNFRORDAPPRV , GRAP_EXP , LIST_EXPENSEAMORTIZATIONRULE , TRAN_ESTIMATE , ADMI_UNCATSITEITEMS , ADMI_CUSTITEMFIELD , LIST_CRMMESSAGE , TRAN_CARDHOLDERAUTHEVENT , REPO_PARTNERCOMMISSION , REPO_ANALYTICS , LIST_PROJECT_BUDGET , LIST_CONVERTLEAD , TRAN_VPREP , LIST_ITEMPROCESSFAMILY , ADMI_REMINDERS , ADMI_SETUPCOMPANY , ADMI_CASEORIGIN , ADMI_CONVERTLEAD , LIST_INFOITEM , LIST_EMPLOYEE_ADMINISTRATION , TRAN_NETTINGSETTLEMENTAPPRV , ADMI_ACCTPERIODS , ADMI_SS_SCHEDULING , ADMI_WEBSERVICESOVERRIDESSTRIG , LIST_DISTRIBUTIONNETWORK , LIST_SALESROLE , TRAN_VENDPYMT , LIST_TAXITEM , REPO_SALESORDER , LIST_FISCALCALENDAR , TRAN_PARTNERCOMMISSN , TRAN_PURCHORD , ADMI_CAMPAIGNSETUP , ADMI_FINANCIALINSTITUTION , TRAN_WOCOMPL , TRAN_CUSTPYMT , ADMI_PI_REMOVAL_CREATE , LIST_PARTNER , REGT_FIXEDASSET , ADMI_CUSTFIELDTAB , LIST_FAIRVALUEPRICE , LIST_EMAILTEMPLATE , ADMI_PROVSN_QA , LIST_UNIT , TRAN_VENDCRED , REPO_RSRCALLOCATION , LIST_TASK , ADMI_BACKUPEXPORT , ADMI_BILLINGINFO , LIST_FIND , ADMI_DUPLICATESETUP , TRAN_DEPOSIT , TRAN_INVWKSHT , LIST_RSRCALLOCATIONAPPRV , TRAN_VENDBILLAPPRV , REPO_RECONCILE , ADMI_MANAGE_OWN_OAUTH_TOKENS , TRAN_CLEARHOLD , LIST_EMPLOYEEEFFECTIVEDATING , ADMI_CROSSCHARGE , LIST_ONBOARDING_PLAN , LIST_OUTBOUNDREQUEST , ADMI_XMLADPSETUP , LIST_BILLINBOUNDSHIPMENT , ADMI_CUSTITEMNUMBERFIELD , TRAN_WORKORDMARKRELEASED , TRAN_STATUSDD , LIST_CASE_DUPLICATES , LIST_UNDELIVEREDEMAIL , REPO_AMORTIZATION , TRAN_MATCHING_RULES , REPO_NONPOSTING , ADMINDOCS , REPO_SUPPORT , ADMI_SAMLSSOSETUP , LIST_GENERICRESOURCE , ADMI_KPIREPORT , ADMI_SETUPIMAGERESIZE , ADMI_ADMINDOCSEU , TRAN_RFQ , LIST_STORECATEGORY , REPO_RETURNAUTH , ADMI_UNLOCKEDTIMEPERIOD , ADMI_COPYPROJECTTASK , LIST_JOB , ADMI_SAVEDASHBOARD , LIST_GOVERNMENTISSUEDIDTYPE , LIST_EMPLOYEESEPARATION , ADMI_APPPUBLISHER , REGT_BANK , ADMI_OUTLOOKINTEGRATION_V3 , LIST_GENERAL_TOKEN , TRAN_GATEWAYNOTIFICATION , REPO_W4 , TRAN_WORKORDCLOSE , LIST_CATEGORY , ADMI_SAC_READALL , LIST_PROJECTTEMPLATE , TRAN_UNBUILD , LIST_PAYMENT_INSTRUMENTS , ADMI_SNAPSHOTS , ADMI_SALESTERRITORY , LIST_INBOUNDSHIPMENT , LIST_CLASS , REPO_TIME , LIST_SHIPPARTPACKAGE , ADMI_CASEFORM , TRAN_FORECAST , ADMI_UPDATEPRICES , TRAN_CUSTCHRG , TRAN_DEPAPPL , TRAN_APPROVECOMMISSN , LIST_NOTIFICATION , LIST_FAIRVALUEDIMENSION , REGT_OTHASSET , TRAN_CUSTCRED , TRAN_SYSJRNL , TRAN_SALESORDREVENUECONTRACT , REPO_ACCOUNTDETAIL , ADMI_COMMISSIONSETUP , ADMI_ADMINDOCSOTHER , LIST_PROJECTREVENUERULE , TRAN_VENDAUTHCREDIT , TRAN_TEGRCVBL , ADMI_CUSTTASKS , LIST_RESOURCEGROUP , REPO_PAYROLLJOURNAL , TRAN_RTNAUTHREVERSEREVCOMMIT , ADMI_CUSTENTITYFIELD , TRAN_PAYMENTEVENT , ADMI_KNOWLEDGEBASE , TRAN_COMMISSN , LIST_CHECKITEMAVAILABILITY , LIST_SHIPPARTREGISTRATION , REPO_SALES_PARTNER , TRAN_REVARRNGAPPRV , TRAN_PURCHORDBILL , LIST_RSRCALLOCATION , LIST_ORGANIZATIONVALUE , ADMI_WEBSERVICESSETUP , LIST_RECORDCUSTFIELD , TRAN_VENDPYMTAPPRV , TRAN_BILLPAY_APPROVE , ADMI_MANAGEPERMISSIONS , ADMI_SITEMANAGEMENT , ADMI_CUSTCENTER , REGT_STAT , TRAN_ITEMSHIP , ADMI_CUSTPAGE , REGT_COGS , ADMI_UPSELLSETUP , LIST_HISTORY , LIST_MAILTEMPLATE , LIST_PAYMENT_CARD , TRAN_VPREPAPP , ADMI_BUNDLER , LIST_CUSTJOB , TRAN_TEGPYBL , REPO_PAYROLLLIAB , TRAN_REVCOMM , ADMI_CUSTSECTION , REPO_PAYCHECKDETAIL , TRAN_MANAGEPAYROLL , LIST_EMPLOYEECHANGETYPE , TRAN_PURCHCONAPPRV , ADMI_ISSUESETUP , ADMI_MHNODE , ADMI_EXPENSEREPORTPOLICY , ADMI_MANUFACTURING , LIST_EMPLOYEE_CONFIDENTIAL , LIST_FAXMESSAGE , TRAN_PAYROLLRUN , LIST_BILLOFMATERIALSINQUIRY , LIST_ITEMREVENUECATEGORY , TRAN_CARDCHRG , TRAN_PRINTSHIPMENTDOCS , TRAN_COMMITPAYROLL , TRAN_IMPORTOLBFILE , REPO_941 , TRAN_WOISSUE , ADMI_IMPORTDEFAULT , REPO_940 , TRAN_INVTRNFR , ADMI_SETUPYEARSTATUS , ADMI_DEPTSEGMENTMAPPING , ADMI_CLASSSEGMENTMAPPING , LIST_BIN , LIST_EMPLOYEE_PUBLIC , ADMI_PAYROLL , REPO_SALES_PROMO , TRAN_FIND , ADMI_COMMERCECATEGORY , TRAN_BALANCEOVERVIEW , TRAN_STATCHNG , REPO_SFA , REGT_NONPOSTING , TRAN_BINTRNFR , ADMI_VIEWCREDITCARDS , ADMI_ALLOWNONGLCHANGES , LIST_ORDER_REALLOCATION , REPO_TAXREPORTS , ADMI_LOCATIONCOSTINGGROUP , TRAN_STPICKUP , ADMI_APP_DEPLOYMENT , TRAN_GST_REFUND , TRAN_PROJECT_IC_CHARGE_REQUEST , LIST_PICKSTRATEGY , TRAN_CASHSALE , ADMI_SUITE_OAX_CONNECTOR , TRAN_OPENBAL , TRAN_QUOTA , LIST_GLOBALINVTRELATIONSHIP , LIST_PAYCHECK , LIST_OTHERNAME , REPO_MARKETING , TRAN_CREATEINVCOUNT , LIST_PAYMETH , LIST_OVERTIMEPOLICY , ADMI_CUSTOMIZEDFIELDLEVELHELP , ADMI_SECRETS , ADMI_BILLPAYSETUP , LIST_MYROLES , TRAN_BILLPAY_STATUS , LIST_EXPORT , LIST_AMORTIZATION , ADMI_OIDCSETUP , LIST_HCMJOB , ADMI_TAXMIGRATION , REPO_PSTSUMMARY , ADMI_MANAGECUSTOMSEGMENTS , ADMI_COMPANY , ADMI_CUSTOMERFORM , ADMI_USER , LIST_USAGE , TRAN_CUSTAUTH , REPO_REMINDEREMPLOYEE , ADMI_MIGRATEREVARRNGANDPLAN , REPO_PERIODENDFINANCIALS , LIST_EVENT , TRAN_INVDISTR , ADMI_OIDC , TRAN_PRINT , TRAN_CUSTINVC , ADMI_LOCSEGMENTMAPPING , REPO_BUDGET , ADMI_REVIEW_CUSTOM_GL_RUNS , LIST_BONUSTYPE , LIST_PUBLIC_TEMPLATE_CATEGORY , LIST_CALL , REPO_1099 , ADMI_BLCGA , ADMI_CRMLIST , LIST_GLLINESAUDITLOG , TRAN_AUDIT , LIST_MFGCOSTTEMPLATE , TRAN_XCHGJRNL , ADMI_ADMINDOCSNA , LIST_CERTIFICATES , TRAN_PURCHREQ , LIST_BILLINGSCHEDULE , TRAN_CHARGERULE , LIST_BILLOFDISTRIBUTION , LIST_LABORCOSTING , LIST_COMMISSIONRULES , ADMI_VICARIOUS_EMAILS , REPO_COMMISSION , ADMI_DOMAINS , LIST_ITEMDEMANDPLAN , LIST_CARDHOLDERAUTHEVENT , TRAN_AMENDW4 , LIST_FAIRVALUEFORMULA , ADMI_WEBSERVICESLOG , TRAN_TIMECALC , TRAN_WORKORDMARKFIRMED , LIST_MEMDOC , LIST_ITEMSUPPLYPLAN , LIST_ACH , ADMI_ISSUESHOWSTOPPER , TRAN_PCHKJRNL , ADMI_TRANSITEMTXT , LIST_PUBLISHSEARCH , LIST_INTEGRAPP , LIST_STANDARDCOSTVERSION , REPO_FINANCIALS , TRAN_APPROVEDD , ADMI_BUNDLERMANUP , TRAN_BUDGET , TRAN_PAYCHECK , GRAP_AP , LIST_CURRENCY , LIST_TIMECODE , GRAP_AR , ADMI_ESCALATIONRULE , LIST_ORDERMANAGEDASHBOARD , TRAN_APPROVEPARTNERCOMM , ADMI_SUPPLYALLOCATIONSETUP , ADMI_TRANSLATION , LIST_EMPLOYEE_RECORD , REPO_GSTSUMMARY , LIST_PAYROLLITEM , LIST_SCHEDULEMASSUPDATES , ADMI_REPOGROUPS , ADMI_CLOSEPERIOD , LIST_INVENTORYSTATUS , TRAN_ESTIMATEDCOSTOVERRIDE , LIST_EMPLOYEE_ACCESS , TRAN_JOURNAL , ADMI_ORDERPROMISING , TRAN_ADJUSTMENTJOURNAL , ADMI_USERPREF , ADMI_MHVERSION , TRAN_PAYMENTAUDIT , ADMI_SAMLSSO , LIST_PRESCATEGORY , TRAN_VENDRFQ , REPO_GRANT_ACCESS , ADMI_CUSTTRANSACTION , ADMI_CASEISSUE , ADMI_SUITESIGNON , REPO_PAYROLLSTATEWITHHOLD , REPO_BOOKINGS , LIST_KNOWLEDGEBASE , LIST_MFGROUTING , LIST_REVRECSCHEDULE , REPO_SALES , ADMI_PROVISION , ADMI_EXPORTIIF , ADMI_CASEALERT , TRAN_RECONCILE , ADMI_MANAGE_RESTRICTIONS
- refName Reference Name: string
- permLevel1: object
-
- id Internal identifier.: string 0 , 1 , 2 , 3 , 4
- refName Reference Name: string
- refName Reference Name: string
employee-ratesCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: employee-ratesElement
-
employee-ratesElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
employee-rolesCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: employee-rolesElement
-
employee-rolesElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
employee-rolesElement
- billingWarn <A href='/app/billing/billingterms.nl?user=T'>Charges may apply</a>: string
- centerType: string
- deviceidOnly: string
- links Links: nsLink
-
nsLink - refName Reference Name: string
- selectedRole: nsResource
- ssoOnly: string
- wsOnly: string
employee-subscriptionMessageHistoryCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: employee-subscriptionMessageHistoryElement
-
employee-subscriptionMessageHistoryElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
employee-subscriptionsCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: employee-subscriptionsElement
-
employee-subscriptionsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
employee-subscriptionsElement
- lastModifiedDate Last Modified: string (date-time)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- subscribed Subscribed: boolean
- subscription: nsResource
employeeCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: employee
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
employee - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
employeeExpenseSourceTypeCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: employeeExpenseSourceType
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
employeeExpenseSourceType - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
entityAccountMapping
This record is available as a beta record.
- accountingBook: accountingBook
- class: classification
- classDisplayValue Class: string
- customField Custom Field: string
- customFieldCompId Custom Field CompId: string
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- department: department
- departmentDisplayValue Department: string
- destinationAccount: account
- effectiveDate Effective Date: string (date)
- endDate End Date: string (date)
- entityAccount: object
-
- id Internal identifier.: string CUSTOMERRETURNVARIANCE , SCRAP , ACCOUNTSRECEIVABLE , PAYMENT , VENDORBILLQUANTITYVARIANCE , FXADJUSTMENTREVENUE , COGS , UNBUILDVARIANCE , PRODUCTIONQUANTITYVARIANCE , INTERCOCOGS , INTERCODEFERREDREVENUE , GAINLOSS , PRODUCTIONPRICEVARIANCE , PURCHASEPRICEVARIANCE , INCOME , INTERCOEXPENSE , DEFERREDREVENUE , DROPSHIPEXPENSE , WIPVARIANCE , DEFERREDREVENUERECLASS , INTERCOINCOME , WRITEOFF , DEFERRAL , LIABILITY , ASSET , VENDORRETURNVARIANCE , DISCOUNT , VENDORBILLPRICEVARIANCE , VENDORBILLEXCHRATEVARIANCE , MARKUP , EXPENSE , ACCOUNTSPAYABLE , WIP
- refName Reference Name: string
- externalId External ID: string
- id Internal ID: string
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - location: location
- locationDisplayValue Location: string
- refName Reference Name: string
- sourceAccount: account
- subsidiary: subsidiary
entityAccountMappingCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: entityAccountMapping
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
entityAccountMapping - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
estimate
This record is available as a beta record.
- accountingBookDetail: estimate-accountingBookDetailCollection
- altHandlingCost Handling Cost: number (double)
-
The handling cost automatically calculates depending on the shipping method you select in the Ship Via field. To change the cost of handling, go to Lists > Shipping Items and select the shipping method with the handling cost you want to change.
- altSalesTotal Alt. Sales Total: number (double)
-
The alternate sales amount total is shown here.
- altShippingCost Shipping Cost: number (double)
-
The shipping cost automatically calculates depending on the shipping method you select in the Ship Via field above. To change the cost of a shipping method, go to Lists > Accounting > Shipping Items and select the shipping method you want to change. If you use UPS Real-Time rates, shipments over 150lbs are broken up into shipments less than or equal to 150lbs for charging.
- appliedRules: estimate-appliedRulesCollection
- billAddr1 Billing Address Line 1: string
- billAddr2 Billing Address Line 2: string
- billAddr3 Billing Address Line 3: string
- billAddress Bill To: string
-
The default billing address autofills this field from the customer's record at Lists > Relationships > Customers. To enter a different address: * Select another address in the Bill To Select field. * Select New in the Bill To Select field to enter a new billing address.
- billAddressList: nsResource
- billAddressee Billing Addressee: string
- billAttention Billing Attention: string
- billCity Billing Address City: string
- billCountry: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- billOverride Override: string
- billPhone Billing Phone: string
- billState Billing Address State: string
- billZip Billing Address Zip Code: string
- billingAddress: estimate-billingAddress
- billingAddress_text Billing Address: string
- billingSchedule: billingSchedule
- class: classification
- contribPct Contribution Percentage: string
- createdDate Date Created: string (date-time)
- createdFrom: nsResource
- currency: currency
- customForm: object
-
- id Internal identifier.: string -9903
- refName Reference Name: string
- defaultILBAShipAddrVal: string
- defaultILBAShippingAddressKey: string
- defaultILShipMethKey Default Shipping Method Key: integer (int64)
- department: department
- discountAmount Discount Amount: number (double)
- discountDate Discount Date: string (date)
- dueDate Due Date: string (date)
-
Type or pick a date this estimate expires.
- email Email: string
- endDate End Date: string (date)
-
Enter or pick the end date for this estimate.
- entity: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- entityStatus: customerStatus
- entityTaxRegNum Customer Tax Reg. Number: string
-
Select the entity's tax registration number associated with this estimate.
- estGrossProfit Est. Gross Profit: number (double)
-
Estimated Gross Profit: Read-only field that equals the revenue amount minus the Est. Cost. At the transaction level, it equals the gross profit of all lines, factoring transaction-level discounts and markups.
- estGrossProfitPercent Est. Gross Profit Percent: number (double)
-
Estimated Gross Profit Margin, as a percentage: Read-only field that equals the Est. Gross Profit divided by revenue, expressed as a percentage. At the transaction level, it equals the gross profit percent of all lines, factoring transaction-level discounts and markups.
- exchangeRate Exchange Rate: number (double)
-
The currency's exchange rate is shown in this field. You can edit the exchange rate for this transaction only, or you can update the currency record with the exchange rate you enter here.
- excludeCommission Exclude Commissions: boolean
- expectedCloseDate Expected Close Date: string (date)
-
Enter the date you expect this estimate to close.
- externalId External ID: string
- fob FOB: string
-
Enter the location where the customers technically acquire ownership. For example, if your customers own goods as soon as they ship and pay the shipping costs from your location to theirs, you might enter Our warehouse.
- forecastType: object
-
- id Internal identifier.: string 0 , 1 , 2 , 3
- refName Reference Name: string
- handlingCost Handling Cost: number (double)
-
The handling cost automatically calculates depending on the shipping method you select in the Ship Via field. To change the cost of handling, go to Lists > Accounting > Shipping Items and select the shipping method with the handling cost you want to change.
- handlingTaxAmount Handling Tax Amount: number (double)
- id Internal ID: string
- includeInForecast Include In Forecast: boolean
-
Check this box to include this estimate in sales forecast reports, key performance indicators and snapshots. If this estimate has a probability below the min. probability you set at Setup > Set Up SFA > Forecasts, it will not appear on reports, key performance indicators and snapshots. If you use NetSuite or NetCRM and this estimate was created from an opportunity, checking this box removes the opportunity from the sales forecast. Clearing this box includes the opportunity instead.
- isMultiShipTo Enable Item Line Shipping: boolean
-
Check this box if the transaction has multiple shipping routes so NetSuite can calculate the correct amounts for each line item.
- item: estimate-itemCollection
- job: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- lastModifiedDate Date Last Modified: string (date-time)
- leadSource: nsResource
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
-
If you wish, enter a memo to describe this estimate. It will appear on reports such as the 2-line Estimates register that your customers can see if you give them permission to log in and view their transaction history.
- message Customer Message: string
-
The text of the customer message you select in the Select Message field appears here. You can edit the message or enter a new customer message for only this transaction.
- messageSel: customerMessage
- nexus: nexus
- oneTime One Time: number (double)
- oppcreatedfrom: string
- oppcreatedfromtitle: string
- opportunity: opportunity
- originator Originator: string
- otherRefNum PO/Check Number: string
-
If a purchase order number applies to this estimate, enter it here.
- partner: partner
- partners: estimate-partnersCollection
- prevDate Previous Effective Date: string (date)
- prevPartner Previous Partner: integer (int64)
- prevRep Previous Representative: integer (int64)
- previousOpportunity Previous Opportunity: string
- probability Probability (%): number (double)
-
Accept or change the probability that this estimate will be converted to a sale. The Probability field shows the probability of the status selected. If this estimate is for a prospect, the prospect's record is updated with what is entered here. To change the default probability of a status, go to Setup > Sales > Customer Statuses, and click the status you want to change.
- recurAnnually Annually: number (double)
- recurMonthly Monthly: number (double)
- recurQuarterly Quarterly: number (double)
- recurWeekly Weekly: number (double)
- refName Reference Name: string
- refreshFromSubscription: string
- salesChannel: salesChannel
- salesEffectiveDate Sales Effective Date: string (date)
- salesRep: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- salesTeam: estimate-salesTeamCollection
- saleschannelorderpriority: string
- shipAddress Ship To: string
-
The default shipping address autofills this field from the customer's record at Lists > Customers. To enter a different address: * Select another address in the Ship To Select field. * Select New in the Ship To Select field to enter a new billing address.
- shipAddressList: nsResource
- shipDate Ship Date: string (date)
-
Enter, pick or accept the date you expect to ship items ordered.
- shipGroup: estimate-shipGroupCollection
- shipIsResidential Shipping address is residential: boolean
- shipMethod: shipItem
- shipOverride Override: boolean
- shippingAddress: estimate-shippingAddress
- shippingAddress_text Shipping Address: string
- shippingCost Shipping Cost: number (double)
-
The shipping cost automatically calculates depending on the shipping method you select in the Ship Via field. If this field reads ReCalc, click the Recalculate Shipping button to receive a shipping cost. If you use UPS Real-Time rates and a package is over 150lbs, the package is charged as multiple packages equal to or less than 150lbs.
- shippingCostOverridden Shipping Cost Overridden: boolean
- shippingTaxAmount Shipping Tax Amount: number (double)
- source: object
-
- startDate Start Date: string (date)
-
If there is an expected closing date for this estimate, accept today's date or enter a new date here.
- status: object
-
- id Internal identifier.: string A , B , C , V , X
- refName Reference Name: string
- storeOrder: string
- subsidiary: subsidiary
- subsidiaryTaxRegNum Subsidiary Tax Reg. Number: string
-
This field shows the tax registration number of the transaction nexus. NetSuite automatically populates this field based on the nexus lookup logic. You can override the transaction nexus and tax registration number that NetSuite automatically selects by checking the Nexus Override box. When you select a different tax registration number in the dropdown list, the corresponding nexus is automatically selected in the Nexus field.
- subtotal Subtotal: number (double)
-
This field shows the total of the items on this sales order. This is the total before any discounts, shipping cost, handling cost or tax is added to the order.
- taxDetails: estimate-taxDetailsCollection
- taxDetailsOverride Tax Details Override: boolean
-
Check this box to override the tax information on the Tax Details subtab of the transaction. Only roles with at least the Edit level of the Tax Details Tab permission can override the tax details.
- taxPointDate Tax Point Date: string (date)
- taxPointDateOverride Tax Point Date Override: boolean
- taxRegOverride Tax Registration Override: boolean
-
Check this box to override the values in the Nexus and Subsidiary Tax Reg. Number fields. Only roles with at least the Edit level of the Tax Details Tab permission can override the values that NetSuite automatically selects in these fields.
- taxTotal Tax: number (double)
-
NetSuite multiplies the tax rate by the taxable total of line items and enters it here.
- terms: term
- thirdPartyAcct 3rd Party Account: string
- title Title: string
-
Enter a title for this estimate. The estimate title text appears on lists, shows in search and reporting results, and shows on the Estimates subtab of records it is associated with. When an estimate is converted from an opportunity, the title from the opportunity defaults into the title field on the estimate. If there is already an estimate against the opportunity, then the second estimate has a number following the title. For example, if the first estimate title is “Project Estimate”, then the second estimate title is “Project Estimate1”. For each subsequent estimate created against that opportunity, the number in the title increases by 1 to help distinguish between multiple estimates associated to a single opportunity. The estimate title field is also available for customization, direct list editing, and mass updates.
- toBeEmailed To Be Emailed: boolean
-
Check this box if you want to email this estimate. Then enter the email address in the space to the right of the check box. You can enter multiple email addresses by separating them with semicolons. It is important to separate the addresses with only semicolons, and do not include any spaces.
- toBeFaxed To Be Faxed: boolean
-
Check this box if you want to fax this estimate. Enter the fax number in the space to the right of the check box if it doesn't already appear. To fax NetSuite forms, an administrator must first set up fax service at Setup > Company > Printing, Fax and Email Preferences.
- toBePrinted To Be Printed: boolean
-
Check this box if you wish to save this in a queue of estimates to print. Otherwise, you can click Print below to submit and print this estimate at once.
- total Total: number (double)
-
NetSuite computes the total of line items and tax and then enters it here.
- totalAfterTaxes Total After Taxes: number (double)
- totalCostEstimate Est. Cost: number (double)
-
Estimated Cost: Estimated cost of the specific number of items; estimated rate x quantity = estimated cost.
- trackingNumbers Tracking Numbers: string
-
Enter the shipment tracking number from the shipping company. If a tracking number is entered in the exact format used by UPS or FedEx and the transaction is saved, the tracking number will show on the transaction as a link to the UPS or FedEx website. You can click the link to check the status of the shipment.
- tranDate Date: string (date)
-
NetSuite inserts today's date for the posting date of this estimate. You can type or pick another date. What you enter here determines the date range in which this transaction appears on the estimate registers. You can select or enter custom date ranges on registers.
- tranId Estimate #: string
-
NetSuite increases the largest estimate number by one. If you wish, you can type another number. The next estimate number will revert to the standard pattern.
- visibleToCustomer Available In Customer Center: boolean
-
Check the Available in Customer Center box to make this estimate available to customers in the Customer Center. Clear this box to leave this estimate off the list of estimates available to customers in the Customer Center. This field is checked by default.
- webSite: string
estimate-accountingBookDetailCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: estimate-accountingBookDetailElement
-
estimate-accountingBookDetailElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
estimate-accountingBookDetailElement
This record is available as a beta record.
- accountingBook: accountingBook
- exchangeRate Exchange Rate: number (double)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- revRecOnRevCommitment Rev Rec on Rev Commit.: boolean
- subsidiary: subsidiary
- tranIsVsoeBundle Transaction Is VSOE Bundle: boolean
estimate-appliedRulesCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: estimate-appliedRulesElement
-
estimate-appliedRulesElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
estimate-billingAddress
This record is available as a beta record.
- addr1 Address 1: string
-
Enter the address the way it should appear on forms. For employees, customers, partners, and vendors, what you enter here autofills on forms if this address is marked default for Shipping or Billing. Enter up to 50 characters. This field is required for the Online Bill Pay feature.
- addr2 Address 2: string
-
Enter an optional second address line the way it should appear on forms. For employees, customers, partners, and vendors, what you enter here autofills on forms if this address is marked default for Shipping or Billing. Enter up to 50 characters.
- addr3 Address 3: string
- addrPhone Phone: string
-
Enter the phone number.
- addrText Address: string
-
The values entered in the other address fields are displayed here.
- addressee Addressee: string
-
Enter the name of the entity that should appear on the shipping label here. This name appears on the shipping label below what you enter in the Attention field.
- attention Attention: string
-
Enter the name of the person to whom a shipment is addressed, as it should appear on shipping labels. This field is required for UPS Integration.
- city City: string
-
Enter the city the way it should appear on all forms except checks.
- country: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- externalId External ID: string
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - override Override: boolean
-
Check this box to disable the free-form address text field. When this field is disabled, text entered in the other address fields does not display in the Address text field. Clear this box to allow text entered in the address component fields to appear in the free-form address text field.
- refName Reference Name: string
- state State/Province: string
-
Enter your company's state or province the way it should appear on all forms except checks.
- zip Zip: string
-
Enter the postal code the way it should appear on all forms except checks.
estimate-item-inventoryDetail
This record is available as a beta record.
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- externalId External ID: string
- inventoryassignment: estimate-item-inventoryDetail-inventoryassignmentCollection
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemDescription Description: string
-
A more complete Description of the item.
- links Links: nsLink
-
nsLink - location: location
- quantity Quantity: number (float)
-
In the Quantity to Build field, enter the number of assembly items you want to build. You cannot enter a quantity that exceeds the amount displayed in the Buildable Quantity field.
- refName Reference Name: string
- toLocation: location
- unit Units: string
-
If the assembly uses Units of Measure, the base units are displayed in the Units field.
estimate-item-inventoryDetail-inventoryassignmentCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: estimate-item-inventoryDetail-inventoryassignmentElement
-
estimate-item-inventoryDetail-inventoryassignmentElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
estimate-item-inventoryDetail-inventoryassignmentElement
This record is available as a beta record.
- binNumber: bin
- expirationDate Expiration Date: string (date)
- internalId Internal ID: integer (int64)
- inventoryDetail Inventory Detail: integer (int64)
- inventoryStatus: inventoryStatus
- issueInventoryNumber: inventoryNumber
- links Links: nsLink
-
nsLink - packCarton Pack Carton: string
- pickCarton Pick Carton: string
- quantity Quantity: number (float)
- quantityAvailable Unpicked Bin Qty: number (float)
- receiptInventoryNumber Serial/Lot Number: string
- refName Reference Name: string
- secondaryQuantity Secondary Quantity: number (float)
- toBinNumber: bin
- toInventoryStatus: inventoryStatus
estimate-itemCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: estimate-itemElement
-
estimate-itemElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
estimate-itemElement
This record is available as a beta record.
- altSalesAmt Alt. Sales Amount: number (double)
- amount Amount: number (double)
- billVarianceStatus: object
-
- id Internal identifier.: string NOVARIANCES , JOURNALNOTPOSTED , JOURNALPOSTED
- refName Reference Name: string
- billingSchedule: billingSchedule
- chargeType: nsResource
- class: classification
- costEstimate Est. Cost: number (double)
- costEstimateRate Est. Rate: number (double)
- costEstimateType: object
-
- id Internal identifier.: string PREFVENDORRATE , AVGCOST , PURCHORDERRATE , LASTPURCHPRICE , MEMBERDEFINED , CUSTOM , ITEMDEFINED , PURCHPRICE
- refName Reference Name: string
- department: department
- description Description: string
- estGrossProfit Est. Gross Profit: number (double)
- estGrossProfitPercent Est. Gross Profit Percent: number (double)
- excludeFromRateRequest Exclude Item from Rate Request: boolean
- expectedShipDate Expected Ship Date: string (date)
- fromJob From Project: boolean
- initOqpBucket Initial OQP Bucket: string
- inventoryDetail: estimate-item-inventoryDetail
- isClosed Closed: boolean
- isEstimate Estimate: boolean
- isOpen Is Opened: boolean
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemSubtype: object
-
- id Internal identifier.: string Sale , Purchase , Resale
- refName Reference Name: string
- itemType: object
-
- job: job
- licenseCode License Code: string
- line Transaction Line: integer (int64)
- linked Linked: boolean
- links Links: nsLink
-
nsLink - location: location
- marginal Marginal: boolean
- matrixType Matrix Type: string
- minQty Minimum Quantity: number (float)
- options Options: string
- oqpBucket Oqp Bucket: string
- price: priceLevel
- priceIntervalFrequency: string
- priceIntervalFrequencyName Subscription Frequency: string
- priceIntervalRepeatEvery Subscription Frequency Repeat Every: string
- printItems Print Items: boolean
- quantity Quantity: number (float)
- quantityAllocated Quantity Allocated: number (float)
- quantityAvailable Available: number (float)
- quantityCommitted Committed: number (float)
- quantityDemandAllocated Allocated Demand: number (float)
- quantityOnHand On Hand: number (float)
- rate Rate: number (double)
- rateIncludingTax Rate: number (double)
- rateSchedule Rate Schedule: string
- refName Reference Name: string
- shipAddress: nsResource
- shipCarrier: object
-
- id Internal identifier.: string ups , nonups
- refName Reference Name: string
- shipMethod: shipItem
- subscription: subscription
- subscriptionLine: subscriptionLine
- subscriptionLinePeriodAmount Subscription Amount Per Period: number (double)
- subscriptionLineRate Subscription Rate: number (double)
- subscriptionLineType: string
- subsidiary: subsidiary
- taxAmount Tax Amount: number (double)
- taxDetailsReference Tax Details Reference: string
- units Units: string
estimate-partnersCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: estimate-partnersElement
-
estimate-partnersElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
estimate-partnersElement
This record is available as a beta record.
- contribution Contribution %: number (double)
- isPrimary Primary: boolean
- links Links: nsLink
-
nsLink - partner: partner
- partnerRole: partnerCategory
- refName Reference Name: string
estimate-salesTeamCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: estimate-salesTeamElement
-
estimate-salesTeamElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
estimate-shipGroupCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: estimate-shipGroupElement
-
estimate-shipGroupElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
estimate-shipGroupElement
This record is available as a beta record.
- destinationAddress Ship To: string
- handlingRate Handling Rate: number (double)
- id ID: integer (int64)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- shippingMethod Ship Via: string
- shippingRate Shipping Rate: number (double)
- sourceAddress Ship From: string
- uniqueKey Unique Key: integer (int64)
- weight Weight: number (float)
estimate-shippingAddress
This record is available as a beta record.
- addr1 Address 1: string
-
Enter the address the way it should appear on forms. For employees, customers, partners, and vendors, what you enter here autofills on forms if this address is marked default for Shipping or Billing. Enter up to 50 characters. This field is required for the Online Bill Pay feature.
- addr2 Address 2: string
-
Enter an optional second address line the way it should appear on forms. For employees, customers, partners, and vendors, what you enter here autofills on forms if this address is marked default for Shipping or Billing. Enter up to 50 characters.
- addr3 Address 3: string
- addrPhone Phone: string
-
Enter the phone number.
- addrText Address: string
-
The values entered in the other address fields are displayed here.
- addressee Addressee: string
-
Enter the name of the entity that should appear on the shipping label here. This name appears on the shipping label below what you enter in the Attention field.
- attention Attention: string
-
Enter the name of the person to whom a shipment is addressed, as it should appear on shipping labels. This field is required for UPS Integration.
- city City: string
-
Enter the city the way it should appear on all forms except checks.
- country: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- externalId External ID: string
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - override Override: boolean
-
Check this box to disable the free-form address text field. When this field is disabled, text entered in the other address fields does not display in the Address text field. Clear this box to allow text entered in the address component fields to appear in the free-form address text field.
- refName Reference Name: string
- state State/Province: string
-
Enter your company's state or province the way it should appear on all forms except checks.
- zip Zip: string
-
Enter the postal code the way it should appear on all forms except checks.
estimate-taxDetailsCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: estimate-taxDetailsElement
-
estimate-taxDetailsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
estimate-taxDetailsElement
This record is available as a beta record.
- calcDetail Details: string
- lineName Name: string
- lineType Line type: string
- links Links: nsLink
-
nsLink - netAmount Net Amount: number (double)
- refName Reference Name: string
- taxAmount Tax Amount: number (double)
- taxBasis Tax Basis: number (double)
- taxCode: salesTaxItem
- taxDetailsReference: object
-
- id Internal identifier.: string
- refName Reference Name: string
- taxRate Tax Rate: number (double)
- taxType Tax Type: string
estimateCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: estimate
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
estimate - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
expenseCategory
This record is available as a beta record.
- defaultrate Default Rate: number (float)
-
Enter a default rate to be used on expense reports for this category. This rate can be overridden on individual line items.
- description Description: string
-
Enter a description of the expense category. If you use the Google Checkout Integration feature, enter a description for the tracking URL. This field is optional.
- expenseacct: account
- expenseitem: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- externalId External ID: string
- id Internal ID: string
- isinactive Inactive: boolean
-
Check this box if you want to make this expense category inactive.
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - name Name: string
-
Enter the name of an expense category. If you use the Google Checkout Integration feature, enter a name for the tracking URL. Name the tracking URL for the tracking pixel vendor you use. If you use multiple vendors, you must create a conversion tracking URL record for each vendor.
- personalcorporatecardexpense Personal Corporate Card Expense: boolean
-
Check this box to designate this expense category for personal corporate card expenses. Corporate card expense categories can only use other asset accounts. If your company does not use expanded account lists, the corporate card field on expense categories is disabled. Any expense category attached to an other asset account is automatically designated a corporate card expense.
- raterequired Rate is Required: boolean
-
Check this box to require a quantity and rate when this category is selected on expense reports. Quantity and rate fields are used to calculate the amount on line items with rate required expenses.
- rates: expenseCategory-ratesCollection
- refName Reference Name: string
- subsidiary: subsidiaryCollection
- translations: expenseCategory-translationsCollection
expenseCategory-ratesCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: expenseCategory-ratesElement
-
expenseCategory-ratesElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
expenseCategory-ratesElement
This record is available as a beta record.
- currency Currency: string
- defaultrate Default Rate: number (float)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- subsidiary: subsidiary
expenseCategory-translationsCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: expenseCategory-translationsElement
-
expenseCategory-translationsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
expenseCategory-translationsElement
This record is available as a beta record.
- description Description: string
- language Language: string
- links Links: nsLink
-
nsLink - locale: object
-
- id Internal identifier.: string it_CH , en_TC , af_ZA , es_EA , es_EC , pt_BR , en_CY , fr_LU , nl_AN , es_UY , en_TT , es_ES , pt_ST , en_DM , en_TZ , es_ES_EURO , fr_ML , de_DE_onLQA , es_VE , nl_BE , da_DK , pt_AO , to_TO , en_UG , am_ET , ss_SZ , nl_BQ , ar , pt_AW , ko_KR , en_US , fr_BE_EURO , ko_KP , si_AQ , fr_MG , el_GR , be_BY , en_AU , he_IL , en_AW , es_SV , en_BB , ar_YE , es_CO , es_CL , en_BM , es_CR , pa_IN , en_SC , en_BS , sm_WS , it_IT_EURO , fr_KM , es_CU , en_SB , en_SG , en_BW , en_SH , en_BZ , en_SL , az_AZ , fi_FI , en_SS , sr_YU , en_CD , en_CA , ka_GE , lv_LV , uk_UA , es_DO , ur_PK , ar_IQ , fr_LU_EURO , pt_PT , fr_FR_EURO , en_PH , th_TH , bn_BD , si_LK , en_PG , hu_HU , ar_SA , ar_SD , ru_KZ , ar_BH , nl_BE_EURO , ro_MD , en_QA , ru_KG , es_AR , ta_IN , sr_RS , aa_ER , en , de_DE_EURO , zh_MO , en_AE , ar_SY , es_BO , en_AI , no_NO , en_AG , nl_SR , fr_VU , en_MW , gu_AQ , ar_TN , nl_SX , hi_IN , en_NA , mn_MN , en_NG , fr_FR , ms_MY , nl_CW , uz_UZ , ar_DJ , sr_CS , de_AT_EURO , en_NZ , es_PE , es_PA , fa_IR , ar_DZ , fr_GN , lb_LU , xx_US , pt_CV , sh_RS , ht_HT , fr_WF , es_AR_onLQA , es_PR , ar_EG , es_PY , fr_GA , en_KW , de_AT , ro_RO , en_KY , fr_FR_onLQA , fr_DJ , ca_ES_EURO , cs_CZ , en_LC , pl_AQ , fr_TD , fr_TG , es_MX , sv_AX , sk_SK , en_LR , en_LS , ar_OM , dz_BT , te_IN , de_LU_EURO , sq_AL , sv_SE , sn_ZW , es_NI , en_IE_EURO , my_MM , en_MF , en_MU , it_IT , pl_PL , fr_BE , fr_BF , tr_TR , fr_BI , fr_BJ , id_ID , fr_RW , en_ZM , km_KH , ja_JP , de_DE , fr_BL , tg_TJ , ar_QA , de_CH , zh_HK , pt_PT_EURO , en_JO , en_JM , fr_CA , nl_NL_EURO , fr_CF , fr_CG , fr_CD , pa_AQ , fr_CH , xx_US_wthId , fr_CI , pt_GW , vi_VN , ru_MD , fr_CM , fr_SC , en_KE , ne_NP , bs_BA , sl_SI , en_KN , fr_SN , ar_AE , en_GY , tl_PH , ca_ES , es_IC , lo_LA , kn_IN , so_SO , fr_PF , ar_JO , nl_NL , is_IS , fi_FI_EURO , pt_MZ , sk_SK_EURO , sl_SI_EURO , en_IE , ms_BN , hr_HR , ar_KW , de_LU , lt_LT , en_IN , ps_AF , en_ZA , en_VC , ru_RU , sh_YU , ar_LB , mr_IN , dv_MV , fj_FJ , zh_TW , tk_TM , ar_LY , en_VU , fr_NE , en_FK , es_GT , fr_NC , es_GQ , fa_AF , bg_BG , hy_AM , en_CY_EURO , mk_MK , ar_MA , en_GD , en_GB , es_HN , gu_IN , en_GH , et_EE , en_GI , zh_CN , en_GM , ar_MR
- refName Reference Name: string
- name Display Name: string
- refName Reference Name: string
expenseCategoryCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: expenseCategory
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
expenseCategory - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
expenseReport
This record is available as a beta record.
- account: account
- accountingBookDetail: expenseReport-accountingBookDetailCollection
- accountingapproval Accounting Approval: boolean
-
If you have the appropriate accounting authority to approve this report indicating it is ready to pay, place a check mark in this box.
- acctcorpcardexp: account
- advance Advance to Apply: number (double)
-
Enter any advance that should be applied to any reimbursement for these expenses.
- advance2 Advance to Apply: number (double)
-
This is the total of any advances applied to this expense report.
- advanceaccount: account
- amount Total Reimbursable Amount: number (double)
-
The number NetSuite enters here represents the total of all line items minus any advances and lines marked as non-reimbursable.
- appliedRules: expenseReport-appliedRulesCollection
- approvalStatus: object
-
- id Internal identifier.: string 11 , 1 , 2 , 3
- refName Reference Name: string
- class: classification
- complete Complete: boolean
-
This field shows if this report is complete. Only complete reports are submitted for approval and processing. Note: Once an expense report is marked complete, you can no longer make changes to it.
- corporatecard Corporate Card: number (double)
-
The amount shown has been charged to a corporate credit card and will be reimbursed directly to the card issuer.
- createdDate Date Created: string (date-time)
- currencyPrecision Currency Precision: string
- customForm: object
-
- id Internal identifier.: string -9954
- refName Reference Name: string
- department: department
- duedate Date Due: string (date)
-
Enter the due date of the expense report.
- entity: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- excludeFromGLNumbering Exclude from GL Audit Numbering: boolean
- expense: expenseReport-expenseCollection
- expensereportcurrency: currency
- expensereportexchangerate Exchange Rate: number (double)
-
Select an exchange rate for this expense report.
- externalId External ID: string
- id Internal ID: string
- lastModifiedDate Date Last Modified: string (date-time)
- links Links: nsLink
-
nsLink - location: location
- memo Purpose: string
-
Enter the purpose of the entire expense report.
- nextApprover: employee
- nexus: nexus
- nonreimbursable Non-reimbursable Expenses (Tax Excl.): number (double)
-
This is the total of any line items below marked as non-reimbursable.
- policyviolated Policy violated: boolean
- postingPeriod: accountingPeriod
- prevDate Previous Effective Date: string (date)
- refName Reference Name: string
- reimbursable Reimbursable Expenses: number (double)
-
This is the total of reimbursable expenses from the line items below.
- rejected: boolean
- status: object
-
- id Internal identifier.: string A , B , C , D , E , V , F , G , H , I , J
- refName Reference Name: string
- subsidiary: subsidiary
- subsidiaryTaxRegNum Subsidiary Tax Reg. Number: string
-
When you select a nexus, the corresponding tax registration number is automatically selected in this field. If there is more than one tax registration number for the nexus, the transaction date (in the Primary Information section) determines the tax registration number to be used based on the validity dates set on the subsidiary record. When you select a different tax registration number, the corresponding nexus is automatically selected in the Nexus field.
- supervisorapproval Supervisor Approval: boolean
-
If you have the appropriate authority as a supervisor to approve this report, place a check mark in this box.
- tax1Amt Tax: number (double)
- tax2Amt PST: number (double)
- taxDetails: expenseReport-taxDetailsCollection
- taxDetailsOverride Tax Details Override: boolean
- taxPointDate Tax Point Date: string (date)
- taxPointDateOverride Tax Point Date Override: boolean
- taxRegOverride Tax Registration Override: boolean
- taxTotal Tax: number (double)
- total Expenses Total: number (double)
-
NetSuite will keep track of the total expenses as you add and edit line items below.
- totalbasecurrency Total in Base Currency: string
-
This amount is the total of the expense lines converted to the subsidiary's base currency at the expense report exchange rate.
- tranDate Date: string (date)
-
NetSuite inserts today's date as the date of this expense report. You can type or pick another date.
- tranId Exp. Rept. #: string
-
NetSuite increases the largest expense report number by one. If you wish, you can type another number. The next expense number will revert to the standard pattern. You can enter a maximum of 45 characters in this field.
- usemulticurrency Use Multicurrency: boolean
-
Check this box if you want to enter expenses in foreign currencies on this expense report. This box is checked by default if you have enabled the Use Multicurrency Expense Reports preference on the General subtab at Home > Set Preferences. Foreign amounts are translated into base currency amounts. Note that exchange rates and converted amounts displayed on expense lines are provided as approximations only. Actual reimbursement amounts will be based on rates at the time of reimbursement.
expenseReport-accountingBookDetailCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: expenseReport-accountingBookDetailElement
-
expenseReport-accountingBookDetailElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
expenseReport-accountingBookDetailElement
This record is available as a beta record.
- accountingBook: accountingBook
- exchangeRate Exchange Rate: number (double)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- revRecOnRevCommitment Rev Rec on Rev Commit.: boolean
- subsidiary: subsidiary
- tranIsVsoeBundle Transaction Is VSOE Bundle: boolean
expenseReport-appliedRulesCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: expenseReport-appliedRulesElement
-
expenseReport-appliedRulesElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
expenseReport-expenseCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: expenseReport-expenseElement
-
expenseReport-expenseElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
expenseReport-expenseElement
This record is available as a beta record.
- amount Amount: number (double)
- billingsubsidiary: subsidiary
- category: expenseCategory
- class: classification
- corporatecreditcard Corporate Card: boolean
- currency: currency
- customer: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- department: department
- expenseaccount: account
- expensedate Date: string (date)
- expmediaitem: nsResource
- grossAmt Gross Amt: number (double)
- id: integer (int64)
- importedemployeeexpense: importedEmployeeExpense
- isBillable Billable: boolean
- isnonreimbursable Non-reimbursable: boolean
- line: string
- linked: boolean
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
- projecttask: projectTask
- quantity Quantity: number (float)
- rate Rate: number (float)
- raterequired: boolean
- receipt Receipt: boolean
- refName Reference Name: string
- refnumber Ref No.: integer (int64)
- tax1Amt Tax Amt: number (double)
- taxAmount Tax Amount: number (double)
- taxCode: nsResource
- taxDetailsReference Tax Details Reference: string
- taxRate1 Tax Rate: number (double)
- taxRate2 PST: number (double)
expenseReport-taxDetailsCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: expenseReport-taxDetailsElement
-
expenseReport-taxDetailsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
expenseReport-taxDetailsElement
This record is available as a beta record.
- calcDetail Details: string
- lineName Name: string
- lineType Line type: string
- links Links: nsLink
-
nsLink - netAmount Net Amount: number (double)
- refName Reference Name: string
- taxAmount Tax Amount: number (double)
- taxBasis Tax Basis: number (double)
- taxCode: salesTaxItem
- taxDetailsReference: object
-
- id Internal identifier.: string
- refName Reference Name: string
- taxRate Tax Rate: number (double)
- taxType Tax Type: string
expenseReportCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: expenseReport
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
expenseReport - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
expenseReportPolicy
This record is available as a beta record.
- action: object
-
- id Internal identifier.: string WARN_BUT_ALLOW , DO_NOT_ALLOW
- refName Reference Name: string
- customer: one of: [ customerCollection, partnerCollection, vendorCollection, nsResourceCollection, employeeCollection, contactCollection ]
- department: departmentCollection
- description Description: string
-
Enter a description of your expense report policy. This description displays in the list of policies.
- enddate End Date: string (date)
-
Select the date you want this policy to end. If you want this policy to be applied indefinitely, leave this field blank.
- expensecategory: expenseCategoryCollection
- externalId External ID: string
- id Internal ID: string
- isInactive Inactive: boolean
-
Check this box to inactivate this expense report policy. Inactive policies are not applied to expense reports.
- isbillable: object
-
- id Internal identifier.: string , T , F
- refName Reference Name: string
- limittype: object
-
- id Internal identifier.: string PER_INDIVIDUAL_LINE , PER_INDIVIDUAL_ER , PER_DAY
- refName Reference Name: string
- links Links: nsLink
-
nsLink - location: locationCollection
- maxamount Maximum Amount: number (double)
-
This is the maximum amount of expenses allowed for this expense policy. Depending on the limit type, this amount applies either per expense report or per day by each employee.
- name Name: string
-
Enter a descriptive name for your policy. This name appears in a list of applicable policies when you click Show Policies on an expense report.
- notification: expenseReportPolicy-notificationCollection
- nowarningreqfieldincluded Do not warn if required fields are included: boolean
- refName Reference Name: string
- requiresmemo Requires Memo: boolean
-
Check this box to require a memo for any expense lines affected by this policy.
- requiresreceipt Requires Receipt: boolean
-
Check this box to require a receipt for any expense lines affected by this policy.
- startdate Start Date: string (date)
-
Select the date you want this policy to begin to apply to expense reports. This date applies to newly created expense reports. For example, if you enter a date in the past, the policy is not automatically applied to entered expense reports.
- status: object
-
- id Internal identifier.: string IN_EFFECT , EXPIRED , NOT_IN_EFFECT
- refName Reference Name: string
- subsidiary: subsidiaryCollection
expenseReportPolicy-notificationCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: expenseReportPolicy-notificationElement
-
expenseReportPolicy-notificationElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
expenseReportPolicyCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: expenseReportPolicy
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
expenseReportPolicy - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
fairValuePrice
This record is available as a beta record.
- accountingBook: accountingBook
- currency: currency
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- customer: customer
- endDate End Date: string (date)
-
The End Date is the date that this fair value price expires. When a revenue arrangement is created, its date is checked against this date to determine if this fair value price should be used. You can leave this date blank. If you enter a date here, you must also enter a Start Date. The Start Date must be before the End Date.
- externalId External ID: string
- fairValue Base Fair Value: number (float)
-
Enter the base fair value for a unit of the item. This value is used in fair value range checking.
- fairValueFormula: nsResource
- fairValueRangePolicy: object
-
- id Internal identifier.: string HIGH , LOW , BOUNDARY , FAIRVALUE
- refName Reference Name: string
- highValue High Value: number (float)
-
If you enter a number here, the High Value Percent is calculated automatically. Leave this field blank to calculate the value based on the High Value Percent you enter.
- highValuePercent High Value Percent: number (double)
-
Enter a percent of the base fair value to set the high end of the range. A percent sign is not required. The High Value is automatically calculated.
- id Internal ID: string
- isVsoePrice Is VSOE Price?: boolean
-
Check this box to indicate that the fair value is based on VSOE. If the box is not checked, the fair value is considered an estimate.
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemRevenueCategory: nsResource
- links Links: nsLink
-
nsLink - lowValue Low Value: number (float)
-
If you enter a number here, the Low Value Percent is calculated automatically. Leave this field blank to calculate the value based on the Low Value Percent you enter.
- lowValuePercent Low Value Percent: number (double)
-
Enter a percent of the base fair value to set the low end of the range. A percent sign is not required. The Low Value is automatically calculated.
- refName Reference Name: string
- sourceType: object
-
- id Internal identifier.: string SUBSCRIPTION_LINE , TRANSACTION_LINE , PROJECT_REVENUE_RULE , THIRD_PARTY
- refName Reference Name: string
- startDate Start Date: string (date)
-
The Start Date is the date that this fair value price becomes effective. When a revenue arrangement is created, its date is checked against this date to determine if this fair value price should be used. You can leave this date blank if the End Date is also blank. If you enter a date here, you can leave the End Date blank. If you also enter an End Date, it must be later than the Start Date.
- subsidiary: subsidiary
- units Units: string
-
Select a value. When the fair value price includes a value for units and a revenue element includes an alternate quantity, fair value formulas that include {quantity} use the alternate quantity.
- unitsType: unitsType
fairValuePriceCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: fairValuePrice
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
fairValuePrice - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
fixedAmountProjectRevenueRule
This record is available as a beta record.
- amountLeftToRecognize Difference: number (double)
-
The difference between charges and revenue must be zero to save this project revenue rule.
- chargeRule: fixedAmountProjectRevenueRule-chargeRuleCollection
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- datesFixedAmount: fixedAmountProjectRevenueRule-datesFixedAmountCollection
- datesPctFromTotal: fixedAmountProjectRevenueRule-datesPctFromTotalCollection
- description Description: string
-
Enter a description for this project revenue rule.
- externalId External ID: string
- fixedAmountType: object
-
- id Internal identifier.: string FIXED_AMOUNT , PERCENT_FROM_TOTAL
- refName Reference Name: string
- fixedScheduleType: object
-
- id Internal identifier.: string RECURRENCE , DATES , TASKS
- refName Reference Name: string
- id Internal ID: string
- isInactive Inactive: boolean
-
Check this box to inactivate this rule.
- links Links: nsLink
-
nsLink - name Name: string
-
Enter a name for this project revenue rule.
- project: job
- recognizedAmountSoFar Revenue: number (double)
-
This is the total amount of revenue to be recognized with this rule.
- refName Reference Name: string
- revenueReconciled Revenue Reconciled: boolean
- serviceItem: nsResource
- tasksFixedAmount: fixedAmountProjectRevenueRule-tasksFixedAmountCollection
- tasksPctFromTotal: fixedAmountProjectRevenueRule-tasksPctFromTotalCollection
- totalAmountToRecognize Charges: number (double)
-
This is the total amount of charges available for this rule.
fixedAmountProjectRevenueRule-chargeRuleCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: fixedAmountProjectRevenueRule-chargeRuleElement
-
fixedAmountProjectRevenueRule-chargeRuleElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
fixedAmountProjectRevenueRule-chargeRuleElement
This record is available as a beta record.
- billingItem: nsResource
- chargeRule: chargeRule
- description Description: string
- forecastAmount Amount: number (double)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- ruleType: object
-
- id Internal identifier.: string PROJECTPROGRESS , MILESTONE , FIXEDDATE , TIMEBASED , EXPENSEBASED , PURCHASE
- refName Reference Name: string
fixedAmountProjectRevenueRule-datesFixedAmountCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: fixedAmountProjectRevenueRule-datesFixedAmountElement
-
fixedAmountProjectRevenueRule-datesFixedAmountElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
fixedAmountProjectRevenueRule-datesPctFromTotalCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: fixedAmountProjectRevenueRule-datesPctFromTotalElement
-
fixedAmountProjectRevenueRule-datesPctFromTotalElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
fixedAmountProjectRevenueRule-tasksFixedAmountCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: fixedAmountProjectRevenueRule-tasksFixedAmountElement
-
fixedAmountProjectRevenueRule-tasksFixedAmountElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
fixedAmountProjectRevenueRule-tasksFixedAmountElement
This record is available as a beta record.
- fixedAmount Amount to Recognize: number (double)
- links Links: nsLink
-
nsLink - projectTask: projectTask
- refName Reference Name: string
fixedAmountProjectRevenueRule-tasksPctFromTotalCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: fixedAmountProjectRevenueRule-tasksPctFromTotalElement
-
fixedAmountProjectRevenueRule-tasksPctFromTotalElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
fixedAmountProjectRevenueRule-tasksPctFromTotalElement
This record is available as a beta record.
- links Links: nsLink
-
nsLink - percentFromTotal Percent to Recognize: number (double)
- projectTask: projectTask
- refName Reference Name: string
fixedAmountProjectRevenueRuleCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: fixedAmountProjectRevenueRule
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
fixedAmountProjectRevenueRule - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
fulfillmentRequest
This record is available as a beta record.
- assignee: employee
- createdDate Date Created: string (date-time)
- createdfrom: salesOrder
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- entity: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- expirationdate Expiration Date: string (date)
- externalId External ID: string
- fulfillmentexception: fulfillmentRequest-fulfillmentexceptionCollection
- fulfillmenttype: object
-
- id Internal identifier.: string 1 , 2
- refName Reference Name: string
- id Internal ID: string
- ispickupemailnotificationsent Pickup Email Notification Sent: boolean
- item: fulfillmentRequest-itemCollection
- lastModifiedDate Date Last Modified: string (date-time)
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
-
A note or comment about the fulfillment request. You can also add a note or comment at the line-item level in the Request Note column. For example, you might want to add a comment at line-item level when you reject a line to record the reason for the rejection.
- orderid: string
- pickuphold: object
-
- id Internal identifier.: string 1 , 2 , 3
- refName Reference Name: string
- prevDate Previous Effective Date: string (date)
- refName Reference Name: string
- status: object
-
- id Internal identifier.: string A , R , B , C , D , E , F , G , I
- refName Reference Name: string
- subsidiary: subsidiary
- tranDate Date: string (date)
-
The date on which the fulfillment request was created. When viewing the fulfillment requests list, you can sort by date.
- tranId Fulfillment Number: string
-
A unique number that identifies the fulfillment request. NetSuite generates the number automatically, increasing the largest fulfillment request number by one. If you want, you can type another number.
- transtatus: object
-
- id Internal identifier.: string
- refName Reference Name: string
fulfillmentRequest-fulfillmentexceptionCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: fulfillmentRequest-fulfillmentexceptionElement
-
fulfillmentRequest-fulfillmentexceptionElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
fulfillmentRequest-fulfillmentexceptionElement
This record is available as a beta record.
- exceptioncomments Exception Comments: string
- exceptionquantity Exception Quantity: number (float)
- exceptionreason: nsResource
- exceptiontype: object
-
- id Internal identifier.: string 1 , 2 , 3 , 4
- refName Reference Name: string
- itemline Item: string
- links Links: nsLink
-
nsLink - quantityrequested Quantity Requested: number (float)
- refName Reference Name: string
fulfillmentRequest-item-fulfillmentitemexceptionCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: fulfillmentRequest-item-fulfillmentitemexceptionElement
-
fulfillmentRequest-item-fulfillmentitemexceptionElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
fulfillmentRequest-item-fulfillmentitemexceptionElement
This record is available as a beta record.
- exceptioncomments Exception Comments: string
- exceptionquantity Exception Quantity: number (float)
- exceptionreason: nsResource
- exceptiontype: object
-
- id Internal identifier.: string 1 , 2 , 3 , 4
- refName Reference Name: string
- fulfillmentrequest: fulfillmentRequest
- links Links: nsLink
-
nsLink - refName Reference Name: string
fulfillmentRequest-item-inventoryDetail
This record is available as a beta record.
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- externalId External ID: string
- inventoryassignment: fulfillmentRequest-item-inventoryDetail-inventoryassignmentCollection
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemDescription Description: string
-
A more complete Description of the item.
- links Links: nsLink
-
nsLink - location: location
- quantity Quantity: number (float)
-
In the Quantity to Build field, enter the number of assembly items you want to build. You cannot enter a quantity that exceeds the amount displayed in the Buildable Quantity field.
- refName Reference Name: string
- toLocation: location
- unit Units: string
-
If the assembly uses Units of Measure, the base units are displayed in the Units field.
fulfillmentRequest-item-inventoryDetail-inventoryassignmentCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: fulfillmentRequest-item-inventoryDetail-inventoryassignmentElement
-
fulfillmentRequest-item-inventoryDetail-inventoryassignmentElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
fulfillmentRequest-item-inventoryDetail-inventoryassignmentElement
This record is available as a beta record.
- binNumber: bin
- expirationDate Expiration Date: string (date)
- internalId Internal ID: integer (int64)
- inventoryDetail Inventory Detail: integer (int64)
- inventoryStatus: inventoryStatus
- issueInventoryNumber: inventoryNumber
- links Links: nsLink
-
nsLink - packCarton Pack Carton: string
- pickCarton Pick Carton: string
- quantity Quantity: number (float)
- quantityAvailable Unpicked Bin Qty: number (float)
- receiptInventoryNumber Serial/Lot Number: string
- refName Reference Name: string
- secondaryQuantity Secondary Quantity: number (float)
- toBinNumber: bin
- toInventoryStatus: inventoryStatus
fulfillmentRequest-itemCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: fulfillmentRequest-itemElement
-
fulfillmentRequest-itemElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
fulfillmentRequest-itemElement
This record is available as a beta record.
- acknowledgefulfillinstruction Acknowledge Instruction: boolean
- amount Amount: number (double)
- class: classification
- currency Currency: string
- department: department
- description Description: string
- fulfillmentinstruction: object
-
- id Internal identifier.: string F , N
- refName Reference Name: string
- fulfillmentitemexception: fulfillmentRequest-item-fulfillmentitemexceptionCollection
- inventoryDetail: fulfillmentRequest-item-inventoryDetail
- inventorysubsidiary: subsidiary
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemFxAmount Foreign Amount: number (double)
- itemName Item: string
- itemReceive Fulfill/Receive: boolean
- itemSubtype Subtype: string
- itemType Type: string
- itemUnitPrice Unit Price: number (double)
- itemUpc UPC Code: string
- jobName Job: string
- kitMemberOf Member of Line: integer (int64)
- line Transaction Line: integer (int64)
- lineEntity Entity: integer (int64)
- links Links: nsLink
-
nsLink - location: location
- onHand On Hand: number (float)
- orderDoc: nsResource
- orderLine Order Line: integer (int64)
- quantity Quantity: number (float)
- quantityfulfilled Fulfilled: number (float)
- quantitypacked Packed: number (float)
- quantitypicked Picked: number (float)
- quantityrejected Quantity Rejected: number (float)
- refName Reference Name: string
- requestnote Request Note: string
- units Units: string
- unitsDisplay Units: string
fulfillmentRequestCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: fulfillmentRequest
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
fulfillmentRequest - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
genericResource
This record is available as a beta record.
- billingClass: billingClass
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- entityId Name: string
-
Enter a name for this generic resource. For example, you could create a generic resource called Project Manager to act as a placeholder for a project manager resource.
- externalId External ID: string
- id Internal ID: string
- isInactive Inactive: boolean
-
Check this box to inactivate this generic resource. Inactivated records no longer appear in lists or as choices anywhere in your account.
- laborCost Cost: number (double)
-
Enter the estimated hourly overhead labor rate for this generic resource. This rate is used to calculate the estimated cost of project tasks this generic resource is assigned to.
- laborPrice Price: number (double)
-
Enter a price to be charged for work on projects for this generic resource.
- laborcategory: nsResource
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- subsidiary: subsidiary
- workCalendar: nsResource
genericResourceCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: genericResource
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
genericResource - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
giftCertificate
This record is available as a beta record.
- amountRemaining Amount Remaining: number (double)
-
This field displays the amount remaining on the gift certificate that can be applied to purchases. When a gift certificate is applied to a purchase, the amount of the purchase is deducted from the Original Amount. After application, any credit balance remaining that can be applied to additional purchases shows in the Amount Remaining field.
- createdDate Date Created: string (date-time)
- currency: currency
- email Recipient Email: string
-
Enter your employee's e-mail address. If you allow your employees to track time or enter expense reports online, this will become part of their access codes.
- expirationDate Expiration Date: string (date)
-
The expiration date is based on the Days Before Expiration field on the gift certificate’s item record. If necessary, enter the date the gift certificate expires. Any balance remaining on the gift certificate after the expiration date cannot be applied against purchases.
- giftCertCode Code: string
- giftCertItem: giftCertificateItem
- id Internal ID: string
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - message Gift Message: string
-
This field displays the message that is delivered to the recipient.
- name Recipient Name: string
-
Specify the name. The name identifies the record in NetSuite and is not displayed on the website.
- originalAmount Original Amount: number (double)
-
This field displays the total amount originally issued on the gift certificate. When the gift certificate is applied to a purchase, the amount of the purchase is deducted from this amount. After application, any credit balance remaining that can be applied to additional purchases shows in the Amount Remaining field.
- redeemedAt: giftCertificate-redeemedAtCollection
- refName Reference Name: string
- sender From: string
-
This field shows the name of the person that sent the certificate.
- soldOn: giftCertificate-soldOnCollection
giftCertificate-redeemedAtCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: giftCertificate-redeemedAtElement
-
giftCertificate-redeemedAtElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
giftCertificate-redeemedAtElement
This record is available as a beta record.
- kTranDoc: nsResource
- links Links: nsLink
-
nsLink - refName Reference Name: string
giftCertificate-soldOnCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: giftCertificate-soldOnElement
-
giftCertificate-soldOnElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
giftCertificate-soldOnElement
This record is available as a beta record.
- kTranDoc: nsResource
- links Links: nsLink
-
nsLink - refName Reference Name: string
giftCertificateCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: giftCertificate
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
giftCertificate - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
giftCertificateItem
This record is available as a beta record.
- authCodes: giftCertificateItem-authCodesCollection
- availableToPartners Available to Adv. Partners: boolean
-
Check this box to make this item available to partners with the Advanced Partner Center role for viewing. These items are also available to partners with roles that are customized for the Advanced Partner Center and include view, create or edit access to item records.
- billingSchedule: billingSchedule
- class: classification
- correlatedItems: giftCertificateItem-correlatedItemsCollection
- costEstimate Item Defined Cost: number (double)
-
Enter an Item Defined Cost amount.
- createdDate Date Created: string (date-time)
- customForm: object
-
- id Internal identifier.: string -210 , -10211 , -10210
- refName Reference Name: string
- daysBeforeExpiration Days Before Expiration: integer (int64)
-
If you want this item to expire, enter the number of days it should remain active after purchase. If this item is downloadable and the same customer purchases this item more than once, the countdown to expiration restarts with each purchase. Note: If this item is a gift certificate and the buyer lives in California, Connecticut, Louisiana, Massachusetts, New Hampshire, Rhode Island or Washington, by law the gift certificate cannot expire.
- department: department
- description Description: string
-
Enter a description for this item. This description will appear in the Description column of sales forms.
- displayName Display Name/Code: string
-
Enter an optional name of up to 250 characters for this item in addition to the Item Name. If you are integrating with a Yahoo! store, this field is imported from Yahoo!. The display name prints in the Item column of sales forms when Basic printing is used. If this item is a member of a kit, this name appears in the Item column when the Print Items box is checked. If you do not enter a display name, the item name appears on printed forms.
- dontShowPrice Don't Show Price: boolean
-
Check this box to hide the price of this item online. This is useful for items you want to advertise but don't want to sell or for items that you track inventory for and want to display but are offered in combination with other items.
- excludeFromSiteMap Exclude from Sitemap: boolean
-
Check this box to exclude a tab, category or item page from the site map.
- externalId External ID: string
- featuredDescription Featured Description: string
-
If this item is displayed on the home page of your Web site, enter a featured description for this item. This description appears below the item's store display name on the Home page of your store or site. You can enter up to 999 characters including basic HTML code. Enter and format text using the formatting options, or click the HTML Source Code link to enter HTML.
- id Internal ID: string
- includeChildren Include Children: boolean
-
Check the Include Children box to share the item with all the sub-subsidiaries associated with each subsidiary selected in the Subsidiary field. Note: When sharing items across subsidiaries, all of the options selected on the item record must be compatible across subsidiaries. For example, when entering an inventory item to be shared across subsidiaries, you should select Income and Asset accounts on the item record that are also shared across the same subsidiaries.
- incomeAccount: account
- internalId Internal ID: integer (int64)
-
Use this ID number to create smart tags for your item templates, site templates, and custom Web site that you host with NetSuite.
- isFulfillable Can be Fulfilled: boolean
-
Check the Can be Fulfilled/Received box to enable this item to be received and fulfilled during order processing. Clear this box if this item does not require being received and fulfilled. Note: Once this item has been added to transactions, this setting cannot be changed. This field is used when the Advanced Billing and Advanced Shipping features are both enabled.
- isGCoCompliant Google Checkout Compliant: boolean
- isInactive Inactive: boolean
-
When you check this box, this item will no longer appear on a list unless you check the Show All box at the bottom of the list page.
- isOnline Display in Website: boolean
-
Check this box to make this item available online in your Web site. You cannot sell this item online unless you check this box. If the item is of the Other Charge for Sale or Resale subtype, checking this box does not make it available in the web store catalog. However, it becomes available during web store checkout.
- issueProduct: issueProduct
- itemId Item Name/Number: string
-
Enter up to 250 characters for the name of this item. This name appears in lists on transactions. If you have the option of entering a display name and do not, the item name prints in the Item column of sales forms when Basic printing is used. If you have the option to enter a vendor name and do not, the item name prints in the Item column of purchase forms. If you have entered a display name, it will print on purchases instead of the item name when Basic printing is used.
- itemType: object
-
- lastModifiedDate Last Modified: string (date-time)
- liabilityAccount: account
- links Links: nsLink
-
nsLink - location: location
- metaTagHtml Meta Tag HTML: string
-
Enter the Meta Tag HTML you want to appear in the < head > section of this item page. Meta tags enable your Web site to be found by search engines.
- noPriceMessage No Price Message: string
-
If you opted to not show a price online, enter the message that should show instead of the price. For example, you might enter "Call for Price."
- offerSupport Offer Support: boolean
-
Check this box to offer support for this particular item. By offering support for items, customers can select on case records which item they are having trouble with.
- onSpecial On Special: boolean
-
If you want to put this item on special, check this box. The item then appears in the Specials category in your store or site.
- outOfStockBehavior: object
-
- id Internal identifier.: string DISABLE , ENABLENMSG , REMOVE , ENABLE , DEFAULT
- refName Reference Name: string
- outOfStockMessage Out Of Stock Message: string
-
You can enter a custom out of stock message for this item. The message here replaces the default out of stock message.
- pageTitle Page Title: string
-
Enter the text you want to appear as the page's title for this item. This text appears in the browser tab. Use a descriptive title for the item page, this can help achieve better results with search engine ranking.
- parent: giftCertificateItem
- parentOnly Use as Category Only: boolean
- presentationItem: giftCertificateItem-presentationItemCollection
- price: giftCertificateItem-price
- pricesIncludeTax Prices Include Tax: boolean
-
Check this box to save the base price as the tax inclusive price. Clear this box to save the base price as the tax exclusive price.
- pricingGroup: pricingGroup
- rate Price: number (double)
-
Enter the rate for this discount or markup. The rate can be either a percentage or dollar amount. A percentage discount must be followed by a % sign. A dollar amount should be entered as a positive number.
- rateIncludingTax Price Including Tax: number (double)
- refName Reference Name: string
- salesDescription Sales Description: string
-
Enter a sales description for this item. You can enter letters and numbers. There is a 999 character limit. The sales description displays on transactions such as sales orders, cash sales and invoices. If you use the Web Store feature, the sales description displays immediately under the item's store display name on item list pages in your store or site, if you have not entered a store description for an item. Enter the store description on the Store subtab of the item record. The sales description also displays by default when the item is in the Web store shopping cart.
- searchKeywords Search Keywords: string
-
Enter alternative search keywords that customers might use to find this item using your Web store’s internal search. These can include synonyms, acronyms, alternate languages or misspellings. These keywords are seen as equally important as the item name when searches are conducted.
- siteCategory: giftCertificateItem-siteCategoryCollection
- siteMapPriority: object
-
- storeDescription Store Description: string
-
The store description appears under the item's store display name on item list pages in your store or site. You can enter letters, numbers, and basic HTML code. Note: To make the store description display when an item is in the Web store shopping cart, go to Setup > Web Site > Set Up Web Site. Click the Cart subtab, and check the box next to Store Description.
- storeDetailedDescription Detailed Description: string
-
Enter a detailed description for this item. When your customers click an item's store display name for more information, they see this description. You can enter letters, numbers or basic HTML code. If you are using Internet Explorer, you can also clear the View Source box below to enter and format text using the formatting options above. This eliminates the need for HTML code. If you do not see the View Source box, make sure Rich Text Editing is enabled at Home > Set Preferences > Appearance.
- storeDisplayImage: nsResource
- storeDisplayName Store Display Name: string
-
Enter the name of this item as you want it displayed in your Web site. You can enter up to 250 characters.
- storeDisplayThumbnail: nsResource
- subsidiary: subsidiaryCollection
- subtype: object
-
- id Internal identifier.: string Sale , Purchase , Resale
- refName Reference Name: string
- upcCode UPC Code: string
-
Enter a maximum of 999 characters in this field to identify an internal name or number to store the item's UPC Code. You can use the text you enter here when adding the item to transactions, searching, or viewing reports. * When you enter text in this field, the SKU/UPC field on item labels displays this UPC Code and prints in UPC bar code format. * When this field is clear, the SKU/UPC field on item labels displays the Item Name/Number and prints in Code-128 bar code format.
- urlComponent URL Component: string
-
Enter a short, descriptive name for this item to appear as part of its URL in the Web store. Setting a name to show in the URL can result in better ranking from search engines. If you leave this field blank, NetSuite terms and numbers are used as identifiers in the URL. Note: Descriptive URL components are case sensitive. Descriptive URLs must match the case used in the URL Component field of an item record to point to the correct page.
giftCertificateItem-authCodesCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: giftCertificateItem-authCodesElement
-
giftCertificateItem-authCodesElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
giftCertificateItem-presentationItemCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: giftCertificateItem-presentationItemElement
-
giftCertificateItem-presentationItemElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
giftCertificateItem-price
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: giftCertificateItem-priceElement
-
giftCertificateItem-priceElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
giftCertificateItem-priceElement
This record is available as a beta record.
- isInactive Inactive: boolean
-
When you check this box, this item will no longer appear on a list unless you check the Show All box at the bottom of the list page.
- links Links: nsLink
-
nsLink - price Amount: number (double)
- priceLevel: priceLevel
- priceQty Sequence Number: integer (int64)
- refName Reference Name: string
giftCertificateItem-siteCategoryCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: giftCertificateItem-siteCategoryElement
-
giftCertificateItem-siteCategoryElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
giftCertificateItem-siteCategoryElement
This record is available as a beta record.
- category: nsResource
- links Links: nsLink
-
nsLink - refName Reference Name: string
- webSite: webSite
giftCertificateItemCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: giftCertificateItem
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
giftCertificateItem - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
globalAccountMapping
This record is available as a beta record.
- accountingBook: accountingBook
- class: classification
- classDisplayValue Class: string
- customField Custom Field: string
- customFieldCompId Custom Field CompId: string
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- department: department
- departmentDisplayValue Department: string
- destinationAccount: account
- effectiveDate Effective Date: string (date)
-
Enter or select the date that the account mapping begins.
- endDate End Date: string (date)
-
Enter or select the date that the account mapping ends. This field can be left blank until a new account mapping is needed. When blank, the mapping continues indefinitely.
- externalId External ID: string
- id Internal ID: string
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - location: location
- locationDisplayValue Location: string
- refName Reference Name: string
- sourceAccount: account
- subsidiary: subsidiary
globalAccountMappingCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: globalAccountMapping
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
globalAccountMapping - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
globalInventoryRelationship
This record is available as a beta record.
- alllocationscustomerreturn All Customer Return Locations: boolean
-
Check the All Customer Return Locations box to add all locations associated with the selected Inventory Subsidiary. Because this box is checked by default, all locations are included by default. When this box is checked, this Global Inventory Relationship record is linked to the Inventory Subsidiary record and the location list automatically syncs to stay updated. As locations are added or deleted from the subsidiary record, those locations are also added to or removed from this location list. For example, if this GIR is associated with Subsidiary A and you add three new locations to the Subsidiary A record, this GIR record updates to be associated with the three new locations.
- alllocationsfulfillment All Fulfillment Locations: boolean
-
Check the All Fulfillment Locations box to add all locations associated with the selected Inventory Subsidiary. Because this box is checked by default, all locations are included by default. When this box is checked, this Global Inventory Relationship record is linked to the Inventory Subsidiary record and the location list automatically syncs to stay updated. As locations are added or deleted from the subsidiary record, those locations are also added to or removed from this location list. For example, if this GIR is associated with Subsidiary A and you add three new locations to the Subsidiary A record, this GIR record updates to be associated with the three new locations.
- allowcrosssubcustomerreturn Allow Cross-Subsidiary Customer Return: boolean
- allowcrosssubfulfillment Allow Cross-Subsidiary Fulfillment: boolean
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- customerreturn: globalInventoryRelationship-customerreturnCollection
- externalId External ID: string
- fulfillment: globalInventoryRelationship-fulfillmentCollection
- id Internal ID: string
- inventorysubsidiary: subsidiary
- isInactive Inactive: boolean
-
Check the Inactive box box to prevent this GIR record from displaying in lists on records and transactions.
- links Links: nsLink
-
nsLink - loadalllocationscustomerreturn: boolean
- loadalllocationsfulfillment: boolean
- originatingsubsidiary: subsidiary
- refName Reference Name: string
globalInventoryRelationship-customerreturnCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: globalInventoryRelationship-customerreturnElement
-
globalInventoryRelationship-customerreturnElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
globalInventoryRelationship-fulfillmentCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: globalInventoryRelationship-fulfillmentElement
-
globalInventoryRelationship-fulfillmentElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
globalInventoryRelationshipCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: globalInventoryRelationship
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
globalInventoryRelationship - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
importedEmployeeExpense
This record is available as a beta record.
- billedamount Amount: number (double)
-
This is the total charged amount for this imported employee expense.
- billedcurrency: currency
- billedtaxamount Tax Amount: number (double)
-
This is the tax amount in the account's base currency. Tax amounts do not appear on expense reports.
- cardcurrency: currency
- cardmemberembossedname Card Member Embossed Name: string
-
The employee name as it appears on the credit card. Enter cardholder names on employee records on the Human Resources subtab, under Corporate Cards.
- category: expenseCategory
- chargedate Date: string (date)
- corporatecard Corporate Card: boolean
-
This box indicates if the transaction was imported from a corporate card. If this transaction was imported through an automatic import, this box is checked by default.
- costcenter Cost Center: string
-
This is your cost center with the issuing credit card company.
- currencyexchangerate Exchange Rate: number (double)
-
This is the currency exchange rate between the account's base currency and the transaction's local currency at the time the transaction occurred.
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- employee: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- externalId External ID: string
- formatprofile: nsResource
- id Internal ID: string
-
This is the unique NetSuite expense id.
- impemplexpensedetail: importedEmployeeExpense-impemplexpensedetailCollection
- internalId Internal ID: integer (int64)
- links Links: nsLink
-
nsLink - localchargeamount Foreign Amount: number (double)
-
This is the total charge in the currency where the transaction took place.
- localtaxamount Local Tax Amount: number (double)
-
This is the tax amount in the currency of the location where the transaction took place. Tax amounts do not appear on expense reports.
- memo Memo: string
-
This is a description of the transaction from the credit card company.
- refName Reference Name: string
- sourcetype: employeeExpenseSourceType
- status: object
-
- id Internal identifier.: string READY , FAILED , PROCESSED , PENDING , IGNORED
- refName Reference Name: string
- transactionid Transaction ID: string
-
This is a unique transaction id for this imported employee expense provided by the credit card company.
importedEmployeeExpense-impemplexpensedetailCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: importedEmployeeExpense-impemplexpensedetailElement
-
importedEmployeeExpense-impemplexpensedetailElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
importedEmployeeExpenseCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: importedEmployeeExpense
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
importedEmployeeExpense - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
inboundShipment
This record is available as a beta record.
- actualDeliveryDate Actual Delivery Date: string (date)
-
Use the picker to input the actual date the shipment arrived at the receiving location. The expected and actual dates can be used for the reporting of variances and setting performance metrics.
- actualShippingDate Actual Shipping Date: string (date)
-
Input a date when the consignment was actually shipped. The expected and actual dates can be used for the reporting of variances and setting performance metrics.
- apfApprovalStatus: object
-
- id Internal identifier.: string A , B
- refName Reference Name: string
- billOfLading Bill Of Lading: string
-
Enter the number from your bill of lading documentation in this field.
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- expectedDeliveryDate Expected Delivery Date: string (date)
-
Use the picker to add the date when the shipment is expected to be delivered to the receiving location.
- expectedShippingDate Expected Shipping Date: string (date)
-
Use the date picker to insert the date for when the shipment is expected to leave. The field can be edited to reflect changing circumstances.
- externalDocumentNumber External Document Number: string
-
Add the identifying number for the shipment as supplied by your shipping company here. You can customize the Inbound Shipments list page to include this field for easy identification of the shipment.
- externalId External ID: string
- id Internal ID: string
- items: inboundShipment-itemsCollection
- landedCost: inboundShipment-landedCostCollection
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- shipmentBaseCurrency: currency
- shipmentCreatedDate Date Created: string (date)
-
This is a read only field.
- shipmentMemo Memo: string
-
Use this field to highlight key, or frequently used information. It is best practice to add a User Note in the Communications subtab to log call other types of communication relating to the shipment.
- shipmentNumber Shipment Number: string
-
This is a system generated number. The format can be customized by updating the Inbound Shipment field at: Setup > Company > Auto-Generated Numbers > Transaction Numbers.
- shipmentStatus: object
-
- id Internal identifier.: string toBeShipped , inTransit , partiallyReceived , received , closed
- refName Reference Name: string
- vesselNumber Vessel Number: string
-
Input the vessel's IMO number, or other identifying reference in this field.
inboundShipment-items-inventorydetail
This record is available as a beta record.
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- externalId External ID: string
- inventoryassignment: inboundShipment-items-inventorydetail-inventoryassignmentCollection
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemDescription Description: string
- links Links: nsLink
-
nsLink - location: location
- quantity Quantity: number (float)
- refName Reference Name: string
- toLocation: location
- unit Units: string
inboundShipment-items-inventorydetail-inventoryassignmentCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: inboundShipment-items-inventorydetail-inventoryassignmentElement
-
inboundShipment-items-inventorydetail-inventoryassignmentElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
inboundShipment-items-inventorydetail-inventoryassignmentElement
This record is available as a beta record.
- binNumber: bin
- expirationDate Expiration Date: string (date)
- internalId Internal ID: integer (int64)
- inventoryDetail Inventory Detail: integer (int64)
- inventoryStatus: inventoryStatus
- issueInventoryNumber: inventoryNumber
- links Links: nsLink
-
nsLink - packCarton Pack Carton: string
- pickCarton Pick Carton: string
- quantity Quantity: number (float)
- quantityAvailable Unpicked Bin Qty: number (float)
- receiptInventoryNumber Serial/Lot Number: string
- refName Reference Name: string
- secondaryQuantity Secondary Quantity: number (float)
- toBinNumber: bin
- toInventoryStatus: inventoryStatus
inboundShipment-itemsCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: inboundShipment-itemsElement
-
inboundShipment-itemsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
inboundShipment-itemsElement
This record is available as a beta record.
- allocatedDemand Allocated Demand: number (float)
- expectedRate Expected Rate: number (double)
- id ID: integer (int64)
- incoterm: nsResource
- inventoryDetailId Inventory Detail: integer (int64)
- inventorydetail: inboundShipment-items-inventorydetail
- isNumberedItem Is Numbered Item: boolean
- links Links: nsLink
-
nsLink - poCurrency: currency
- poRate PO Rate: number (double)
- poVendor Vendor: string
- purchaseOrder: nsResource
- purchaseOrderTransaction: nsResource
- quantityBilled Quantity Billed: number (float)
- quantityExpected Quantity Expected: number (float)
- quantityReceived Quantity Received: number (float)
- quantityRemaining Quantity Remaining: number (float)
- receivingLocation: location
- refName Reference Name: string
- shipmentItem: nsResource
- shipmentItemAmount Amount: number (double)
- shipmentItemDescription Description: string
- shipmentItemEffectiveDate Effective Date: string (date)
- shipmentItemExchangeRate Exchange Rate: number (double)
- shipmentItemTransaction PO Transaction Line: string
- shipmentItemfxRateOverriden FX Rate Overridden: boolean
- totalUnitCost Total Unit Cost: number (double)
- unit Unit: string
- unitLandedCost Unit Landed Cost: number (double)
- vendorId: vendor
inboundShipment-landedCostCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: inboundShipment-landedCostElement
-
inboundShipment-landedCostElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
inboundShipment-landedCostElement
This record is available as a beta record.
- landedCostAllocationMethod: nsResource
- landedCostAmount Amount: number (double)
- landedCostCostCategory: costCategory
- landedCostCurrency: currency
- landedCostEffectiveDate Effective Date: string (date)
- landedCostExchangeRate Exchange Rate: number (double)
- landedCostExchangeRateOverriden FX Rate Overridden: boolean
- landedCostId ID: integer (int64)
- landedCostShipmentItems: nsResourceCollection
- landedCostShipmentItemsSearch: nsResourceCollection
- links Links: nsLink
-
nsLink - refName Reference Name: string
inboundShipmentCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: inboundShipment
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
inboundShipment - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
intercompanyJournalEntry
This record is available as a beta record.
- accountingBook: accountingBook
- accountingBookDetail: intercompanyJournalEntry-accountingBookDetailCollection
- appliedRules: intercompanyJournalEntry-appliedRulesCollection
- approvalStatus: object
-
- id Internal identifier.: string 11 , 1 , 2 , 3
- refName Reference Name: string
- approved Approved: boolean
-
Check this box to indicate that this journal entry is approved. If you check this box, this journal entry will post immediately. If you do not check this box, this journal entry must be approved before it posts.
- class: classification
- createdDate Date Created: string (date-time)
- createdFrom: nsResource
- currency: currency
- customForm: object
-
- id Internal identifier.: string -9970 , 30
- refName Reference Name: string
- department: department
- exchangeRate Exchange Rate: number (double)
-
This field displays the default exchange rate of the To Subsidiary's currency to the Subsidiary's currency. You can edit the exchange rate for this transaction only, or you can update the currency exchange rates list.
- excludeFromGLNumbering Exclude from GL Audit Numbering: boolean
- externalId External ID: string
- fromCurrency: string
- id Internal ID: string
- isReversal Is Reversal: boolean
- lastModifiedDate Date Last Modified: string (date-time)
- line: intercompanyJournalEntry-lineCollection
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
-
If you wish, enter a memo to describe this journal entry. It will appear on this transaction detail as well as reports such as a 2-line account register.
- nextApprover: employee
- nexus: nexus
- parentExpenseAlloc: nsResource
- postingPeriod: accountingPeriod
- prevDate Previous Effective Date: string (date)
- refName Reference Name: string
- reversalDate Reversal Date: string (date)
-
If this journal entry is intended to be reversed, enter the date for the reversing entry to be posted. If Defer Entry is checked, this field is mandatory.
- reversalDefer Defer Entry: boolean
-
Check this box to make the reversal a memorized transaction that automatically occurs on the date entered in the required Reversal Date field. Clear this box to make the reversal an immediately entered transaction with the date in the Reversal Date field.
- subsidiary: subsidiary
- toSubsidiary: subsidiary
- tranDate Date: string (date)
-
NetSuite inserts today's date as the date of this journal entry. You can enter or select another date.
- tranId Entry No.: string
-
NetSuite increases the largest journal entry number by one. If you wish, you can type another number. The next journal entry number will revert to the standard pattern. You can enter a maximum of 45 characters in this field.
intercompanyJournalEntry-accountingBookDetailCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: intercompanyJournalEntry-accountingBookDetailElement
-
intercompanyJournalEntry-accountingBookDetailElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
intercompanyJournalEntry-accountingBookDetailElement
This record is available as a beta record.
- accountingBook: accountingBook
- exchangeRate Exchange Rate: number (double)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- revRecOnRevCommitment Rev Rec on Rev Commit.: boolean
- subsidiary: subsidiary
- tranIsVsoeBundle Transaction Is VSOE Bundle: boolean
intercompanyJournalEntry-appliedRulesCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: intercompanyJournalEntry-appliedRulesElement
-
intercompanyJournalEntry-appliedRulesElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
intercompanyJournalEntry-lineCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: intercompanyJournalEntry-lineElement
-
intercompanyJournalEntry-lineElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
intercompanyJournalEntry-lineElement
This record is available as a beta record.
- account: account
- amortizationType Type: string
- class: classification
- cleared Cleared: boolean
- clearedDate Date Cleared: string (date)
- credit Credit: number (double)
- creditTax Credit Tax: number (double)
- debit Debit: number (double)
- debitTax Debit Tax: number (double)
- department: department
- eliminate Eliminate: boolean
- endDate End Date: string (date)
- entity: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- giftCertCode: giftCertificate
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- line Line Id: integer (int64)
- lineSubsidiary: subsidiary
- lineTaxCode: nsResource
- lineTaxRate Tax Rate: number (double)
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
- refName Reference Name: string
- residual Residual: number (double)
- revenueRecognitionRule: nsResource
- schedule: nsResource
- scheduleNum: nsResource
- scheduleType: object
-
- id Internal identifier.: string Amortization , RevRec
- refName Reference Name: string
- startDate Start Date: string (date)
- taxAccount: account
- taxBasis Tax Basis: number (double)
- taxDetailsReference Tax Details Reference: string
- totalAmount Total Amount: number (double)
intercompanyJournalEntryCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: intercompanyJournalEntry
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
intercompanyJournalEntry - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
intercompanyTransferOrder
This record is available as a beta record.
- accountingBookDetail: intercompanyTransferOrder-accountingBookDetailCollection
- altHandlingCost Handling Cost: number (double)
- altShippingCost Shipping Cost: number (double)
-
This field displays shipping costs associated with this transfer order.
- canBeUnapproved Can Be Unapproved: boolean
- class: classification
- createdDate Date Created: string (date-time)
- createdFrom: nsResource
- currency: currency
- customForm: object
-
- id Internal identifier.: string -9943
- refName Reference Name: string
- department: department
- discountAmount Discount Amount: number (double)
- discountDate Discount Date: string (date)
- dueDate Due Date: string (date)
- employee: employee
- endDate End Date: string (date)
- exchangeRate Exchange Rate: number (double)
- excludefromsupplyplanning Exclude from Supply Planning: boolean
- externalId External ID: string
- firmed Firmed: boolean
-
When the Firmed box is checked, the line items are no longer eligible for reallocation to another order. The items must remain committed to the firmed order. Firmed transfer orders are not available to be rescheduled or cancelled.
- fob FOB: string
- handlingCost Handling Cost: number (double)
- handlingTaxAmount Handling Tax Amount: number (double)
- hasMultiFulfillmentsToReceive: boolean
- icto: string
- id Internal ID: string
- incoTerm: nsResource
- isTransferPriceCosting: boolean
- isfobshipping: boolean
- item: intercompanyTransferOrder-itemCollection
- lastModifiedDate Date Last Modified: string (date-time)
- linkedTrackingNumbers Linked Tracking Numbers: string
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
-
Enter a memo to identify this transfer order. When you use the Search Transactions feature, you can search for specific words and phrases in the Memo field.
- needsPick: boolean
- nexus: nexus
- ordReceived Order Received: boolean
- orderStatus: object
-
- id Internal identifier.: string A , B
- refName Reference Name: string
- orderType: nsResource
- originator Originator: string
- otherRefNum PO/Check Number: string
- prevDate Previous Effective Date: string (date)
- refName Reference Name: string
- shipAddress Ship To: string
-
The Ship To Address of the transfer order defaults to the address of the destination location. To enter a different address: * Select another address in the Ship To Select field. * Select New in the Ship To Select field to enter a new billing address.
- shipAddressList: nsResource
- shipComplete Ship Complete: boolean
-
Check this box if you want to ship this order when there are enough items available to fully fulfill the orders. When fulfilling orders in bulk, you can filter the list to include those orders marked Ship Complete that can be completely fulfilled by selecting Respect Ship Complete in the Filter By field.
- shipDate Ship Date: string (date)
-
The date defaults to show the current date. You can type or pick another shipping date for this order.
- shipIsResidential Shipping address is residential: boolean
- shipMethod: shipItem
- shipOverride Override: boolean
- shippingAddress: intercompanyTransferOrder-shippingAddress
- shippingAddress_text Shipping Address: string
- shippingCost Shipping Cost: number (double)
-
The shipping cost automatically calculates depending on the shipping method you select in the Ship Via field above. To change the cost of a shipping method, go to Lists > Accounting > Shipping Items and select the shipping method you want to change. If you use UPS Real-Time rates and a package is over 150lbs, the package is charged as multiple packages equal to or less than 150lbs.
- shippingCostOverridden Shipping Cost Overridden: boolean
- shippingTaxAmount Shipping Tax Amount: number (double)
- source: object
-
- startDate Start Date: string (date)
- storeOrder: string
- subsidiary: subsidiary
- subtotal Subtotal: number (double)
-
As you add items, the total shows in this field.
- supplyPlanId: string
- supplyPlanLineId: string
- terms: term
- tosubsidiary: subsidiary
- total Total: number (double)
-
This field shows the total amount associated with this order, including shipping and handling costs.
- trackingNumbers Tracking Numbers: string
-
This field displays the tracking number provided by the carrier for the shipment.
- tranDate Date: string (date)
-
The current date autofills for this transfer order. You can select or enter a different date.
- tranId Transaction Number: string
-
Enter the number of this transfer order. If you use autogenerated numbering, the next order number in the sequence shows here. You can enter another number if you choose.
- transferlocation: location
- useItemCostAsTransferCost Use Item Cost As Transfer Cost: boolean
-
Check this box to use the transfer price as a declared shipping value for reference only. For example, for insurance or international shipping. * The transfer price is not a charge for the destination location. * The transfer price does not affect inventory costing on transactions. * The transfer price defaults to show the value in the Transfer Price field of item records. * Partial fulfillment and receipt of transfer orders is allowed, but you cannot receive more than you have fulfilled on any date. For example, if you have fulfilled 10 widgets out of 20 on a transfer order, you cannot receive 12 widgets on that order. Clear this box to use the transfer price shown on the transfer order as the item cost on the item receipt. Important: If no transfer price is entered on the transfer order, no cost is recorded on the item receipt. * Any difference between the actual cost and the transfer price posts to a Gain/Loss account when the item is shipped. * The transfer price and the Gain/Loss account are defined on each item record. * The transfer price defaults to show the value in the Transfer Price field of item records. If you use approval routing, this setting can be changed on a transfer order as long as the transfer order is not yet approved. Once the transfer order is approved, this setting cannot be changed.
- webSite: string
intercompanyTransferOrder-accountingBookDetailCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: intercompanyTransferOrder-accountingBookDetailElement
-
intercompanyTransferOrder-accountingBookDetailElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
intercompanyTransferOrder-accountingBookDetailElement
This record is available as a beta record.
- accountingBook: accountingBook
- exchangeRate Exchange Rate: number (double)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- revRecOnRevCommitment Rev Rec on Rev Commit.: boolean
- subsidiary: subsidiary
- tranIsVsoeBundle Transaction Is VSOE Bundle: boolean
intercompanyTransferOrder-item-inventoryDetail
This record is available as a beta record.
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- externalId External ID: string
- inventoryassignment: intercompanyTransferOrder-item-inventoryDetail-inventoryassignmentCollection
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemDescription Description: string
-
A more complete Description of the item.
- links Links: nsLink
-
nsLink - location: location
- quantity Quantity: number (float)
-
In the Quantity to Build field, enter the number of assembly items you want to build. You cannot enter a quantity that exceeds the amount displayed in the Buildable Quantity field.
- refName Reference Name: string
- toLocation: location
- unit Units: string
-
If the assembly uses Units of Measure, the base units are displayed in the Units field.
intercompanyTransferOrder-item-inventoryDetail-inventoryassignmentCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: intercompanyTransferOrder-item-inventoryDetail-inventoryassignmentElement
-
intercompanyTransferOrder-item-inventoryDetail-inventoryassignmentElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
intercompanyTransferOrder-item-inventoryDetail-inventoryassignmentElement
This record is available as a beta record.
- binNumber: bin
- expirationDate Expiration Date: string (date)
- internalId Internal ID: integer (int64)
- inventoryDetail Inventory Detail: integer (int64)
- inventoryStatus: inventoryStatus
- issueInventoryNumber: inventoryNumber
- links Links: nsLink
-
nsLink - packCarton Pack Carton: string
- pickCarton Pick Carton: string
- quantity Quantity: number (float)
- quantityAvailable Unpicked Bin Qty: number (float)
- receiptInventoryNumber Serial/Lot Number: string
- refName Reference Name: string
- secondaryQuantity Secondary Quantity: number (float)
- toBinNumber: bin
- toInventoryStatus: inventoryStatus
intercompanyTransferOrder-itemCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: intercompanyTransferOrder-itemElement
-
intercompanyTransferOrder-itemElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
intercompanyTransferOrder-itemElement
This record is available as a beta record.
- allocationAlert Reallocate Order Item: string
- amount Amount: number (double)
- billVarianceStatus: object
-
- id Internal identifier.: string NOVARIANCES , JOURNALNOTPOSTED , JOURNALPOSTED
- refName Reference Name: string
- class: classification
- commitInventory: object
-
- id Internal identifier.: string 1 , 2 , 3
- refName Reference Name: string
- commitmentFirm Commitment Confirmed: boolean
- costingMethod: string
- daysLate Days Late: integer (int64)
- department: department
- description Description: string
- excludeFromPredictiveRisk Exclude From Predictive Risk: boolean
- expectedShipDate Expected Ship Date: string (date)
- initOqpBucket Initial OQP Bucket: string
- inventoryDetail: intercompanyTransferOrder-item-inventoryDetail
- isClosed Closed: boolean
- isOpen Is Opened: boolean
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemSubtype: object
-
- id Internal identifier.: string Sale , Purchase , Resale
- refName Reference Name: string
- itemType: object
-
- licenseCode License Code: string
- line Transaction Line: integer (int64)
- linked Linked: boolean
- links Links: nsLink
-
nsLink - location: location
- marginal Marginal: boolean
- matrixType Matrix Type: string
- minQty Minimum Quantity: number (float)
- options Options: string
- oqpBucket Oqp Bucket: string
- orderAllocationStrategy: nsResource
- orderPriority Order Priority: number (float)
- printItems Print Items: boolean
- quantity Quantity: number (float)
- quantityAllocated Quantity Allocated: number (float)
- quantityAvailable Available: number (float)
- quantityBackOrdered Back Ordered: number (float)
- quantityCommitted Committed: number (float)
- quantityDemandAllocated Allocated Demand: number (float)
- quantityFulfilled <NULL>: number (float)
- quantityOnHand On Hand: number (float)
- quantityPacked Quantity Packed: number (float)
- quantityReceived <NULL>: number (float)
- rate Rate: number (double)
- rateIncludingTax Rate: number (double)
- rateSchedule Rate Schedule: string
- refName Reference Name: string
- requestedDate Requested Date: string (date)
- subsidiary: subsidiary
- units Units: string
intercompanyTransferOrder-shippingAddress
This record is available as a beta record.
- addr1 Address 1: string
-
Enter the address the way it should appear on forms. For employees, customers, partners, and vendors, what you enter here autofills on forms if this address is marked default for Shipping or Billing. Enter up to 50 characters. This field is required for the Online Bill Pay feature.
- addr2 Address 2: string
-
Enter an optional second address line the way it should appear on forms. For employees, customers, partners, and vendors, what you enter here autofills on forms if this address is marked default for Shipping or Billing. Enter up to 50 characters.
- addr3 Address 3: string
- addrPhone Phone: string
-
Enter the phone number.
- addrText Address: string
-
The values entered in the other address fields are displayed here.
- addressee Addressee: string
-
Enter the name of the entity that should appear on the shipping label here. This name appears on the shipping label below what you enter in the Attention field.
- attention Attention: string
-
Enter the name of the person to whom a shipment is addressed, as it should appear on shipping labels. This field is required for UPS Integration.
- city City: string
-
Enter the city the way it should appear on all forms except checks.
- country: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- externalId External ID: string
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - override Override: boolean
-
Check this box to disable the free-form address text field. When this field is disabled, text entered in the other address fields does not display in the Address text field. Clear this box to allow text entered in the address component fields to appear in the free-form address text field.
- refName Reference Name: string
- state State/Province: string
-
Enter your company's state or province the way it should appear on all forms except checks.
- zip Zip: string
-
Enter the postal code the way it should appear on all forms except checks.
intercompanyTransferOrderCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: intercompanyTransferOrder
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
intercompanyTransferOrder - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
inventoryAdjustment
This record is available as a beta record.
- account: account
- accountingBookDetail: inventoryAdjustment-accountingBookDetailCollection
- adjLocation: location
- class: classification
- cleared Cleared: boolean
- clearedDate Date Cleared: string (date)
- createdDate Date Created: string (date-time)
- currencyPrecision Currency Precision: string
- customForm: object
-
- id Internal identifier.: string -9990
- refName Reference Name: string
- customer: customer
- department: department
- estimatedTotalValue Estimated Total Value: number (double)
-
This is the total value of the change in your inventory. When you submit the adjustment, the current cost is determined from your inventory database and your adjustment totals are updated.
- excludeFromGLNumbering Exclude from GL Audit Numbering: boolean
- externalId External ID: string
- id Internal ID: string
- inventory: inventoryAdjustment-inventoryCollection
- lastModifiedDate Date Last Modified: string (date-time)
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
-
Enter an optional memo for this adjustment. It will appear on a register or Account Detail report.
- postingPeriod: accountingPeriod
- prevDate Previous Effective Date: string (date)
- refName Reference Name: string
- subsidiary: subsidiary
- tranDate Date: string (date)
-
Today's date autofills as the date of this inventory adjustment. You can enter or choose another date.
- tranId Ref No.: string
-
Enter an optional reference number for this inventory adjustment. Reference Numbers for inventory adjustments do not have to be consecutive. You can enter a maximum of 45 characters in this field.
inventoryAdjustment-accountingBookDetailCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: inventoryAdjustment-accountingBookDetailElement
-
inventoryAdjustment-accountingBookDetailElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
inventoryAdjustment-accountingBookDetailElement
This record is available as a beta record.
- accountingBook: accountingBook
- exchangeRate Exchange Rate: number (double)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- revRecOnRevCommitment Rev Rec on Rev Commit.: boolean
- subsidiary: subsidiary
- tranIsVsoeBundle Transaction Is VSOE Bundle: boolean
inventoryAdjustment-inventory-inventoryDetail
This record is available as a beta record.
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- externalId External ID: string
- inventoryassignment: inventoryAdjustment-inventory-inventoryDetail-inventoryassignmentCollection
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemDescription Description: string
-
A more complete Description of the item.
- links Links: nsLink
-
nsLink - location: location
- quantity Quantity: number (float)
-
In the Quantity to Build field, enter the number of assembly items you want to build. You cannot enter a quantity that exceeds the amount displayed in the Buildable Quantity field.
- refName Reference Name: string
- toLocation: location
- unit Units: string
-
If the assembly uses Units of Measure, the base units are displayed in the Units field.
inventoryAdjustment-inventory-inventoryDetail-inventoryassignmentCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: inventoryAdjustment-inventory-inventoryDetail-inventoryassignmentElement
-
inventoryAdjustment-inventory-inventoryDetail-inventoryassignmentElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
inventoryAdjustment-inventory-inventoryDetail-inventoryassignmentElement
This record is available as a beta record.
- binNumber: bin
- expirationDate Expiration Date: string (date)
- internalId Internal ID: integer (int64)
- inventoryDetail Inventory Detail: integer (int64)
- inventoryStatus: inventoryStatus
- issueInventoryNumber: inventoryNumber
- links Links: nsLink
-
nsLink - packCarton Pack Carton: string
- pickCarton Pick Carton: string
- quantity Quantity: number (float)
- quantityAvailable Unpicked Bin Qty: number (float)
- receiptInventoryNumber Serial/Lot Number: string
- refName Reference Name: string
- secondaryQuantity Secondary Quantity: number (float)
- toBinNumber: bin
- toInventoryStatus: inventoryStatus
inventoryAdjustment-inventoryCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: inventoryAdjustment-inventoryElement
-
inventoryAdjustment-inventoryElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
inventoryAdjustment-inventoryElement
This record is available as a beta record.
- adjustQtyBy Adjust Qty By: number (float)
- adjustqtybytype: string
- avgunitcost: number (double)
- class: classification
- costingMethod: string
- currency: string
- currentValue Current Value: number (double)
- department: department
- description Description: string
- exchangeRate: number (float)
- foreigncurrencyunitcost: number (double)
- inventoryDetail: inventoryAdjustment-inventory-inventoryDetail
- invtdiffvalue: number (double)
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- label Exchange Rate: string
- labelcurrency Currency: string
- labelfxunitcost Unit Cost in Foreign Currency: string
- line: string
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
- newQuantity New Qty: number (float)
- quantityOnHand Qty On Hand: number (float)
- refName Reference Name: string
- subsidiary: subsidiary
- unitCost Unit Cost: number (double)
- unitconversionrate: number (float)
- units Units: string
inventoryAdjustmentCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: inventoryAdjustment
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
inventoryAdjustment - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
inventoryCostRevaluation
This record is available as a beta record.
- account: account
- accountingBookDetail: inventoryCostRevaluation-accountingBookDetailCollection
- class: classification
- costcomponent: inventoryCostRevaluation-costcomponentCollection
- costingMethod: string
- createdDate Date Created: string (date-time)
- currencyPrecision Currency Precision: string
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- department: department
- excludeFromGLNumbering Exclude from GL Audit Numbering: boolean
- externalId External ID: string
- id Internal ID: string
- inventoryValue New Inventory Value: number (double)
- ispurchase: string
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemType: string
- itemcostcategory: integer (int64)
- lastModifiedDate Date Last Modified: string (date-time)
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
-
Type a memo for this inventory cost revaluation.
- overheadType: string
- postingPeriod: accountingPeriod
- prevDate Previous Effective Date: string (date)
- refName Reference Name: string
- selloutlineamount: string
- subsidiary: subsidiary
- total Adjustment Amount: number (double)
- tranDate Date: string (date)
-
Type a date for this inventory cost revaluation. The default date is the system date.
- tranId Ref No.: string
-
Type a reference number, if required.
- unitCost New Unit Cost: number (double)
-
This field displays the revised unit cost after revaluation.
inventoryCostRevaluation-accountingBookDetailCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: inventoryCostRevaluation-accountingBookDetailElement
-
inventoryCostRevaluation-accountingBookDetailElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
inventoryCostRevaluation-accountingBookDetailElement
This record is available as a beta record.
- accountingBook: accountingBook
- exchangeRate Exchange Rate: number (double)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- revRecOnRevCommitment Rev Rec on Rev Commit.: boolean
- subsidiary: subsidiary
- tranIsVsoeBundle Transaction Is VSOE Bundle: boolean
inventoryCostRevaluation-costcomponentCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: inventoryCostRevaluation-costcomponentElement
-
inventoryCostRevaluation-costcomponentElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
inventoryCostRevaluation-costcomponentElement
This record is available as a beta record.
- amount Amount: string
- componentItem: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- conversionRate Conversion Rate {1}: number (float)
- cost Cost: number (double)
- costCategory: costCategory
- costype Cost Category: string
- ismaterialoverhead: string
- isrouting: string
- lineid Line Id: string
- links Links: nsLink
-
nsLink - overheadType Overhead Type: string
- quantity Quantity: number (float)
- refName Reference Name: string
- units Units: string
inventoryCostRevaluationCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: inventoryCostRevaluation
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
inventoryCostRevaluation - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
inventoryCount
This record is available as a beta record.
- account: account
- class: classification
- countDate Count Start Date: string (date)
- createdDate Date Created: string (date-time)
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- department: department
- excludeFromGLNumbering Exclude from GL Audit Numbering: boolean
-
Check this box to exclude inventory count transactions from GL audit numbering.
- externalId External ID: string
- id Internal ID: string
- item: inventoryCount-itemCollection
- lastModifiedDate Date Last Modified: string (date-time)
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
-
Optionally enter a memo for this transaction. Later you can search for this transaction using the text in this field.
- prevDate Previous Effective Date: string (date)
- refName Reference Name: string
- selStatus: object
-
- id Internal identifier.: string A , B , C , D
- refName Reference Name: string
- status: object
-
- id Internal identifier.: string A , B , C , D
- refName Reference Name: string
- statusKey Status: string
- subsidiary: subsidiary
- tranDate Date: string (date)
-
Verify or select a date for this transaction.
- tranId Ref No.: string
-
Optionally enter a reference number for this transaction.
inventoryCount-item-countDetail
This record is available as a beta record.
- baseUnitQuantity: number (float)
- bin: bin
- conversionRate Conversion Rate {1}: number (float)
- externalId External ID: string
- internalId Internal ID: integer (int64)
- inventoryDetail: inventoryCount-item-countDetail-inventoryDetailCollection
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- lineId Line Id: integer (int64)
- links Links: nsLink
-
nsLink - location: location
- quantity Quantity: number (float)
- refName Reference Name: string
- totalQuantity: number (float)
- transactionId: integer (int64)
- units Units: string
inventoryCount-item-countDetail-inventoryDetailCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: inventoryCount-item-countDetail-inventoryDetailElement
-
inventoryCount-item-countDetail-inventoryDetailElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
inventoryCount-item-countDetail-inventoryDetailElement
This record is available as a beta record.
- id Internal ID: integer (int64)
- internalid Internal ID: integer (int64)
- inventoryDetail: integer (int64)
- inventoryNumber Serial/Lot Number: string
- inventorystatus: inventoryStatus
- links Links: nsLink
-
nsLink - quantity Quantity: number (float)
- refName Reference Name: string
inventoryCount-item-inventoryCountAdjustment
This record is available as a beta record.
- bin: bin
- conversionRate Conversion Rate {1}: number (float)
- externalId External ID: string
- id Internal ID: integer (int64)
- inventoryCountLine Item Count: string
- inventoryDetail: inventoryCount-item-inventoryCountAdjustment-inventoryDetailCollection
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- lineId Line Id: integer (int64)
- links Links: nsLink
-
nsLink - location: location
- quantity Quantity: number (float)
- refName Reference Name: string
- transactionId: integer (int64)
- units Units: string
inventoryCount-item-inventoryCountAdjustment-inventoryDetailCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: inventoryCount-item-inventoryCountAdjustment-inventoryDetailElement
-
inventoryCount-item-inventoryCountAdjustment-inventoryDetailElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
inventoryCount-item-inventoryCountAdjustment-inventoryDetailElement
This record is available as a beta record.
- id Internal ID: integer (int64)
- internalId Internal ID: integer (int64)
- inventoryDetail: integer (int64)
- inventoryNumber: inventoryNumber
- inventorystatus: inventoryStatus
- links Links: nsLink
-
nsLink - quantity Quantity: number (float)
- refName Reference Name: string
- units Units: string
inventoryCount-item-inventoryCountSnapshot
This record is available as a beta record.
- bin: bin
- conversionRate Conversion Rate {1}: number (float)
- externalId External ID: string
- id Internal ID: integer (int64)
- inventoryCountLine Item Count: string
- inventoryDetail: inventoryCount-item-inventoryCountSnapshot-inventoryDetailCollection
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- lineId Line Id: integer (int64)
- links Links: nsLink
-
nsLink - location: location
- quantity Quantity: number (float)
- refName Reference Name: string
- transactionId: integer (int64)
- units Units: string
inventoryCount-item-inventoryCountSnapshot-inventoryDetailCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: inventoryCount-item-inventoryCountSnapshot-inventoryDetailElement
-
inventoryCount-item-inventoryCountSnapshot-inventoryDetailElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
inventoryCount-item-inventoryCountSnapshot-inventoryDetailElement
This record is available as a beta record.
- id Internal ID: integer (int64)
- internalId Internal ID: integer (int64)
- inventorystatus: inventoryStatus
- links Links: nsLink
-
nsLink - quantity Quantity: number (float)
- refName Reference Name: string
inventoryCount-itemCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: inventoryCount-itemElement
-
inventoryCount-itemElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
inventoryCount-itemElement
This record is available as a beta record.
- adjustedLine: integer (int64)
- adjustedQuantity Adjusted Quantity: number (double)
- binLocation: location
- binName: string
- binNumber: bin
- countDetail: inventoryCount-item-countDetail
- countLine: integer (int64)
- countQuantity Count Quantity: number (double)
- inventoryCountAdjustment: inventoryCount-item-inventoryCountAdjustment
- inventoryCountSnapshot: inventoryCount-item-inventoryCountSnapshot
- isSerial: boolean
- item: inventoryItem
- itemCurrentCountDoc: string
- itemUsesBins: boolean
- links Links: nsLink
-
nsLink - memo Memo: string
- rate Rate: number (double)
- refName Reference Name: string
- serialOrLot: boolean
- snapshotDetailId: integer (int64)
- snapshotLine: integer (int64)
- snapshotQuantity Snapshot Quantity: number (double)
- units Units: string
- varianceDetailId: integer (int64)
- viewAdjustment Variance Detail: string
- viewSnapshot Snapshot Detail: string
inventoryCountCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: inventoryCount
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
inventoryCount - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
inventoryItem
- VSOEDeferral: object
-
- id Internal identifier.: string DEFERALLUNTIL , DEFERUNTIL
- refName Reference Name: string
- VSOEDelivered Default as Delivered: boolean
-
Check this box to automatically set this item to a Delivered status when this item is added to a transaction. Clear this box to leave the delivery status clear by default.
- VSOEPermitDiscount: object
-
- id Internal identifier.: string IFDELIVERED , NEVER
- refName Reference Name: string
- VSOEPrice Allocation Price: number (double)
-
Enter the VSOE Price for this item if it is known. Note: If you need to use more than one VSOE price for an item, you can set the most common price here and then change the price on each order manually.
- VSOESopGroup: object
-
- id Internal identifier.: string EXCLUDE , NORMAL , SOFTWARE
- refName Reference Name: string
- accountingBookDetail: inventoryItem-accountingBookDetailCollection
- alternateDemandSourceItem: inventoryItem
- amortizationPeriod Amortization Period: integer (int64)
- amortizationTemplate: amortizationTemplate
- assetAccount: account
- atpLeadTime ATP Lead Time: integer (int64)
- atpMethod: object
-
- id Internal identifier.: string CUMULATIVE_ATP_WITH_LOOK_AHEAD , DISCRETE_ATP
- refName Reference Name: string
- autoExpandKitForRevenuemgmt Auto-Expansion for Revenue Management: boolean
- autoLeadTime Auto-Calculate: boolean
-
Lead time is the average number of days between ordering this item from the vendor and receiving it. * Check the Auto-Calculate box if you want NetSuite to calculate the lead time based on the most recent order history of this item. This is calculated by taking the number of days between the order entry and receipt on the three most recent purchase orders, and dividing by three. o If there are multiple receipts for the item against the same purchase order, only the first receipt is used for the calculation. o Lead time calculation is not weighted by number of units received. o More recent purchase orders without receipts are ignored. * Clear the Auto-Calculate box to manually enter a lead time value in days. If the Auto-Calculate box is cleared and no value is entered, then the default value from the Set Up Inventory Management page is used.
- autoPreferredStockLevel Auto-Calculate: boolean
-
The preferred stock level is the optimum quantity to maintain in stock of an item. The quantity you enter here is used to determine your replenishment needs on the Order Items page. It is the quantity you want to have in stock after an order is placed. * Auto-Calculating – Check the Auto-Calculate box if you want NetSuite to calculate the preferred stock level based on demand for the item. The preferred stock level is calculated as: (daily demand * number of days supply preferred). If no preferred stock level is identified, then the default preferred stock level is used from the Set Up Inventory Management page. * Manually Calculating – Clear the Auto-Calculate box to manually enter the preferred stock quantity. The preferred stock level you set is used to calculate the quantity of items to be ordered on the Order Items page.
- autoReorderPoint Auto-Calculate: boolean
-
Reorder Point is the quantity level at which you need to reorder or build more of this item. * Auto-Calculate – Check the Auto-Calculate box to automatically calculate the reorder point based on demand for the item over time. The reorder point depends on the safety stock definition and is calculated as follows: o Without safety stock defined: Reorder point = (average lead time days * demand) o With safety stock defined in days: Reorder point = [(average lead time days + safety stock days) * demand] o With safety stock quantity defined: Reorder point = [(average lead time days * demand) + safety stock quantity) * Manually Calculate – Clear the Auto-Calculate box to manually enter the point at which to reorder or build more of this item. If you go to Home > User Preferences and place a check mark in the Inventory Level Warnings box, NetSuite reminds you when you have reached the reorder point.
- availableToPartners Available to Adv. Partners: boolean
-
Check this box to make this item available to partners with the Advanced Partner Center role for viewing. These items are also available to partners with roles that are customized for the Advanced Partner Center and include view, create or edit access to item records.
- averageCost Average Cost: number (double)
-
This field displays the current average cost of the item across all locations. Using the weighted-average method, the average cost is calculated as the total units available during a period divided by the beginning inventory cost plus the cost of additions to inventory. Note: The average cost calculated per location is listed for each location on the Locations subtab. If you use Multiple Units of Measure, average cost is calculated using stock units.
- backwardConsumptionDays Backward Consumption Days: integer (int64)
-
When you use the Forecast Consumption demand source method, set the following: * Forward Consumption – Number of days after the order date to consider * Backward Consumption – Number of days prior to the order date to consider When backward and forward consumption days are entered for an item, these fields determine the window, or time period, that is considered for each sales order when a forecast amount may be consumed to calculate demand. If an order falls within the consumption window, that order quantity is calculated as being consumed and the forecast is adjusted to account for the order consumption. Note: NetSuite always considers backward consumption first. The forecast closest to the order in the backward window is consumed first. The forecast closest to the order in the forward window is considered if there are remaining quantities to be consumed. Note: Only sales order and invoice quantities can consume forecast quantities. Demand from transfer orders and work orders does not consume forecast quantities.
- baseUnit Primary Base Unit: string
-
This field displays the base unit of measure for this item.
- billExchRateVarianceAcct: account
- billPriceVarianceAcct: account
- billQtyVarianceAcct: account
- billingSchedule: billingSchedule
- binNumber: inventoryItem-binNumberCollection
- class: classification
- cogsAccount: account
- consumptionUnit Primary Consumption Unit: string
-
If you use the Multiple Units of Measure feature, select the default unit of measure for inventory.
- contingentRevenueHandling Eligible For Contingent Revenue Handling: boolean
-
Check this box to indicate that the item is subject to contingent revenue handling. When checked, revenue allocation is affected.
- conversionRate Conversion Rate (/Primary Base): number (float)
- copyDescription Copy from Sales Order: boolean
-
Check this box to copy the purchase description from the item description you enter on a sales order. Clear this box to enter a purchase description in the field above.
- correlatedItems: inventoryItem-correlatedItemsCollection
- cost Purchase Price: number (double)
-
Enter the price you pay for this item. If you do not enter a price, purchase orders for this item show the most recent purchase price by default. If you select a preferred vendor for this item, the price is shown in the currency selected on the vendor's record. If no preferred vendor is selected, the price is shown in your base currency.
- costAccountingStatus Cost Accounting Status: string
- costEstimate Item Defined Cost: number (double)
-
Enter an Item Defined Cost amount.
- costEstimateUnits Est. Cost Unit: string
- costingMethod: object
-
- id Internal identifier.: string SERIAL , LOT , AVG , LIFO , GROUPAVG , FIFO , STANDARD
- refName Reference Name: string
- countryOfManufacture: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- createExpensePlansOn: nsResource
- createRevenuePlansOn: nsResource
- createdDate Date Created: string (date-time)
- currency: currency
- custReturnVarianceAccount: account
- customForm: object
-
- id Internal identifier.: string -200 , -10201 , -10200
- refName Reference Name: string
- dateConvertedToInv Date Converted To Inv.: string (date-time)
- defaultItemShipMethod: shipItem
- defaultReturnCost Default Return Cost: number (double)
-
Enter the rate you want to default to show as the cost for this item when it is returned. What you enter in this field defaults to show in the Override Rate field on item receipts. You can still change this value after it appears on the item receipt.
- defaultReturnCostUnits: string
- deferralAccount: account
- deferredRevenueAccount: account
- demandModifier Estimated Demand Change: number (double)
-
Enter the default percentage of Expected Demand Change to use for calculating item demand. For example, if you know that new customers will increase sales of this item in the future, you can enter a 10% expected demand change to be added on to previous sales totals. If no expected demand change percentage is entered, then the default value from the Set Up Inventory Management page is used.
- demandSource: object
-
- id Internal identifier.: string FORECASTANDORDERS , EXISTINGORDERSANDDEPENDENTDEMAND , FORECASTCONSUMPTION , ITEMDEMANDPLAN
- refName Reference Name: string
- demandTimeFence Demand Time Fence: integer (int64)
-
Demand Time Fence defaults to the number entered in the Default Demand Time Fence field. Verify the default or enter a number between zero and 365 to determine the demand time fence for this item.
- department: department
- description Description: string
-
Enter a description for this item. This description will appear in the Description column of sales forms.
- directRevenuePosting Direct Revenue Posting: boolean
-
Check this box to disable advanced revenue management for this item. When checked, posting transactions that include this item post directly to the item revenue account. No revenue element or revenue arrangement is created. When you check this box, the Deferred Revenue Account on the Accounting subtab is disabled. When you create sales transactions that include items that have this box checked, all the items in the transaction must have the box checked. You cannot mix items that post directly to revenue with items that post to deferred revenue in the same transaction. This restriction also applies to kit items. All items in a kit must post either to revenue or to deferred revenue. You cannot check or clear the box after the item has been used in a transaction with advanced revenue management. By default, this box is not checked.
- displayName Display Name/Code: string
-
Enter an optional name of up to 250 characters for this item in addition to the Item Name. If you are integrating with a Yahoo! store, this field is imported from Yahoo!. The display name prints in the Item column of sales forms when Basic printing is used. If this item is a member of a kit, this name appears in the Item column when the Print Items box is checked. If you do not enter a display name, the item name appears on printed forms.
- distributionCategory: nsResource
- distributionNetwork: nsResource
- dontShowPrice Don't Show Price: boolean
-
Check this box to hide the price of this item online. This is useful for items you want to advertise but don't want to sell or for items that you track inventory for and want to display but are offered in combination with other items.
- dropShipExpenseAccount: account
- enableCatchWeight Enable Catch Weight: boolean
- enforceminqtyinternally Enforce Minimum Internally: boolean
-
Check this box to apply the minimum quantity restriction on sales orders generated from NetSuite. When you clear this box, but enter a number in the Minimum Quantity field, the minimum quantity is only applied to web store orders.
- excludeFromSiteMap Exclude from Sitemap: boolean
-
Check this box to exclude a tab, category or item page from the site map.
- expenseAmortizationRule: nsResource
- externalId External ID: string
- featuredDescription Featured Description: string
-
If this item is displayed on the home page of your Web site, enter a featured description for this item. This description appears below the item's store display name on the Home page of your store or site. You can enter up to 999 characters including basic HTML code. Enter and format text using the formatting options, or click the HTML Source Code link to enter HTML.
- fixedLotSize Fixed Lot Size: number (float)
-
If you selected Fixed Lot Size as the lot sizing method, then enter a quantity in the Fixed Lot Size field. This is the quantity that procurement of this item is always based on, regardless of demand projections.
- fixedLotSizeUnits: string
- forwardConsumptionDays Forward Consumption Days: integer (int64)
-
When you use the Forecast Consumption demand source method, set the following: * Forward Consumption – Number of days after the order date to consider * Backward Consumption – Number of days prior to the order date to consider When backward and forward consumption days are entered for an item, these fields determine the window, or time period, that is considered for each sales order when a forecast amount may be consumed to calculate demand. If an order falls within the consumption window, that order quantity is calculated as being consumed and the forecast is adjusted to account for the order consumption. Note: NetSuite always considers backward consumption first. The forecast closest to the order in the backward window is consumed first. The forecast closest to the order in the forward window is considered if there are remaining quantities to be consumed. Note: Only sales order and invoice quantities can consume forecast quantities. Demand from transfer orders and work orders does not consume forecast quantities.
- fraudRisk: object
-
- id Internal identifier.: string LOW , MEDIUM , HIGH
- refName Reference Name: string
- froogleProductFeed Google Base Product Feed: boolean
-
Check this box to include this item when exporting item lists to Froogle. Clear this box to remove this item when exporting item lists to Froogle.
- futurehorizon Supply Chain Future Horizon: integer (int64)
-
Enter the number of days ahead you want to be included in a snapshot for this item. This will include future orders beyond the snapshot generated for this item. For example, when you select 30 in this field, open orders that are past due by 30 days are included. The default for this field is 30 days. The maximum you can enter in this field is 365 days.
- gainLossAccount: account
- handlingCost Handling Cost: number (double)
-
As an option, you may enter a handling cost for this item in dollars. You must also create a shipping item for per-item shipping and handling costs at Lists > Shipping Items > New. When this item is selected on sales orders, invoices or cash sales, the appropriate shipping and handling charges are automatically calculated.
- hazmatHazardClass Hazmat Hazard Class: string
-
Enter the DOT hazardous material class or division.
- hazmatId Hazmat Id: string
-
Enter the regulatory identifier for the commodity from the Federal Express Ground Hazardous Materials Shipping Guide. The format is UNXXXX, where XXXX is a four digit number.
- hazmatItemUnits Hazmat Item Units: string
-
Enter the unit of measure for this item, such as kg or ml.
- hazmatItemUnitsQty Hazmat Item Units Quantity: number (float)
-
Enter the quantity for the item units.
- hazmatPackingGroup: object
-
- id Internal identifier.: string , DEFAULT , I , II , III
- refName Reference Name: string
- hazmatShippingName Hazmat Shipping Name: string
-
Enter the shipping name for the ID as listed in the Federal Express Ground Hazardous Materials Shipping Guide. This item appears on the OP950 form.
- hierarchyVersions: inventoryItem-hierarchyVersionsCollection
- id Internal ID: string
- includeChildren Include Children: boolean
-
Check the Include Children box to share the item with all the sub-subsidiaries associated with each subsidiary selected in the Subsidiary field. Note: When sharing items across subsidiaries, all of the options selected on the item record must be compatible across subsidiaries. For example, when entering an inventory item to be shared across subsidiaries, you should select Income and Asset accounts on the item record that are also shared across the same subsidiaries.
- incomeAccount: account
- insertItemAttribute: object
-
- id Internal identifier.: string class , department , itemid , location , issueproduct , vendorname
- refName Reference Name: string
- interCoDefRevAccount: account
- intercoCogsAccount: account
- intercoExpenseAccountHidden: string
- intercoIncomeAccount: account
- internalId Internal ID: integer (int64)
-
Use this ID number to create smart tags for your item templates, site templates, and custom Web site that you host with NetSuite. Smart tags use the following format:
- isDropShipItem Drop Ship Item: boolean
-
Check the Drop Ship Item box to have this item default as a drop ship item on sales orders. When a sales transaction for a drop ship item is approved, a linked purchase order for the preferred vendor is automatically generated. The vendor ships this item to your customer directly. Note: an item can be a drop ship or a special order, but not both.
- isGCoCompliant Google Checkout Compliant: boolean
- isHazmatItem Hazmat/Dangerous Goods: boolean
-
Check this box if this item is categorized as either hazardous material or dangerous goods. These items can only be shipped using FedEx integration.
- isInactive Inactive: boolean
-
When you check this box, this item will no longer appear on a list unless you check the Show All box at the bottom of the list page.
- isLotItem Lot Numbered: boolean
- isOnline Display in Website: boolean
-
Check this box to make this item available online in your Web site. You cannot sell this item online unless you check this box. If the item is of the Other Charge for Sale or Resale subtype, checking this box does not make it available in the web store catalog. However, it becomes available during web store checkout.
- isSerialItem Serialized: boolean
- isSpecialOrderItem Special Order Item: boolean
-
Check this box if you want this item to default as a special order on sales transactions. When a sales transaction for a special order item is approved, a linked purchase order is automatically generated. Then, the order cannot be fulfilled until the linked purchase order is received. Special order items can be used for custom orders or "just-in-time" inventory. Important: You must identify a preferred vendor and a purchase price on an item record in order for that item to be selected as a special order. Note: An item can be a drop ship or a special order, but not both.
- isStorePickupAllowed Store Pickup Allowed: boolean
-
If this box is checked, indicates that at least one location allows store pickup of the item. If you clear the Allow Store Pickup box in the Locations sublist for all locations, this box is also cleared when you save the item record. This field is read only.
- issueProduct: issueProduct
- itemCarrier: object
-
- id Internal identifier.: string ups , nonups
- refName Reference Name: string
- itemId Item Name/Number: string
-
Enter up to 250 characters for the name of this item. This name appears in lists on transactions. If you have the option of entering a display name and do not, the item name prints in the Item column of sales forms when Basic printing is used. If you have the option to enter a vendor name and do not, the item name prints in the Item column of purchase forms. If you have entered a display name, it will print on purchases instead of the item name when Basic printing is used.
- itemProcessFamily: nsResource
- itemProcessGroup: nsResource
- itemRevenueCategory: nsResource
- itemShipMethod: shipItemCollection
- itemType: object
-
- itemVendor: inventoryItem-itemVendorCollection
- lastModifiedDate Last Modified: string (date-time)
- lastPurchasePrice Last Purchase Price: number (double)
-
This field displays the most recent purchase price of the item. This price is determined by the most recent transaction for the item that added positive inventory, such as a purchase receipt, inventory transfer or inventory adjustment. (This does not include item returns or assembly unbuilds.) If two transactions are entered on the same day, the one entered later takes precedence and is used to calculate the last purchase price. When you use the Multiple-Location Inventory feature, the following is true: * The last purchase price reflects the most recent transaction at any location. * The Inventory subtab of inventory item records includes a link to the last positive-inventory transaction per location. * If multiple purchases are made on the same day with different prices and locations, then the highest price paid on that day becomes the last purchase price. If you use Multiple Units of Measure, the last purchase price is calculated using purchase units.
- leadTime Purchase Lead Time: integer (int64)
-
Lead time is the average number of days between ordering this item from the vendor and receiving it. * Auto-Calculating – Check the Auto-Calculate box if you want NetSuite to calculate the lead time based on the most recent order history of this item. Lead time is calculated by taking the number of days between the order entry and receipt on the three most recent purchase orders, and dividing by three. If more than three purchase orders exist, all purchase orders within the period specified in the Order Analysis Interval field on the Inventory Management Preferences dialog will be used. o If there are multiple receipts for the item against the same purchase order, the calculation is made using the difference between the purchase order and the last receipt (the receipt that fully receives the order). o Lead time calculation is not weighted by number of units received. o More recent purchase orders without receipts are ignored. * Manually Calculating – Clear the Auto-Calculate box to manually enter a lead time value in days. If the Auto-Calculate box is cleared and no value is entered, then the default value from the Set Up Inventory Management page is used.
- links Links: nsLink
-
nsLink - location: location
- locations: inventoryItem-locationsCollection
- lowerWarningLimit Lower Warning Limit % (-): number (float)
- manufacturer Manufacturer: string
-
Enter the name of the company that manufactures this item.
- manufacturerAddr1 Manufacturer Address: string
-
Enter the address of the manufacturer. This is necessary to fill out international shipping forms when you sell and ship this item.
- manufacturerCity Manufacturer City: string
-
Enter the city location of the manufacturer of this item. This is necessary to automatically fill out international forms when you ship this item across borders.
- manufacturerState Manufacturer State: string
-
Enter the state where this item's manufacturer is located. This is necessary to fill out international forms when you ship this item.
- manufacturerTariff HS Tariff Number: string
-
Enter the Harmonized System (HS) tariff code number or the Harmonized Tariff Schedule (HTS) code number. This number should be six to ten characters.
- manufacturerTaxId Manufacturer Tax Id: string
-
Enter the Tax ID Number (TIN) for the manufacturer.
- manufacturerZip Manufacturer Zip Code: string
-
Enter the postal code of the location of this manufacturer. This is necessary to create international forms when you ship this item.
- matchBillToReceipt Match Bill To Receipt: boolean
-
Check the Match Bill to Receipt box if you want the Match Bill to Receipt box on transaction lines to be checked by default for this item. This enables you to generate variances based on vendor bill lines. Then, on the Post Vendor Bill Variances page, you must select Bill in the Transaction Type field to generate the variance postings. Purchase orders that include this item default to have this box checked and variances are generated based on vendor bill lines. Clear this box if you want to generate variance postings based on purchase order lines rather than vendor bill lines and do not want the Match Bill to Receipt box to be checked by default on transaction lines for this item. Then, on the Post Vendor Bill Variances page, you must select Purchase Order in the Transaction Type field to generate the variance postings. This preference defaults to be disabled. Even when enabled, this option can be changed on individual purchase order lines.
- matrixItemNameTemplate Matrix Item Name Template: string
-
This field is used to control how the matrix item will be displayed in the Matrix Item Name/Number field. Compose the order in which attributes and matrix options are displayed by selecting from the Insert Item Attribute and Insert Matrix Option dropdown lists. Add custom separator characters to easier distinguish the various options. Example: Item Name: Fabric / Color / Waist / Length [Location]
- matrixItemNameTemplateHelp Matrix Item Name Template: string
- matrixType: object
-
- id Internal identifier.: string , PARENT , CHILD
- refName Reference Name: string
- maximumquantity Maximum Order Qty: integer (int64)
-
Enter the greatest quantity of this item that customers can purchase. If customers enter an item quantity above the maximum amount, a warning message is displayed. Web store customers are unable to complete checkout unless they enter a quantity equal to or below the maximum quantity. Leave this field empty to allow customers to check out without maximum quantity restrictions. You can edit this warning at Setup > Site Builder/SuiteCommerce Advanced > Customize Text.
- metaTagHtml Meta Tag HTML: string
-
Enter the Meta Tag HTML you want to appear in the < head > section of this item page. Meta tags enable your Web site to be found by search engines.
- minimumquantity Minimum Order Qty: integer (int64)
-
Enter the lowest quantity that customers can purchase. Web store customers receive a warning and cannot check out if they enter an item quantity below this minimum. Leave this field empty to allow customers to check out with no minimum quantity restrictions. You can edit this warning at Setup > Site Builder/SuiteCommerce Advanced > Customize Text.
- mpn Manufacturer Part Number: string
-
MPN (Manufacturers Part Number) - Enter the part number used by the manufacturer to identify this item.
- multManufactureAddr Multiple Manufacturer Addresses: boolean
-
Check the Multiple Manufacture Addresses box if this manufacturer uses more than one address.
- nexTagCategory NexTag Category: string
-
Enter the name of the NexTag category this item should be included in. This category is included in the product feeds you can export at Setup > Web Site > Product Feeds.
- nexTagProductFeed NexTag Product Feed: boolean
-
Check this box to include this item when exporting item lists to NexTag. Clear this box to remove this item when exporting item lists to NexTag.
- noPriceMessage No Price Message: string
-
If you opted to not show a price online, enter the message that should show instead of the price. For example, you might enter "Call for Price."
- offerSupport Offer Support: boolean
-
Check this box to offer support for this particular item. By offering support for items, customers can select on case records which item they are having trouble with.
- onSpecial On Special: boolean
-
If you want to put this item on special, check this box. The item then appears in the Specials category in your store or site.
- originalItemSubtype Original Item Subtype: string
- originalItemType Original Item Type: string
- outOfStockBehavior: object
-
- id Internal identifier.: string DISABLE , ENABLENMSG , REMOVE , ENABLE , DEFAULT
- refName Reference Name: string
- outOfStockMessage Out Of Stock Message: string
-
You can enter a custom out of stock message for this item. The message here replaces the default out of stock message.
- overallQuantityPricingType: object
-
- id Internal identifier.: string ITEM , PARENT , SCHEDULE
- refName Reference Name: string
- pageTitle Page Title: string
-
Enter the text you want to appear as the page's title for this item. This text appears in the browser tab. Use a descriptive title for the item page, this can help achieve better results with search engine ranking.
- parent: inventoryItem
- parentOnly Use as Category Only: boolean
- periodicLotSizeDays Periods of Supply Increment: integer (int64)
-
In the Period of Supply Increment field, enter a number from 1 to 90. The default setting is 1. The increment starts on the first day an order is required. From the first day, NetSuite aggregates all orders in the increment. Orders are placed on the first day of the period. Note: The Periodic Lot Size Increment field is enabled only when you select Interval in the Periodic Lot Size Type field.
- periodicLotSizeType: object
-
- id Internal identifier.: string INTERVAL , WEEKLY , MONTHLY
- refName Reference Name: string
- planningItemCategory: planningItemCategory
- preferenceCriterion: object
-
- id Internal identifier.: string , A , B , C , D , E , F
- refName Reference Name: string
- preferredLocation: location
- preferredStockLevel Preferred Stock Level: number (float)
-
The preferred stock level is the optimum quantity to maintain in stock of an item. The quantity you enter here is used to determine your replenishment needs on the Order Items page. It is the quantity you want to have in stock after an order is placed. * Auto-Calculating – Check the Auto-Calculate box if you want NetSuite to calculate the preferred stock level based on demand for the item. The preferred stock level is calculated as: (daily demand * number of days supply preferred). If no preferred stock level is identified, then the default preferred stock level is used from the Set Up Inventory Management page. * Manually Calculating – Clear the Auto-Calculate box to manually enter the preferred stock quantity. The preferred stock level you set is used to calculate the quantity of items to be ordered on the Order Items page.
- preferredStockLevelDays Days: number (float)
-
The preferred stock level is the optimum quantity to maintain in stock of an item. The quantity you enter here is used to determine your replenishment needs on the Order Items page. It is the quantity you want to have in stock after an order is placed. * Auto-Calculating – Check the Auto-Calculate box if you want NetSuite to calculate the preferred stock level based on demand for the item. The preferred stock level is calculated as: (daily demand * number of days supply preferred). If no preferred stock level is identified, then the default preferred stock level is used from the Set Up Inventory Management page. * Manually Calculating – Clear the Auto-Calculate box to manually enter the preferred stock quantity. The preferred stock level you set is used to calculate the quantity of items to be ordered on the Order Items page.
- preferredStockLevelUnits: string
- presentationItem: inventoryItem-presentationItemCollection
- price: inventoryItem-price
- pricesIncludeTax Prices Include Tax: boolean
-
Check this box to save the base price as the tax inclusive price. Clear this box to save the base price as the tax exclusive price.
- pricingGroup: pricingGroup
- purchaseDescription Purchase Description: string
-
Enter up to 999 characters of text for a description of this item to appear on vendor orders. Include the unit of measure in this description.
- purchaseOrderAmount Vendor Bill - Purchase Order Amount Tolerance: number (float)
-
Enter the tolerance limit for the discrepancy between the amount on the vendor bill and purchase order.
- purchaseOrderQuantity Vendor Bill - Purchase Order Quantity Tolerance: number (float)
-
Enter the tolerance limit for the discrepancy between the quantity on the vendor bill and purchase order.
- purchaseOrderQuantityDiff Vendor Bill - Purchase Order Quantity Difference: number (float)
-
Enter the difference limit for the discrepancy between the quantity on the vendor bill and purchase order.
- purchasePriceVarianceAcct: account
- purchaseUnit Primary Purchase Unit: string
-
Select the unit you use to purchase this item from the vendor.
- quantityAvailable Quantity Available: number (float)
- quantityAvailableBase Quantity Available (Base Unit): number (float)
- quantityBackOrdered Quantity Back Ordered: number (float)
- quantityCommitted Quantity Committed: number (float)
-
This field shows the number of this item that are already committed to be sold and are currently showing on orders.
- quantityOnHand Quantity On Hand: number (float)
-
This field shows the quantity of this item you have on hand.
- quantityOnHandBase Quantity On Hand (Base Unit): number (float)
- quantityOnOrder Quantity On Order: number (float)
-
This field shows the quantity of this item you currently have on order with the vendor.
- quantityPricingSchedule: nsResource
- rate Price: number (double)
-
Enter the rate for this discount or markup. The rate can be either a percentage or dollar amount. A percentage discount must be followed by a % sign. A dollar amount should be entered as a positive number.
- rateIncludingTax Price Including Tax: number (double)
- receiptAmount Vendor Bill - Item Receipt Amount Tolerance: number (float)
-
Enter the tolerance limit for the discrepancy between the amount on the vendor bill and item receipt.
- receiptQuantity Vendor Bill - Item Receipt Quantity Tolerance: number (float)
-
Enter the tolerance limit for the discrepancy between the quantity on the vendor bill and item receipt.
- receiptQuantityDiff Vendor Bill - Item Receipt Quantity Difference: number (float)
-
Enter the difference limit for the discrepancy between the quantity on the vendor bill and item receipt.
- refName Reference Name: string
- reorderMultiple Reorder Multiple: integer (int64)
-
Enter the quantity you prefer to order of this item each time. Then, the Order Items page suggests ordering a quantity of this item that is always multiple of the number you enter. For example, if the vendor only accepts orders in multiples of one thousand, you would enter 1000 in this field. Then, the Order items page might suggest that you order 1000 or 2000, but not 1500. Note: If you use the Multiple Units of Measure feature, the reorder multiple always functions in base units.
- reorderPoint Reorder Point: number (float)
-
The Reorder Point is the quantity level at which you need to reorder or build more of this item. * Auto-Calculating – Check the Auto-Calculate box if you want NetSuite to calculate the reorder point based on demand for the item over time. The reorder point depends on the safety stock definition and is calculated as follows: o Without safety stock defined: Reorder point = (average lead time days * demand) o With safety stock defined in days: Reorder point = [(average lead time days + safety stock days) * demand] o With safety stock quantity defined: Reorder point = [(average lead time days * demand) + safety stock quantity) * Manually Calculating – Clear the Auto-Calculate box if you want to manually enter the point at which to reorder or build more of this item. If you go to Home > User Preferences and place a check mark in the Inventory Level Warnings box, you are reminded when you have reached the reorder point.
- reorderPointUnits: string
- rescheduleInDays Reschedule In Days: integer (int64)
-
In the Reschedule In Days field, enter a number between one and 90 that is the maximum number of days that the order can be advanced from the current day. For example, if you enter 10 in this field, an order for this item can be moved up ten days earlier, but not eleven or more days. This field defaults to be blank. Note: If this field is left blank, NetSuite does not make recommendations to reschedule orders for this item to a later date.
- rescheduleOutDays Reschedule Out Days: integer (int64)
-
In the Reschedule Out Days field, enter a number between one and 180 that is the maximum number of days that the order can be delayed from the current day. For example, if you enter 10 in this field, an order for this item can be moved to ten days later, but not eleven or more days. This field defaults to be blank. Note: If this field is left blank, NetSuite does not make recommendations to reschedule orders for this item to a later date.
- residual Residual: number (double)
- revRecForecastRule: nsResource
- revReclassFxAccount: account
- revenueAllocationGroup: nsResource
- revenueRecognitionRule: nsResource
- rotationType: object
-
- id Internal identifier.: string LEFO , FEFO
- refName Reference Name: string
- roundUpAsComponent Round Up Quantity as Component: boolean
-
If you use the component yield preference, depending on your settings, the component yield calculation may result in a fractional quantity. You can use this setting so that the quantity for a component on a work order automatically rounds up to a whole number in base units. For example, you have an assembly that requires 2 units of Component A. The component yield is 99%. To build 5 of these assemblies requires 10.1 units of Component A. Since you can consume components only in whole numbers, you cannot consume 10.1 units. Therefore, you need to round up to the next highest whole number in base units. Check the Round Up Quantity as Component box to enable NetSuite to round up the quantity consumed for this item. Clear this box if you do not want NetSuite to round up the quantity consumed for this item.
- safetyStockLevel Safety Stock Level: number (float)
-
Enter the amount of an item you prefer to keep in stock at all times. Safety stock can be a quantity or a number of days worth of stock. This amount is used to auto-calculate the reorder point of an item. * To define safety stock as a quantity, enter a value. * To define safety stock as a number of days, enter a value in the field next to Days. If no safety stock value is entered, then the default value from the Set Up Inventory Management page is used.
- safetyStockLevelDays Safety Stock Level Days: integer (int64)
-
Enter the amount of an item you prefer to keep in stock at all times. Safety stock can be a quantity or a number of days worth of stock. This amount is used to auto-calculate the reorder point of an item. * To define safety stock as a quantity, enter a value. * To define safety stock as a number of days, enter a value in the field next to Days. If no safety stock value is entered, then the default value from the Set Up Inventory Management page is used.
- saleUnit Primary Sale Unit: string
-
Select the unit you use to sell this item to customers on sales transactions.
- salesDescription Sales Description: string
-
Enter a sales description for this item. You can enter letters and numbers. There is a 999 character limit. The sales description displays on transactions such as sales orders, cash sales and invoices. If you use the Web Store feature, the sales description displays immediately under the item's store display name on item list pages in your store or site, if you have not entered a store description for an item. Enter the store description on the Store subtab of the item record. The sales description also displays by default when the item is in the Web store shopping cart.
- savedReorderPoint Reorder Point: number (float)
- scheduleBCode: object
-
- scheduleBNumber Schedule B Number: string
-
Enter the number for the Schedule B form for this item.
- scheduleBQuantity Schedule B Quantity: number (float)
-
Enter the numeric quantity in relation to the unit of measure entered in the Schedule B Code field. These two fields are used together to determine the amount represented by one of this item on the Schedule B form for Shipping Export Declarations. For example, if you enter 5 in the Schedule B Quantity field, and you select kilogram in the Schedule B Code field, when you fulfill two of these items on an order, the Schedule B form presents the items’ amount as 10 kilograms.
- searchKeywords Search Keywords: string
-
Enter alternative search keywords that customers might use to find this item using your Web store’s internal search. These can include synonyms, acronyms, alternate languages or misspellings. These keywords are seen as equally important as the item name when searches are conducted.
- seasonalDemand Seasonal Demand: boolean
-
Check the Seasonal Demand box to define how NetSuite analyzes customer demand for this item . Customer demand for an item is used to auto-calculate reorder points and preferred stock levels. An item’s demand rate is calculated as the average sales quantity per day. * Historical Demand – Clear the Seasonal Demand box to calculate the demand as average sales per day over a specific period. To set the number of months interval between analysis to evaluate sales orders and calculate item demand, go to Setup > Accounting > Set Up Inventory Management > Order Analysis Interval field. * Seasonal Demand – Check the Seasonal Demand box to calculate the reorder quantity for this item based on inventory demand changes through the year. To set the number of months interval between analysis to evaluate sales orders and calculate item demand, go to Setup > Accounting > Set Up Inventory Management > Order Analysis Interval field.
- secondaryBaseUnit Secondary Base Unit: string
- secondaryConsumptionUnit Secondary Consumption Unit: string
- secondaryPurchaseUnit Secondary Purchase Unit: string
- secondarySaleUnit Secondary Sale Unit: string
- secondaryStockUnit Secondary Stock Unit: string
- secondaryUnitsType: unitsType
- shipIndividually Ships Individually: boolean
-
Check this box if this item always ships alone and with no other items in the same package. This helps determine the number of packages needed and the shipping rate on order fulfillments.
- shipPackage: nsResource
- shippingCost Shipping Cost: number (double)
-
As an option, you may enter a shipping cost for this item in dollars. You must also create a shipping item for per-item shipping costs at Lists > Shipping Items > New. When this item is selected on sales orders, invoices or cash sales, the appropriate shipping charges are automatically calculated.
- shoppingDotComCategory Shopping.com Category: string
-
Enter the name of the Shopping.com category that this item should go under. This category is included in the product feeds that you can export from Setup > Web Site > Product Feeds. Go to www.shopping.com for more information on the categories available. This is an optional field only available for following item records: Kit/Package, Non-inventory Item for Sale, Non-inventory Item for Resale, Assembly (lot and serialized), and Inventory (lot and serialized).
- shoppingProductFeed Shopping Product Feed: boolean
-
Check this box to include this item when exporting item lists to Shopping.com. Clear this box to remove this item when exporting item lists to Shopping.com.
- shopzillaCategoryId Shopzilla Category ID: integer (int64)
-
Enter the name of the Shopzilla category this item should be included in. This category is included in the product feeds you export at Setup > Web Site > Product Feeds. Go to www.shopzilla.com for more information on the available categories. This is an optional field only displayed for the following item records: Kit/Package, Non-inventory Item for Sale, Non-inventory Item for Resale, Assembly (lot and serialized), and Inventory (lot and serialized).
- shopzillaProductFeed Shopzilla Product Feed: boolean
-
Check this box to include this item when exporting item lists to Shopzilla. Clear this box to remove this item when exporting item lists to Shopzilla.
- siteCategory: inventoryItem-siteCategoryCollection
- siteMapPriority: object
-
- stockDescription Stock Description: string
-
Enter up to 21 characters to specify information about this item, such as New, Refurbished or Ships 2-3 days.
- stockUnit Primary Stock Unit: string
-
Select the unit you use to stock this item in inventory.
- storeDescription Store Description: string
-
The store description appears under the item's store display name on item list pages in your store or site. You can enter letters, numbers, and basic HTML code. Note: To make the store description display when an item is in the Web store shopping cart, go to Setup > Web Site > Set Up Web Site. Click the Cart subtab, and check the box next to Store Description.
- storeDetailedDescription Detailed Description: string
-
Enter a detailed description for this item. When your customers click an item's store display name for more information, they see this description. You can enter letters, numbers or basic HTML code. If you are using Internet Explorer, you can also clear the View Source box below to enter and format text using the formatting options above. This eliminates the need for HTML code. If you do not see the View Source box, make sure Rich Text Editing is enabled at Home > Set Preferences > Appearance.
- storeDisplayImage: nsResource
- storeDisplayName Store Display Name: string
-
Enter the name of this item as you want it displayed in your Web site. You can enter up to 250 characters.
- storeDisplayThumbnail: nsResource
- subsidiary: subsidiaryCollection
- supplyLotSizingMethod: object
-
- id Internal identifier.: string FIXED_LOT_SIZE , LOT_FOR_LOT , PERIODIC_LOT_SIZE
- refName Reference Name: string
- supplyReplenishmentMethod: object
-
- id Internal identifier.: string TIME_PHASED , MPS , REORDER_POINT , MRP
- refName Reference Name: string
- supplyTimeFence Planning Time Fence: integer (int64)
-
This field defaults to the number entered in the Default Planning Time Fence field. Verify the default or enter a number between zero and 365 to determine the planning time fence for this item.
- supplyType: object
-
- id Internal identifier.: string TRANSFER , PURCHASE
- refName Reference Name: string
- totalValue Total Value: number (double)
-
Enter or accept the total value of this item. NetSuite generates this amount by multiplying your purchase price and your quantity on hand. As you buy and sell additional inventory, NetSuite continues to calculate the total value.
- trackLandedCost Track Landed Cost: boolean
-
Check this box to track landed costs associated with this item. Note: You must include an item that tracks landed costs on transactions you want to source for landed costs. For example, on the Landed Costs subtab of item receipts, a vendor bill shows in the source transaction list only if the bill includes a landed cost item.
- transferPrice Transfer Price: number (double)
-
Enter a transfer price on an item record to set the default value used as the transfer price on transfer orders. You can still override this default by entering a new transfer price for an item on the transfer order. The use of the value in the Transfer Price field on a transfer order depends on your setting for the Use Item Cost as Transfer Cost preference. When the Use Item Cost as Transfer Cost preference is enabled, the transfer price on a transfer order is not considered for posting cost accounting of line items. In the Transfer Price field, enter a declared value for the item to be used for shipping purposes only. When the Use Item Cost as Transfer Cost preference is disabled, the transfer price on a transfer order is considered for posting cost accounting of line items. Items that do not have a transfer price set on a transfer order use a zero value for cost accounting calculations when the item is received. Note: If the Transfer Price field is blank on the item record, a value of zero shows by default on the transfer order. Unless a transfer price value is entered on the transfer order, a value of zero is used for COGS calculations when the item is received.
- transferPriceUnits Transfer Price Units: string
- unitsType: unitsType
- upcCode UPC Code: string
-
Enter a maximum of 999 characters in this field to identify an internal name or number to store the item's UPC Code. You can use the text you enter here when adding the item to transactions, searching, or viewing reports. * When you enter text in this field, the SKU/UPC field on item labels displays this UPC Code and prints in UPC bar code format. * When this field is clear, the SKU/UPC field on item labels displays the Item Name/Number and prints in Code-128 bar code format.
- upperWarningLimit Upper Warning Limit % (+): number (float)
- urlComponent URL Component: string
-
Enter a short, descriptive name for this item to appear as part of its URL in the Web store. Setting a name to show in the URL can result in better ranking from search engines. If you leave this field blank, NetSuite terms and numbers are used as identifiers in the URL. Note: Descriptive URL components are case sensitive. Descriptive URLs must match the case used in the URL Component field of an item record to point to the correct page.
- useBins Use Bins: boolean
-
Check this box to track bin locations for this item. If you choose to use bins for this item, you must associate at least one bin with the item using the Bin Numbers subtab. You can associate multiple items with one bin and multiple bins with one item. You can also designate one preferred bin per location. The preferred bin is listed by default on receipt and fulfillment transactions. To create bin records that can be selected here, go to Lists > Supply Chain > Bins > New.
- useMarginalRates Use Marginal Rates: boolean
-
Check this box if you want the quantity discounts in the schedule to be applied to each pricing bracket separately. For example, a schedule offers no discount for the first 100 items sold and a 5% discount if more than 100 are sold. If 150 items are sold, the first 100 are at normal price, and the other fifty items are sold at 5% discount. Leave this box clear if you want the discount to apply to all of the items sold.
- vendReturnVarianceAccount: account
- vendor: vendor
- vendorName Vendor Name/Code: string
-
If your vendor uses a name for this item that is different from the name you use, you can enter up to 60 characters as the vendor's name for this item here. The vendor's name for this item prints in the Item column of purchase forms. If you do not enter a vendor name, the item name prints in the Item column of purchase forms. If you have entered a display name, it will print on purchases instead of the item name.
- weight Item Weight : number (float)
-
Enter the weight of this item and select the units in the dropdown.
- weightUnit: object
-
- id Internal identifier.: string 1 , 2 , 3 , 4
- refName Reference Name: string
- weightUnits Weight Units: string
- yahooProductFeed Yahoo Shopping Product Feed: boolean
inventoryItem-accountingBookDetailCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: inventoryItem-accountingBookDetailElement
-
inventoryItem-accountingBookDetailElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
inventoryItem-accountingBookDetailElement
- accountingBook: accountingBook
- amortizationTemplate: amortizationTemplate
- createExpensePlansOn: nsResource
- createRevenuePlansOn: nsResource
- links Links: nsLink
-
nsLink - refName Reference Name: string
- revRecForecastRule: nsResource
- revRecSchedule: revRecTemplate
- revenueRecognitionRule: nsResource
- sameAsPrimaryAmortization Same as Primary Book Amortization: boolean
- sameAsPrimaryRevRec Same as Primary Book Rev Rec: boolean
inventoryItem-binNumberCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: inventoryItem-binNumberElement
-
inventoryItem-binNumberElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
inventoryItem-hierarchyVersionsCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: inventoryItem-hierarchyVersionsElement
-
inventoryItem-hierarchyVersionsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
inventoryItem-hierarchyVersionsElement
- endDate Hierarchy Version End Date: string (date)
- hierarchyNode: merchandiseHierarchyNode
- hierarchyVersion: merchandiseHierarchyVersion
- isIncluded Included In Version: boolean
- links Links: nsLink
-
nsLink - refName Reference Name: string
- startDate Hierarchy Version Start Date: string (date)
inventoryItem-itemVendor-itemVendorPrice
- externalId External ID: string
- itemvendorpricelines: inventoryItem-itemVendor-itemVendorPrice-itemvendorpricelinesCollection
- links Links: nsLink
-
nsLink - refName Reference Name: string
inventoryItem-itemVendor-itemVendorPrice-itemvendorpricelinesCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: inventoryItem-itemVendor-itemVendorPrice-itemvendorpricelinesElement
-
inventoryItem-itemVendor-itemVendorPrice-itemvendorpricelinesElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
inventoryItem-itemVendorCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: inventoryItem-itemVendorElement
-
inventoryItem-itemVendorElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
inventoryItem-itemVendorElement
- itemVendorPrice: inventoryItem-itemVendor-itemVendorPrice
- links Links: nsLink
-
nsLink - predConfidence Predicted Risk Confidence: number (double)
- predictedDays Predicted Days Late/Early: integer (int64)
- preferredVendor Preferred: boolean
- purchasePrice Purchase Price: number (double)
- refName Reference Name: string
- schedule: nsResource
- subsidiary: subsidiary
- vendor: vendor
- vendorCode Code: string
- vendorCurrencyName Currency: string
inventoryItem-locationsCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: inventoryItem-locationsElement
-
inventoryItem-locationsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
inventoryItem-locationsElement
- advanceWarningThreshold Firm/Release Advance Warning Threshold: integer (int64)
- atpLeadTime ATP Lead Time: integer (int64)
- averageCostMli Average Cost: number (double)
- backwardConsumptionDays Backward Consumption Days: integer (int64)
- cost Standard Cost: number (double)
- costAccountingStatus Cost Accounting Status: string
- costingLotSize Costing Lot Size: number (float)
- currentStandardCost Current Standard Cost: number (double)
- currentStandardCostEffectiveDate Current Standard Cost Effective Date: string (date)
- defaultReturnCost Default Return Cost: number (double)
- demandSource: object
-
- id Internal identifier.: string FORECASTANDORDERS , EXISTINGORDERSANDDEPENDENTDEMAND , FORECASTCONSUMPTION , ITEMDEMANDPLAN
- refName Reference Name: string
- demandTimeFence Demand Time Fence: integer (int64)
- fixedLotSize Fixed Lot Size: number (float)
- forwardConsumptionDays Forward Consumption Days: integer (int64)
- inventoryCostTemplate: nsResource
- lastPurchasePriceMli Last Purchase Price: number (double)
- lateDemandThreshold High Impact Late Demand Threshold: number (float)
- latePeriodDays Late Period Days: integer (int64)
- leadTime Purchase Lead Time: integer (int64)
- links Links: nsLink
-
nsLink - location: location
- locationAllowStorePickup Allow Store Pickup: boolean
- locationCostingGroup: nsResource
- locationId Location: integer (int64)
- locationStorePickupBufferStock Store Pickup Buffer Stock: number (float)
- location_display Location: string
- locationqtyavailforstorepickup Quantity Available for Store Pickup: number (float)
- minimumRescheduleDays Minimum Reschedule Days: integer (int64)
- onHandValueMli Value: number (double)
- pastDueForecastDays Past Due Forecast Days: integer (int64)
- periodicLotSizeDays Periods of Supply Increment: integer (int64)
- periodicLotSizeType: object
-
- id Internal identifier.: string INTERVAL , WEEKLY , MONTHLY
- refName Reference Name: string
- poReceiptCost PO Receipt Cost: number (double)
- preferredStockLevel Preferred Stock Level: number (float)
- qtyInTransitExternal Quantity In Transit (External): number (float)
- quantityAvailable Quantity Available: number (float)
- quantityAvailableBase Quantity Available (Base Unit): number (float)
- quantityBackOrdered Quantity Back Ordered: number (float)
- quantityCommitted Quantity Committed: number (float)
- quantityInTransit Quantity In Transit: number (float)
- quantityOnHand Quantity On Hand: number (float)
- quantityOnHandBase Quantity On Hand (Base Unit): number (float)
- quantityOnOrder Quantity On Order: number (float)
- refName Reference Name: string
- reorderPoint Reorder Point: number (float)
- rescheduleHorizon Reschedule Horizon: integer (int64)
- rescheduleInDays Reschedule In Days: integer (int64)
- rescheduleOutDays Reschedule Out Days: integer (int64)
- safetyStockLevel Safety Stock Level: number (float)
- savedReorderPoint Reorder Point: number (float)
- supplyLotSizingMethod: object
-
- id Internal identifier.: string FIXED_LOT_SIZE , LOT_FOR_LOT , PERIODIC_LOT_SIZE
- refName Reference Name: string
- supplyTimeFence Planning Time Fence: integer (int64)
- supplyType: object
-
- id Internal identifier.: string TRANSFER , PURCHASE
- refName Reference Name: string
inventoryItem-presentationItemCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: inventoryItem-presentationItemElement
-
inventoryItem-presentationItemElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
inventoryItem-price
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: inventoryItem-priceElement
-
inventoryItem-priceElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
inventoryItem-priceElement
- currencyPage: currency
- discountDisplay Default Discount %: number (double)
- isInactive Inactive: boolean
-
When you check this box, this item will no longer appear on a list unless you check the Show All box at the bottom of the list page.
- links Links: nsLink
-
nsLink - price Amount: number (double)
- priceLevel: priceLevel
- priceLevelName Price Level: string
- priceQty Sequence Number: integer (int64)
- quantity: object
-
- value Value: string
- refName Reference Name: string
inventoryItem-siteCategoryCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: inventoryItem-siteCategoryElement
-
inventoryItem-siteCategoryElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
inventoryItem-siteCategoryElement
- category: nsResource
- links Links: nsLink
-
nsLink - refName Reference Name: string
- webSite: webSite
inventoryItemCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: inventoryItem
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
inventoryItem - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
inventoryNumber
This record is available as a beta record.
- baseUnit Base Unit: string
-
This field displays the base unit of measure for this item.
- expirationDate Expiration Date: string (date)
- externalId External ID: string
- id Internal ID: string
- inventoryBalance: inventoryNumber-inventoryBalanceCollection
- inventoryNumber Serial/Lot Number: string
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemname Item Name: string
-
Type up to 60 characters for the name of this item. This name appears in lists on transactions. If you have the option of entering a display name and do not, the item name prints in the Item column of sales forms. If you have the option to enter a vendor name and do not, the item name prints in the Item column of purchase forms.
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - locations: inventoryNumber-locationsCollection
- memo Memo: string
-
Optionally enter a memo. Later, you can search for the text you enter in this field.
- quantityAvailable Available: number (float)
- quantityAvailableBase Available (Base Unit): number (float)
- quantityInTransit In Transit: number (float)
- quantityOnHand On Hand: number (float)
- quantityOnHandBase On Hand (Base Unit): number (float)
- quantityOnOrder On Order: number (float)
-
This field shows the quantity of this item you currently have on order with the vendor.
- refName Reference Name: string
- status Status: string
- units Stock Unit: string
inventoryNumber-inventoryBalanceCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: inventoryNumber-inventoryBalanceElement
-
inventoryNumber-inventoryBalanceElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
inventoryNumber-inventoryBalanceElement
This record is available as a beta record.
- binNumber: bin
- committedQtyPerLocation Committed Quantity (Per Location): string
- committedQtyPerSerialLotNumber Committed Quantity (Per Serial/Lot Number): string
- committedQtyPerSerialLotNumberLocation Committed Quantity (Per Serial/Lot Number & Location): string
- inventoryStatus: inventoryStatus
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- links Links: nsLink
-
nsLink - location: location
- quantityAvailable Available Quantity: string
- quantityOnHand On-Hand Quantity: string
- quantityPicked Picked Quantity: string
- refName Reference Name: string
inventoryNumber-locationsCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: inventoryNumber-locationsElement
-
inventoryNumber-locationsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
inventoryNumber-locationsElement
This record is available as a beta record.
- links Links: nsLink
-
nsLink - location: location
- quantityAvailable Available: number (float)
- quantityAvailableBase Available (Base Unit): number (float)
- quantityInTransit In Transit: number (float)
- quantityOnHand On Hand: number (float)
- quantityOnHandBase On Hand (Base Unit): number (float)
- quantityOnOrder On Order: number (float)
- refName Reference Name: string
inventoryNumberCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: inventoryNumber
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
inventoryNumber - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
inventoryStatus
This record is available as a beta record.
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- description Description: string
-
Enter a description for this item. This description will appear in the Description column of sales forms.
- externalId External ID: string
- id Internal ID: string
- internalId Internal ID: integer (int64)
- inventoryBalance: inventoryStatus-inventoryBalanceCollection
- inventoryavailable Make Inventory Available For Commitment: boolean
-
Check this box to make all on-hand inventory associated with this status available to be added to orders. Clear this box if you prefer that on-hand inventory associated with this status is excluded from the available count.
- inventoryavailforalloc Make Inventory Available For Allocation and Planning: boolean
-
To make on-hand inventory associated with this status available for Supply Allocation to allocate to orders, check the Make Inventory Available for Allocation box.
- isInactive Inactive: boolean
-
When you check this box, this item will no longer appear on a list unless you check the Show All box at the bottom of the list page.
- links Links: nsLink
-
nsLink - name Name: string
-
Enter the item name.
- refName Reference Name: string
- state: object
-
- id Internal identifier.: string A , D , I
- refName Reference Name: string
- translations: inventoryStatus-translationsCollection
inventoryStatus-inventoryBalanceCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: inventoryStatus-inventoryBalanceElement
-
inventoryStatus-inventoryBalanceElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
inventoryStatus-inventoryBalanceElement
This record is available as a beta record.
- binNumber: bin
- committedQtyPerLocation Committed Quantity (Per Location): string
- committedQtyPerSerialLotNumber Committed Quantity (Per Serial/Lot Number): string
- committedQtyPerSerialLotNumberLocation Committed Quantity (Per Serial/Lot Number & Location): string
- inventoryNumber: inventoryNumber
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- links Links: nsLink
-
nsLink - location: location
- quantityAvailable Available Quantity: string
- quantityOnHand On-Hand Quantity: string
- quantityPicked Picked Quantity: string
- refName Reference Name: string
inventoryStatus-translationsCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: inventoryStatus-translationsElement
-
inventoryStatus-translationsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
inventoryStatusChange
This record is available as a beta record.
- createdDate Date Created: string (date-time)
- externalId External ID: string
- id Internal ID: string
- inventory: inventoryStatusChange-inventoryCollection
- lastModifiedDate Date Last Modified: string (date-time)
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
-
Type a memo for this inventory status change.
- prevDate Previous Effective Date: string (date)
- previousstatus: inventoryStatus
- refName Reference Name: string
- revisedstatus: inventoryStatus
- subsidiary: subsidiary
- tranDate Date: string (date)
-
Type the date for this inventory status change. The default date is the system date.
- tranId Inventory Status Change #: string
-
This field displays the next inventory status change number, to To Be Generated by the system.
inventoryStatusChange-inventory-inventoryDetail
This record is available as a beta record.
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- externalId External ID: string
- inventoryassignment: inventoryStatusChange-inventory-inventoryDetail-inventoryassignmentCollection
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemDescription Description: string
-
A more complete Description of the item.
- links Links: nsLink
-
nsLink - location: location
- quantity Quantity: number (float)
-
In the Quantity to Build field, enter the number of assembly items you want to build. You cannot enter a quantity that exceeds the amount displayed in the Buildable Quantity field.
- refName Reference Name: string
- toLocation: location
- unit Units: string
-
If the assembly uses Units of Measure, the base units are displayed in the Units field.
inventoryStatusChange-inventory-inventoryDetail-inventoryassignmentCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: inventoryStatusChange-inventory-inventoryDetail-inventoryassignmentElement
-
inventoryStatusChange-inventory-inventoryDetail-inventoryassignmentElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
inventoryStatusChange-inventory-inventoryDetail-inventoryassignmentElement
This record is available as a beta record.
- binNumber: bin
- expirationDate Expiration Date: string (date)
- internalId Internal ID: integer (int64)
- inventoryDetail Inventory Detail: integer (int64)
- inventoryStatus: inventoryStatus
- issueInventoryNumber: inventoryNumber
- links Links: nsLink
-
nsLink - packCarton Pack Carton: string
- pickCarton Pick Carton: string
- quantity Quantity: number (float)
- quantityAvailable Unpicked Bin Qty: number (float)
- receiptInventoryNumber Serial/Lot Number: string
- refName Reference Name: string
- secondaryQuantity Secondary Quantity: number (float)
- toBinNumber: bin
- toInventoryStatus: inventoryStatus
inventoryStatusChange-inventoryCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: inventoryStatusChange-inventoryElement
-
inventoryStatusChange-inventoryElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
inventoryStatusChange-inventoryElement
This record is available as a beta record.
- description Description: string
- inventoryDetail: inventoryStatusChange-inventory-inventoryDetail
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemunits Units: string
- line: string
- links Links: nsLink
-
nsLink - onhand On Hand: number (float)
- quantity Quantity: number (float)
- refName Reference Name: string
inventoryStatusChangeCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: inventoryStatusChange
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
inventoryStatusChange - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
inventoryStatusCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: inventoryStatus
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
inventoryStatus - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
inventoryTransfer
This record is available as a beta record.
- class: classification
- createdDate Date Created: string (date-time)
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- department: department
- excludeFromGLNumbering Exclude from GL Audit Numbering: boolean
- externalId External ID: string
- id Internal ID: string
- inventory: inventoryTransfer-inventoryCollection
- lastModifiedDate Date Last Modified: string (date-time)
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
-
Enter a memo to identify this inventory transfer. When you search for transactions, you can search for specific words and phrases in the Memo field.
- postingPeriod: accountingPeriod
- prevDate Previous Effective Date: string (date)
- refName Reference Name: string
- subsidiary: subsidiary
- tranDate Date: string (date)
-
The current date autofills for this inventory transfer. You can select or enter a different date.
- tranId Ref No.: string
-
Enter a reference number to identify this inventory transfer.
- transferLocation: location
inventoryTransfer-inventory-inventoryDetail
This record is available as a beta record.
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- externalId External ID: string
- inventoryassignment: inventoryTransfer-inventory-inventoryDetail-inventoryassignmentCollection
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemDescription Description: string
-
A more complete Description of the item.
- links Links: nsLink
-
nsLink - location: location
- quantity Quantity: number (float)
-
In the Quantity to Build field, enter the number of assembly items you want to build. You cannot enter a quantity that exceeds the amount displayed in the Buildable Quantity field.
- refName Reference Name: string
- toLocation: location
- unit Units: string
-
If the assembly uses Units of Measure, the base units are displayed in the Units field.
inventoryTransfer-inventory-inventoryDetail-inventoryassignmentCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: inventoryTransfer-inventory-inventoryDetail-inventoryassignmentElement
-
inventoryTransfer-inventory-inventoryDetail-inventoryassignmentElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
inventoryTransfer-inventory-inventoryDetail-inventoryassignmentElement
This record is available as a beta record.
- binNumber: bin
- expirationDate Expiration Date: string (date)
- internalId Internal ID: integer (int64)
- inventoryDetail Inventory Detail: integer (int64)
- inventoryStatus: inventoryStatus
- issueInventoryNumber: inventoryNumber
- links Links: nsLink
-
nsLink - packCarton Pack Carton: string
- pickCarton Pick Carton: string
- quantity Quantity: number (float)
- quantityAvailable Unpicked Bin Qty: number (float)
- receiptInventoryNumber Serial/Lot Number: string
- refName Reference Name: string
- secondaryQuantity Secondary Quantity: number (float)
- toBinNumber: bin
- toInventoryStatus: inventoryStatus
inventoryTransfer-inventoryCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: inventoryTransfer-inventoryElement
-
inventoryTransfer-inventoryElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
inventoryTransfer-inventoryElement
This record is available as a beta record.
- adjustQtyBy Qty to Transfer: number (float)
- description Description: string
- inventoryDetail: inventoryTransfer-inventory-inventoryDetail
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- line Line: string
- links Links: nsLink
-
nsLink - quantityOnHand Current Qty On Hand: number (float)
- refName Reference Name: string
- unitconversionrate: number (float)
- units Units: string
inventoryTransferCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: inventoryTransfer
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
inventoryTransfer - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
invoice
- account: account
- accountingBookDetail: invoice-accountingBookDetailCollection
- altHandlingCost Handling Cost: number (double)
-
The handling cost automatically calculates depending on the shipping method you select in the Ship Via field. To change the cost of handling, go to Lists > Shipping Items and select the shipping method with the handling cost you want to change.
- altShippingCost Shipping Cost: number (double)
-
The shipping cost automatically calculates depending on the shipping method you select in the Ship Via field above. To change the cost of a shipping method, go to Lists > Shipping Items and select the shipping method you want to change. If you use UPS Real-Time rates, shipments over 150lbs are broken up into shipments less than or equal to 150lbs for charging.
- amountPaid Amount Paid: number (double)
-
Displays the total amount paid for this invoice.
- amountRemaining Amount Remaining: number (double)
-
Displays the total amount due for this invoice.
- amountRemainingTotalBox Amount Remaining: number (double)
-
The total unpaid amount on this invoice is shown here.
- appliedRules: invoice-appliedRulesCollection
- approvalStatus: object
-
- id Internal identifier.: string 11 , 1 , 2 , 3
- refName Reference Name: string
- asOfDate As of Date: string (date)
-
The As-of Date field determines the list of charges added to the transaction, but it does not impact the general ledger or the invoice due date. For example, you may have an as-of date that is after the invoice date when you want to capture charges that will post after the invoice date.
- billAddr1 Billing Address Line 1: string
- billAddr2 Billing Address Line 2: string
- billAddr3 Billing Address Line 3: string
- billAddress Bill To: string
-
The default billing address autofills this field from the customer's record. To enter a different address: * Select another address in the Bill To Select field. * Select New in the Bill To Select field to enter a new billing address to be used for this transaction and saved with the associated entity record. * Select Custom in the Bill To Select field to enter a new billing address to be used for this transaction only (and not saved with the associated entity record). * Click the Edit icon for the Bill To Select field to modify an existing billing address.
- billAddressList: nsResource
- billAddressee Billing Addressee: string
- billAttention Billing Attention: string
- billCity Billing Address City: string
- billCountry: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- billOverride Override: string
- billPhone Billing Phone: string
- billState Billing Address State: string
- billZip Billing Address Zip Code: string
- billingAccount: billingAccount
- billingAddress: invoice-billingAddress
- billingAddress_text Billing Address: string
- bulkProcSubmission: nsResource
- class: classification
- contribPct Contribution Percentage: string
- createdDate Date Created: string (date-time)
- createdFrom: nsResource
- currency: currency
- customForm: object
-
- id Internal identifier.: string -9907 , -9908 , -9909 , -9910 , -9901 , -9913 , -9931
- refName Reference Name: string
- defaultILBAShipAddrVal: string
- defaultILBAShippingAddressKey: string
- defaultILShipMethKey Default Shipping Method Key: integer (int64)
- deferredRevenue Deferred Revenue: number (double)
-
Deferred Revenue: amount of revenue deferred on this transaction
- department: department
- discountAmount Discount Amount: number (double)
-
The amount listed here is the discount your customer will receive if he or she pays this invoice according to the terms you have set.
- discountDate Discount Date: string (date)
-
The date listed here is the date your customer must pay this invoice by in order to receive a discount. The discount your customer receives in based on the terms you have set for the customer.
- dueDate Due Date: string (date)
-
Type or pick the due date for this invoice. If you do not assign a due date, the due date defaults to the date in the Date field. In addition, if you do not assign a due date, this invoice will appear on aging reports.
- email Email: string
- endDate End Date: string (date)
-
Type or pick the end date for this invoice. If an invoice is created from a sales order that includes a Start Date and End Date, those dates autofill on the invoice when the order is billed.
- entity: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- entityTaxRegNum Customer Tax Reg. Number: string
- estGrossProfit Est. Gross Profit: number (double)
-
Estimated Gross Profit: Read-only field that equals the revenue amount minus the Est. Cost. At the transaction level, it equals the gross profit of all lines, factoring transaction-level discounts and markups.
- estGrossProfitPercent Est. Gross Profit Percent: number (double)
-
Estimated Gross Profit Margin, as a percentage: Read-only field that equals the Est. Gross Profit divided by revenue, expressed as a percentage. At the transaction level, it equals the gross profit percent of all lines, factoring transaction-level discounts and markups.
- estimate Estimate: integer (int64)
- exchangeRate Exchange Rate: number (double)
-
The currency's exchange rate is shown in this field. You can edit the exchange rate for this transaction only, or you can update the currency record with the exchange rate you enter here.
- excludeCommission Exclude Commissions: boolean
-
Check this option to exclude this transaction and its subordinate transactions from inclusion in all commission calculations.
- excludeFromGLNumbering Exclude from GL Audit Numbering: boolean
- expCost: invoice-expCostCollection
- externalId External ID: string
- fob FOB: string
-
Enter the location where the customers technically acquire ownership. For example, if your customers own goods as soon as they ship and pay the shipping costs from your location to theirs, you might enter Our warehouse.
- forInvoiceGrouping For Invoice Grouping: boolean
- giftCertApplied Gift Certificate: number (double)
- giftCertRedemption: invoice-giftCertRedemptionCollection
- groupedTo: nsResource
- handlingCost Handling Cost: number (double)
-
The handling cost automatically calculates depending on the shipping method you select in the Ship Via field. To change the cost of handling, go to Lists > Accounting > Shipping Items and select the shipping method with the handling cost you want to change.
- handlingTaxAmount Handling Tax Amount: number (double)
-
This field displays the handling tax amount for this invoice.
- id Internal ID: string
- installment: invoice-installmentCollection
- intercoStatus: object
-
- id Internal identifier.: string 1 , 2 , 3
- refName Reference Name: string
- intercoTransaction: nsResource
- isMultiShipTo Enable Item Line Shipping: boolean
-
Check this box to enable line-item shipping. For example, you may have line items that cannot be shipped together.
- item: invoice-itemCollection
- itemCost: invoice-itemCostCollection
- job: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- lastModifiedDate Date Last Modified: string (date-time)
- leadSource: nsResource
- linkedTrackingNumbers Linked Tracking Numbers: string
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
-
Enter an optional memo to describe this invoice so you can easily distinguish it from others for this customer. For example: Suite A installation or Suite B installation. It will appear on reports such as the 2-line Accounts Receivable register, which your customers can see if you give them permission to log in and view their transaction history.
- message Customer Message: string
-
The text of the customer message you select in the Select Message field appears here. You can edit the message or enter a new customer message for only this transaction.
- messageSel: customerMessage
- nextApprover: employee
- nexus: nexus
- oppcreatedfrom: string
- oppcreatedfromtitle: string
- opportunity: opportunity
- originator Originator: string
- otherRefNum PO/Check Number: string
-
To make it easy for your customers to locate this invoice in their own records, enter their purchase order number here.
- overrideInstallments Override: boolean
- partner: partner
- partners: invoice-partnersCollection
- paymentlink Payment Link: string
- postingPeriod: accountingPeriod
- prevDate Previous Effective Date: string (date)
- prevPartner Previous Partner: integer (int64)
- prevRep Previous Representative: integer (int64)
- previousOpportunity Previous Opportunity: string
- recognizedRevenue Recognized Revenue: number (double)
-
Recognized Revenue: cumulative amount of revenue recognized for this transaction
- recurringBill Recurring Bill: boolean
- refName Reference Name: string
- revCommitStatus Revenue Commitment Status: string
- revCommitStatusDescr Revenue Commitment Status: string
- revRecOnRevCommitment Rev Rec on Rev Commit.: boolean
-
Check this check box to create a Revenue Commitment or Revenue Commitment Reversal. * On a Sales Order, the Revenue Commitment replaces an invoice * On a Return Authorization, the Revenue Commitment Reversal replaces a credit memo. NetSuite creates all applicable Revenue Recognition schedules the Revenue Commitment or Revenue Commitment Reversal.
- revenueStatus Revenue Status: string
-
The possible values for this field are: 1. Pending: indicates that no recognition has occurred. All revenue is still deferred. 2. In Progress: indicates that some recognition has occurred. 3. Completed: indicates that all recognition has occurred. No deferred revenue remains.
- revenueStatusDescr Revenue Status: string
- salesChannel: salesChannel
- salesEffectiveDate Sales Effective Date: string (date)
-
You can change the sales effective date for this transaction. The sales effective date determines which commission plan and historical sales team this transaction applies to.
- salesRep: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- salesTeam: invoice-salesTeamCollection
- saleschannelorderpriority: string
- sendOrderFulfillmentEmail Resend Order Fulfillment Email: boolean
- shipAddress Ship To: string
-
The default shipping address autofills this field from the customer's record. To enter a different address: * Select another address in the Ship To Select field. * Select New in the Ship To Select field to enter a new shipping address to be used for this transaction and saved with the associated entity record. * Select Custom in the Ship To Select field to enter a new shipping address to be used for this transaction only (and not saved with the associated entity record). * Click the Edit icon for the Ship To Select field to edit an existing shipping address.
- shipAddressList: nsResource
- shipDate Ship Date: string (date)
-
Type or pick a shipping date for this invoice.
- shipGroup: invoice-shipGroupCollection
- shipIsResidential Shipping address is residential: boolean
- shipMethod: shipItem
- shipOverride Override: boolean
- shippingAddress: invoice-shippingAddress
- shippingAddress_text Shipping Address: string
- shippingCost Shipping Cost: number (double)
-
The shipping cost automatically calculates depending on the shipping method you select in the Ship Via field above. To change the cost of a shipping method, go to Lists > Accounting > Shipping Items and select the shipping method you want to change. If you use UPS Real-Time rates, shipments over 150lbs are broken up into shipments less than or equal to 150lbs for charging.
- shippingCostOverridden Shipping Cost Overridden: boolean
- shippingTaxAmount Shipping Tax Amount: number (double)
- source: object
-
- sourceWebSite: webSite
- startDate Start Date: string (date)
-
If you use the Advanced Billing feature, enter the date for the first invoice to be created. If an invoice is created from a sales order that includes a Start Date and End Date, those dates autofill on the invoice when the order is billed.
- status: object
-
- id Internal identifier.: string A , B , D , E , V
- refName Reference Name: string
- storeOrder: string
- subsidiary: subsidiary
- subsidiaryTaxRegNum Subsidiary Tax Reg. Number: string
-
This field shows the tax registration number of the transaction nexus. NetSuite automatically populates this field based on the nexus lookup logic. You can override the transaction nexus and tax registration number that NetSuite automatically selects by checking the Nexus Override box. When you select a different tax registration number in the dropdown list, the corresponding nexus is automatically selected in the Nexus field.
- subtotal Subtotal: number (double)
-
This field shows the total of the items on this invoice. This is the total before any discounts, shipping cost, handling cost or tax is added to the order.
- taxDetails: invoice-taxDetailsCollection
- taxDetailsOverride Tax Details Override: boolean
-
Check this box to override the tax information on the Tax Details subtab of the transaction. Only roles with at least the Edit level of the Tax Details Tab permission can override the tax details.
- taxPointDate Tax Point Date: string (date)
- taxPointDateOverride Tax Point Date Override: boolean
- taxRegOverride Tax Registration Override: boolean
-
Check this box to override the values in the Nexus and Subsidiary Tax Reg. Number fields. Only roles with at least the Edit level of the Tax Details Tab permission can override the values that NetSuite automatically selects in these fields.
- taxTotal Tax: number (double)
-
NetSuite multiplies the tax rate by the taxable total of line items and enters it here.
- terms: term
- thirdPartyAcct 3rd Party Account: string
- time: invoice-timeCollection
- toBeEmailed To Be Emailed: boolean
-
When processing individual invoices: * Check the To Be Emailed box if you want to email this invoice. Then enter the email address in the space to the right of the check box. * You can enter multiple email addresses by separating them with a semicolon. It is important to separate the addresses with only a semicolon, and do not include any spaces. When bulk processing invoices: In the To Be Emailed field: * Select Yes if you want to email this form. * Select No if you do not want to email this form. * Select Respect Customer Preference to send the form based on the default preference on the customer record. Set the preference on the Info subtab of a customer record in the Send Transactions Via field.
- toBeFaxed To Be Faxed: boolean
-
When processing individual invoices: * Check the To Be Faxed box if you want to fax this invoice. Then enter the fax number in the box to the right of the check box if it does not already appear. When bulk processing invoices: In the To Be Faxed field: * Select Yes if you want to fax this form. * Select No if you do not want to fax this form. * Select Respect Customer Preference to send the form based on the default preference on the customer record. Set the preference on the Info subtab of a customer record in the Send Transactions Via field. To fax NetSuite forms, an administrator must first set up fax service at Setup > Company > Printing, Fax and Email Preferences.
- toBePrinted To Be Printed: boolean
-
When processing individual invoices: Check the To Be Printed box if you want to print this invoice. When bulk processing invoices: * Select Yes if you want to save this in a queue of invoices to print. * Select No if you do not want to print this form. * Select Respect Customer Preference to send the form based on the default preference on the customer record. Set the preference on the Info subtab of a customer record in the Send Transactions Via field.
- total Total: number (double)
-
NetSuite computes the total of line items, tax and shipping costs, and then enters it here.
- totalAfterTaxes Total After Taxes: number (double)
- totalCostEstimate Est. Cost: number (double)
-
Estimated Cost: Estimated cost of the specific number of items; estimated rate x quantity = estimated cost.
- trackingNumbers Tracking Numbers: string
-
Enter the shipment tracking number from the shipping company. If a tracking number is entered in the exact format used by UPS or FedEx and the transaction is saved, the tracking number will show on the transaction as a link to the UPS or FedEx website. You can click the link to check the status of the shipment.
- tranDate Date: string (date)
-
NetSuite inserts today's date for the posting date of this invoice. You can type or pick another date. What you enter here determines the date range in which this transaction appears on the Accounts Receivable Register. You can select or enter custom date ranges on registers.
- tranId Invoice #: string
-
NetSuite increases the largest invoice number by one. You can type another number. The next invoice number will revert to the standard pattern.
- tranIsVsoeBundle Transaction Is VSOE Bundle: boolean
-
Check this box to include all items added to this transaction as a VSOE bundle.
- vsoeAutoCalc Auto Calculate VSOE Allocation: boolean
-
The VSOE allocation amount for a sale can be calculated automatically by checking the Auto Calculate VSOE Allocation box. Allocation is the process to determine the VSOE price for items on a sale. The total VSOE amount allocated is the revenue amount to be recognized for the bundle.
- webSite: string
- whichChargesToAdd: object
-
- id Internal identifier.: string , ALL , TRANSACTION_DATE , AS_OF_DATE
- refName Reference Name: string
invoice-accountingBookDetailCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: invoice-accountingBookDetailElement
-
invoice-accountingBookDetailElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
invoice-accountingBookDetailElement
- accountingBook: accountingBook
- exchangeRate Exchange Rate: number (double)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- revRecOnRevCommitment Rev Rec on Rev Commit.: boolean
- subsidiary: subsidiary
- tranIsVsoeBundle Transaction Is VSOE Bundle: boolean
invoice-appliedRulesCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: invoice-appliedRulesElement
-
invoice-appliedRulesElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
invoice-billingAddress
- addr1 Address 1: string
-
Enter the address the way it should appear on forms. For employees, customers, partners, and vendors, what you enter here autofills on forms if this address is marked default for Shipping or Billing. Enter up to 50 characters. This field is required for the Online Bill Pay feature.
- addr2 Address 2: string
-
Enter an optional second address line the way it should appear on forms. For employees, customers, partners, and vendors, what you enter here autofills on forms if this address is marked default for Shipping or Billing. Enter up to 50 characters.
- addr3 Address 3: string
- addrPhone Phone: string
-
Enter the phone number.
- addrText Address: string
-
The values entered in the other address fields are displayed here.
- addressee Addressee: string
-
Enter the name of the entity that should appear on the shipping label here. This name appears on the shipping label below what you enter in the Attention field.
- attention Attention: string
-
Enter the name of the person to whom a shipment is addressed, as it should appear on shipping labels. This field is required for UPS Integration.
- city City: string
-
Enter the city the way it should appear on all forms except checks.
- country: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- externalId External ID: string
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - override Override: boolean
-
Check this box to disable the free-form address text field. When this field is disabled, text entered in the other address fields does not display in the Address text field. Clear this box to allow text entered in the address component fields to appear in the free-form address text field.
- refName Reference Name: string
- state State/Province: string
-
Enter your company's state or province the way it should appear on all forms except checks.
- zip Zip: string
-
Enter the postal code the way it should appear on all forms except checks.
invoice-expCostCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: invoice-expCostElement
-
invoice-expCostElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
invoice-expCostElement
- amortizationperiod Amortization Period: string
- amortizationtype Amortization Type: string
- amount Bill Amount: number (double)
- apply Apply: boolean
- billedDate Date: string (date)
- category: expenseCategory
- class: classification
- department: department
- doc: nsResource
- employee: employee
- job: string
- jobDisp Project: string
- line Line: integer (int64)
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
- originalAmount Original Amount: number (double)
- prevRevRecSched: boolean
- prevRevRecTemp: boolean
- processedByRevCommit Processed by Rev Commit: boolean
- refName Reference Name: string
- revRecDefRevAcct Deferred Revenue Account: integer (int64)
- taxAmount Tax Amount: number (double)
- taxDetailsReference Tax Details Reference: string
- url URL: string
invoice-giftCertRedemptionCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: invoice-giftCertRedemptionElement
-
invoice-giftCertRedemptionElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
invoice-giftCertRedemptionElement
- authCode: giftCertificate
- authCodeApplied Amount Applied: number (double)
- links Links: nsLink
-
nsLink - refName Reference Name: string
invoice-installmentCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: invoice-installmentElement
-
invoice-installmentElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
invoice-item-inventoryDetail
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- externalId External ID: string
- inventoryassignment: invoice-item-inventoryDetail-inventoryassignmentCollection
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemDescription Description: string
-
A more complete Description of the item.
- links Links: nsLink
-
nsLink - location: location
- quantity Quantity: number (float)
-
In the Quantity to Build field, enter the number of assembly items you want to build. You cannot enter a quantity that exceeds the amount displayed in the Buildable Quantity field.
- refName Reference Name: string
- toLocation: location
- unit Units: string
-
If the assembly uses Units of Measure, the base units are displayed in the Units field.
invoice-item-inventoryDetail-inventoryassignmentCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: invoice-item-inventoryDetail-inventoryassignmentElement
-
invoice-item-inventoryDetail-inventoryassignmentElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
invoice-item-inventoryDetail-inventoryassignmentElement
- binNumber: bin
- expirationDate Expiration Date: string (date)
- internalId Internal ID: integer (int64)
- inventoryDetail Inventory Detail: integer (int64)
- inventoryStatus: inventoryStatus
- issueInventoryNumber: inventoryNumber
- links Links: nsLink
-
nsLink - packCarton Pack Carton: string
- pickCarton Pick Carton: string
- quantity Quantity: number (float)
- quantityAvailable Unpicked Bin Qty: number (float)
- receiptInventoryNumber Serial/Lot Number: string
- refName Reference Name: string
- secondaryQuantity Secondary Quantity: number (float)
- toBinNumber: bin
- toInventoryStatus: inventoryStatus
invoice-itemCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: invoice-itemElement
-
invoice-itemElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
invoice-itemCost-inventoryDetail
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- externalId External ID: string
- inventoryassignment: invoice-itemCost-inventoryDetail-inventoryassignmentCollection
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemDescription Description: string
-
A more complete Description of the item.
- links Links: nsLink
-
nsLink - location: location
- quantity Quantity: number (float)
-
In the Quantity to Build field, enter the number of assembly items you want to build. You cannot enter a quantity that exceeds the amount displayed in the Buildable Quantity field.
- refName Reference Name: string
- toLocation: location
- unit Units: string
-
If the assembly uses Units of Measure, the base units are displayed in the Units field.
invoice-itemCost-inventoryDetail-inventoryassignmentCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: invoice-itemCost-inventoryDetail-inventoryassignmentElement
-
invoice-itemCost-inventoryDetail-inventoryassignmentElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
invoice-itemCost-inventoryDetail-inventoryassignmentElement
- binNumber: bin
- expirationDate Expiration Date: string (date)
- internalId Internal ID: integer (int64)
- inventoryDetail Inventory Detail: integer (int64)
- inventoryStatus: inventoryStatus
- issueInventoryNumber: inventoryNumber
- links Links: nsLink
-
nsLink - packCarton Pack Carton: string
- pickCarton Pick Carton: string
- quantity Quantity: number (float)
- quantityAvailable Unpicked Bin Qty: number (float)
- receiptInventoryNumber Serial/Lot Number: string
- refName Reference Name: string
- secondaryQuantity Secondary Quantity: number (float)
- toBinNumber: bin
- toInventoryStatus: inventoryStatus
invoice-itemCostCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: invoice-itemCostElement
-
invoice-itemCostElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
invoice-itemCostElement
- amortizationperiod Amortization Period: string
- amortizationtype Amortization Type: string
- amount Total: number (double)
- apply Apply: boolean
- billedDate Date: string (date)
- binNumbers Bin Numbers: string
- class: classification
- cost Rate: number (double)
- department: department
- doc: nsResource
- inventoryDetail: invoice-itemCost-inventoryDetail
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemCostCount Qty: string
- job: string
- jobDisp Project: string
- line Line: integer (int64)
- links Links: nsLink
-
nsLink - location: location
- memo Description: string
- options Options: string
- prevRevRecSched: boolean
- prevRevRecTemp: boolean
- processedByRevCommit Processed by Rev Commit: boolean
- rateSchedule Rate Schedule: string
- refName Reference Name: string
- revRecDefRevAcct Deferred Revenue Account: integer (int64)
- serialNumbers Serial/Lot Numbers: string
- taxAmount Tax Amount: number (double)
- taxDetailsReference Tax Details Reference: string
- unit Unit: string
- unitDisp Units: string
- url URL: string
invoice-itemElement
- account: account
- amount Amount: number (double)
- billVarianceStatus: object
-
- id Internal identifier.: string NOVARIANCES , JOURNALNOTPOSTED , JOURNALPOSTED
- refName Reference Name: string
- catchUpPeriod: accountingPeriod
- chargeType: nsResource
- class: classification
- costEstimate Est. Cost: number (double)
- costEstimateRate Est. Rate: number (double)
- costEstimateType: object
-
- id Internal identifier.: string PREFVENDORRATE , AVGCOST , PURCHORDERRATE , LASTPURCHPRICE , MEMBERDEFINED , CUSTOM , ITEMDEFINED , PURCHPRICE
- refName Reference Name: string
- deferRevRec Deferred Revenue: boolean
- department: department
- description Description: string
- doNotCreateRevenueElement Do Not Create Revenue Element: boolean
- estGrossProfit Est. Gross Profit: number (double)
- estGrossProfitPercent Est. Gross Profit Percent: number (double)
- excludeFromRateRequest Exclude Item from Rate Request: boolean
- giftCertFrom From: string
- giftCertMessage Gift Message: string
- giftCertNumber Code: string
- giftCertRecipientEmail Recipient Email: string
- giftCertRecipientName Recipient Name: string
- initOqpBucket Initial OQP Bucket: string
- inventoryDetail: invoice-item-inventoryDetail
- isCatchWeightItem: boolean
- isClosed Closed: boolean
- isOpen Is Opened: boolean
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemFulfillmentChoice: object
-
- id Internal identifier.: string 1 , 2
- refName Reference Name: string
- itemSubtype: object
-
- id Internal identifier.: string Sale , Purchase , Resale
- refName Reference Name: string
- itemType: object
-
- job: job
- licenseCode License Code: string
- line Transaction Line: integer (int64)
- linked Linked: boolean
- links Links: nsLink
-
nsLink - location: location
- marginal Marginal: boolean
- matrixType Matrix Type: string
- minQty Minimum Quantity: number (float)
- options Options: string
- oqpBucket Oqp Bucket: string
- orderDoc: nsResource
- orderLine Order Line: integer (int64)
- price: priceLevel
- primaryToSecondaryUnitConversionRate: number (float)
- printItems Print Items: boolean
- processedByRevCommit Processed by Rev Commit: boolean
- quantity Quantity: number (float)
- quantityAllocated Quantity Allocated: number (float)
- quantityAvailable Available: number (float)
- quantityCommitted Committed: number (float)
- quantityDemandAllocated Allocated Demand: number (float)
- quantityOnHand On Hand: number (float)
- rate Rate: number (double)
- rateIncludingTax Rate: number (double)
- rateSchedule Rate Schedule: string
- refName Reference Name: string
- revRecEndDate Rev. Rec. End Date: string (date)
- revRecSchedule: revRecSchedule
- revRecStartDate Rev. Rec. Start Date: string (date)
- revrec_recurrencetype Rev Rec Recurrence Type: string
- secondaryQuantity Secondary Quantity: number (float)
- secondaryUnitConversionRate: number (float)
- secondaryUnits Secondary Units: string
- secondaryUnitsList: string
- shipAddress: nsResource
- shipCarrier: object
-
- id Internal identifier.: string ups , nonups
- refName Reference Name: string
- shipMethod: shipItem
- subscription: subscription
- subscriptionLine: subscriptionLine
- subsidiary: subsidiary
- taxAmount Tax Amount: number (double)
- taxDetailsReference Tax Details Reference: string
- units Units: string
- vsoeAllocation Allocation Amount: number (double)
- vsoeAmount Calculated Amount: number (double)
- vsoeDeferral: object
-
- id Internal identifier.: string DEFERALLUNTIL , DEFERUNTIL
- refName Reference Name: string
- vsoeDelivered Delivered: boolean
- vsoeIsEstimate Estimate: boolean
- vsoePermitDiscount: object
-
- id Internal identifier.: string IFDELIVERED , NEVER
- refName Reference Name: string
- vsoePrice Allocation Price: number (double)
- vsoeSOPGroup: object
-
- id Internal identifier.: string EXCLUDE , NORMAL , SOFTWARE
- refName Reference Name: string
invoice-partnersCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: invoice-partnersElement
-
invoice-partnersElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
invoice-partnersElement
- contribution Contribution %: number (double)
- isPrimary Primary: boolean
- links Links: nsLink
-
nsLink - partner: partner
- partnerRole: partnerCategory
- refName Reference Name: string
invoice-salesTeamCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: invoice-salesTeamElement
-
invoice-salesTeamElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
invoice-shipGroupCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: invoice-shipGroupElement
-
invoice-shipGroupElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
invoice-shipGroupElement
- destinationAddress Ship To: string
- handlingRate Handling Rate: number (double)
- id ID: integer (int64)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- shippingMethod Ship Via: string
- shippingRate Shipping Rate: number (double)
- sourceAddress Ship From: string
- uniqueKey Unique Key: integer (int64)
- weight Weight: number (float)
invoice-shippingAddress
- addr1 Address 1: string
-
Enter the address the way it should appear on forms. For employees, customers, partners, and vendors, what you enter here autofills on forms if this address is marked default for Shipping or Billing. Enter up to 50 characters. This field is required for the Online Bill Pay feature.
- addr2 Address 2: string
-
Enter an optional second address line the way it should appear on forms. For employees, customers, partners, and vendors, what you enter here autofills on forms if this address is marked default for Shipping or Billing. Enter up to 50 characters.
- addr3 Address 3: string
- addrPhone Phone: string
-
Enter the phone number.
- addrText Address: string
-
The values entered in the other address fields are displayed here.
- addressee Addressee: string
-
Enter the name of the entity that should appear on the shipping label here. This name appears on the shipping label below what you enter in the Attention field.
- attention Attention: string
-
Enter the name of the person to whom a shipment is addressed, as it should appear on shipping labels. This field is required for UPS Integration.
- city City: string
-
Enter the city the way it should appear on all forms except checks.
- country: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- externalId External ID: string
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - override Override: boolean
-
Check this box to disable the free-form address text field. When this field is disabled, text entered in the other address fields does not display in the Address text field. Clear this box to allow text entered in the address component fields to appear in the free-form address text field.
- refName Reference Name: string
- state State/Province: string
-
Enter your company's state or province the way it should appear on all forms except checks.
- zip Zip: string
-
Enter the postal code the way it should appear on all forms except checks.
invoice-taxDetailsCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: invoice-taxDetailsElement
-
invoice-taxDetailsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
invoice-taxDetailsElement
- calcDetail Details: string
- lineName Name: string
- lineType Line type: string
- links Links: nsLink
-
nsLink - netAmount Net Amount: number (double)
- refName Reference Name: string
- taxAmount Tax Amount: number (double)
- taxBasis Tax Basis: number (double)
- taxCode: salesTaxItem
- taxDetailsReference: object
-
- id Internal identifier.: string
- refName Reference Name: string
- taxRate Tax Rate: number (double)
- taxType Tax Type: string
invoice-timeCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: invoice-timeElement
-
invoice-timeElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
invoice-timeElement
- amortizationperiod Amortization Period: string
- amortizationtype Amortization Type: string
- amount Amount: number (double)
- apply Apply: boolean
- billedDate Date: string (date)
- class: classification
- department: department
- doc: timeBill
- employee: employee
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- job: string
- jobDisp Project: string
- links Links: nsLink
-
nsLink - location: location
- memo Description: string
- prevRevRecSched: boolean
- prevRevRecTemp: boolean
- processedByRevCommit Processed by Rev Commit: boolean
- rate Rate: number (double)
- rateSchedule Rate Schedule: string
- refName Reference Name: string
- revRecDefRevAcct Deferred Revenue Account: integer (int64)
- taxAmount Tax Amount: number (double)
- taxDetailsReference Tax Details Reference: string
- unit Unit: string
- url URL: string
invoiceCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: invoice
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
invoice - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
issue
This record is available as a beta record.
- assigned: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- autoName Auto: boolean
- bFixed: boolean
- brokenInVersion: issue-brokenInVersionCollection
- brokenMandatory: string
- buildBroken Broken In Build: string
-
Select the build for the version where this issue occurred.
- buildFixed Fixed In Build: string
-
Select the build for the version where this issue was fixed.
- buildTarget Target Build: string
-
Select the build for the version in which this issue is scheduled to be fixed.
- createdDate Created: string (date-time)
-
This field displays the date when this issue was originally created.
- customForm: object
-
- id Internal identifier.: string -10161 , -160 , -10160
- refName Reference Name: string
- dateReleased Date Released: string
- duplicateStatus: string
- emailAssignee Email Assignee: boolean
-
Check this box to email the person this issue is assigned to. You may want to email the assignee any time an important comment is added or whenever a change is made to the issue record.
- externalAbstract External Abstract: string
-
Enter an abstract for this issue that customers should see when they log in to the NetSuite Support Center.
- externalDetails External Details: string
-
Enter a summary of the details for this issue that customers should see when they log in to the NetSuite Support Center.
- externalId External ID: string
- fixedInVersion: issue-fixedInVersionCollection
- fixedMandatory: string
- id Internal ID: string
- isOwner I Own This Issue: boolean
-
Check this box if you want this issue assigned to you every time it comes back to your team. You cannot check this box if this issue is assigned to someone else with your type of role. To own the issue, either assign the issue to yourself or change the issue status to a status associated with another role type. Only one person per role type can own an issue.
- isReviewed Reviewed: boolean
-
Check this box if the work done to resolve this issue has been reviewed.
- isShowstopper Showstopper: boolean
-
This field displays whether or not this issue is a showstopper. Showstopper issues must be fixed before the next version can be released.
- issueAbstract Abstract: string
-
Enter a short summary of the issue. This abstract is only available to internal users and is only seen by customers if you do not enter an external abstract on the External subtab.
- issueCases: supportCaseCollection
- issueNumber ID: string
-
Enter a number for this issue. If you use Auto-Generated Numbering, this number is automatically generated to avoid duplicate numbers and ensure consecutive numbering.
- issueStatus: nsResource
- issueTags: nsResourceCollection
- issueType: nsResource
- issueVersion Issue version: integer (int64)
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- lastModifiedDate Modification Date: string (date-time)
- links Links: nsLink
-
nsLink - mediaItem: nsResourceCollection
- module Module: string
-
Select the module of the product selected that is affected by this issue.
- newDetails New Details: string
-
Enter any new information or communication about this issue.
- origissueNumber: string
- priority: nsResource
- product: issueProduct
- productTeam: nsResource
- refName Reference Name: string
- relatedIssues: issue-relatedIssuesCollection
- reportedBy: employee
- reproduce: nsResource
- reviewer: employee
- severity: nsResource
- source: nsResource
- statusType: string
- targetMandatory: string
- targetVersion: issue-targetVersionCollection
- trackCode: nsResource
- tracking Tracking: boolean
- versionBroken Broken In Version: string
-
Select the product version where this issue occurred. Versions are created and maintained from product records.
- versionFixed Fixed In Version: string
-
Select the version of the release when the issue should be resolved.
- versionTarget Target Version: string
-
Select the product version in which this issue is scheduled to be fixed. Versions are created and maintained from product records.
issue-brokenInVersionCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: issue-brokenInVersionElement
-
issue-brokenInVersionElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
issue-fixedInVersionCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: issue-fixedInVersionElement
-
issue-fixedInVersionElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
issue-targetVersionCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: issue-targetVersionElement
-
issue-targetVersionElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
issueCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: issue
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
issue - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
issueProduct
This record is available as a beta record.
- id Internal ID: string
- isInactive Inactive: boolean
-
Check this box to mark this issue role inactive.
- issuemodule: issueProduct-issuemoduleCollection
- issueproduct Product: string
-
This field displays the product record this version is associated with.
- issueproductdescription Description: string
-
Type a description for this product issue.
- items: one of: [ inventoryItemCollection, assemblyItemCollection, kitItemCollection, nsResourceCollection, discountItemCollection, markupItemCollection, subtotalItemCollection, descriptionItemCollection, paymentItemCollection, salesTaxItemCollection, taxGroupCollection, shipItemCollection, downloadItemCollection, giftCertificateItemCollection, subscriptionPlanCollection, nonInventorySaleItemCollection, nonInventoryResaleItemCollection, nonInventoryPurchaseItemCollection, serviceSaleItemCollection, serviceResaleItemCollection, servicePurchaseItemCollection, otherChargeSaleItemCollection, otherChargeResaleItemCollection, otherChargePurchaseItemCollection ]
- links Links: nsLink
-
nsLink - refName Reference Name: string
- showinactiveversions Show Inactives: boolean
-
Check this box to show versions that have been inactivated with an Inactive column. You can clear the box in the Inactive column to reactivate the version.
- versions: issueProduct-versionsCollection
issueProduct-issuemoduleCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: issueProduct-issuemoduleElement
-
issueProduct-issuemoduleElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
issueProduct-versions-availablebuildCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: issueProduct-versions-availablebuildElement
-
issueProduct-versions-availablebuildElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
issueProduct-versions-availablebuildElement
This record is available as a beta record.
- allowbrokenin Allow Broken In: boolean
- allowfixedin Allow Fixed In: boolean
- allowtarget Allow Target: boolean
- build Build: string
- builtdate Build Date: string (date)
- description Description: string
- id Internal ID: integer (int64)
- isInactive Inactive: boolean
- links Links: nsLink
-
nsLink - productversion Product Version: string
- refName Reference Name: string
issueProduct-versionsCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: issueProduct-versionsElement
-
issueProduct-versionsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
issueProduct-versionsElement
This record is available as a beta record.
- allowbrokenin Allow Broken In: boolean
- allowfixedin Allow Fixed In: boolean
- allowtarget Allow Target: boolean
- availablebuild: issueProduct-versions-availablebuildCollection
- expectedreleasedate Expected Release Date: string (date)
- externalreleasetarget External Target: string
- id Internal ID: integer (int64)
- isInactive Inactive: boolean
- isefix E-fix: boolean
- issueversiondescription Description: string
- links Links: nsLink
-
nsLink - portletdescription Portlet Description: string
- productversion Product Version: string
- refName Reference Name: string
- showinportlet Show In Portlet: boolean
issueProductCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: issueProduct
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
issueProduct - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
itemAccountMapping
This record is available as a beta record.
- accountingBook: accountingBook
- class: classification
- classDisplayValue Class: string
- customField Custom Field: string
- customFieldCompId Custom Field CompId: string
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- department: department
- departmentDisplayValue Department: string
- destinationAccount: account
- effectiveDate Effective Date: string (date)
-
Enter or select the date that the account mapping begins.
- endDate End Date: string (date)
- externalId External ID: string
- id Internal ID: string
- itemAccount: object
-
- id Internal identifier.: string CUSTOMERRETURNVARIANCE , SCRAP , ACCOUNTSRECEIVABLE , PAYMENT , VENDORBILLQUANTITYVARIANCE , FXADJUSTMENTREVENUE , COGS , UNBUILDVARIANCE , PRODUCTIONQUANTITYVARIANCE , INTERCOCOGS , INTERCODEFERREDREVENUE , GAINLOSS , PRODUCTIONPRICEVARIANCE , PURCHASEPRICEVARIANCE , INCOME , INTERCOEXPENSE , DEFERREDREVENUE , DROPSHIPEXPENSE , WIPVARIANCE , DEFERREDREVENUERECLASS , INTERCOINCOME , WRITEOFF , DEFERRAL , LIABILITY , ASSET , VENDORRETURNVARIANCE , DISCOUNT , VENDORBILLPRICEVARIANCE , VENDORBILLEXCHRATEVARIANCE , MARKUP , EXPENSE , ACCOUNTSPAYABLE , WIP
- refName Reference Name: string
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - location: location
- locationDisplayValue Location: string
- refName Reference Name: string
- sourceAccount: account
- subsidiary: subsidiary
itemAccountMappingCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: itemAccountMapping
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
itemAccountMapping - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
itemDemandPlan
This record is available as a beta record.
- alternateSourceItem Alternate Source Item: string
-
The Alternate Source Item field enables you to choose a different item to use that item's historical data to calculate demand.
- analysisDuration Historical Analysis Duration: integer (int64)
-
In the Historical Analysis Duration field, enter the number of periods in the past to calculate demand projection: * Moving Average - enter the number of periods in the past to calculate the next moving average value. * Linear Regression - enter the number of periods in the past to determine the linear regression projection. * Seasonal Average - enter the number of periods in the past to calculate the buckets in the future.
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- demandplancalendartype View: string
-
You can alter your view of the demand plan by changing the date range or the plan view, as described below: * Year – Enter the year to view. * Month – Select a month to view * Start Date – Enter the first date of the period you want to view. * End Date – Enter the last date of the period you want to view. * View – Choose to see the demand results in a Daily, Weekly or Monthly format.
- demandplandetail: itemDemandPlan-demandplandetailCollection
- demandplanid Demand Plan Id: string
- demandplantype: object
-
- id Internal identifier.: string FINAL , SYSTEMFORECAST
- refName Reference Name: string
- endDate End Date: string (date)
-
You can alter your view of the demand plan by changing the date range or the plan view, as described below: * Year – Enter the year to view. * Month – Select a month to view * Start Date – Enter the first date of the period you want to view. * End Date – Enter the last date of the period you want to view. * View – Choose to see the demand results in a Daily, Weekly or Monthly format.
- externalId External ID: string
- id Internal ID: string
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
-
Optionally enter a memo for this plan. Later, you can search for this plan by the text entered here.
- month: object
-
- projectionDuration Projection Duration: integer (int64)
-
In the Projection Duration field, enter the number of periods to calculate projected future demand. For example, enter 6 to calculate demand over a six month period.
- projectionInterval Projection Interval: string
-
In the Projection Interval field, select the period of time demand is calculated for. For example, select Weekly to project how much demand is expected per week, as opposed to per month. If you are using the Seasonal Average method, only a Monthly interval is supported.
- projectionMethod Projection Method: string
-
Select a Projection Method: * Linear Regression – Use previous demand to project future inventory needs assuming a steady linear growth. * Moving Average – Use previous demand to calculate the overall average stock level needed, and then project future stock levels using that overall average. * Seasonal Average – Use previous demand to examine the seasonal trend of inventory flow, and then project a similar seasonal trend for future stock levels. Note: Using this method, the projection interval must be set to Monthly intervals. * Sales Forecast – When using NetSuite for your sales operations, this option uses forward looking sales forecast data to project inventory demand. When you use the Sales Forecast method, transaction types sourced for projection calculations are cash sale, invoice, estimate, opportunity, sales order, and item fulfillment.
- projectionStartDate Projection Start Date: string (date)
-
Once you select a projection interval, the first date of the period you want to forecast demand for is displayed in the Projection Start Date field.
- refName Reference Name: string
- startDate Start Date: string (date)
-
You can alter your view of the demand plan by changing the date range or the plan view, as described below: * Year – Enter the year to view. * Month – Select a month to view * Start Date – Enter the first date of the period you want to view. * End Date – Enter the last date of the period you want to view. * View – Choose to see the demand results in a Daily, Weekly or Monthly format.
- subsidiary: subsidiary
- units Unit of Measure: string
-
Select a Unit of Measure to create a demand plan based on the unit.
- year Year: number (double)
-
You can alter your view of the demand plan by changing the date range or the plan view, as described below: * Year – Enter the year to view. * Month – Select a month to view * Start Date – Enter the first date of the period you want to view. * End Date – Enter the last date of the period you want to view. * View – Choose to see the demand results in a Daily, Weekly or Monthly format.
itemDemandPlan-demandplandetailCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: itemDemandPlan-demandplandetailElement
-
itemDemandPlan-demandplandetailElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
itemDemandPlanCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: itemDemandPlan
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
itemDemandPlan - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
itemFulfillment
- accountingBookDetail: itemFulfillment-accountingBookDetailCollection
- appliedRules: itemFulfillment-appliedRulesCollection
- class: classification
- createdDate Date Created: string (date-time)
- createdFrom: nsResource
- customForm: object
-
- id Internal identifier.: string -9960
- refName Reference Name: string
- department: department
- entity: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- exchangeRate Exchange Rate: number (float)
- excludeFromGLNumbering Exclude from GL Audit Numbering: boolean
- externalId External ID: string
- generateIntegratedShipperLabel Integrated Shipping Label: boolean
-
Check this box if you are using a UPS or FedEx-integrated shipping item to ship this order. Checking this box integrates the order with your FedEx or UPS account and generates a shipping label to be printed at Transactions > Management > Print Checks and Forms. If you use the Pick, Pack and Ship feature, this order must be in the integrate stage in order to check this box. To set which stage shipping is integrated, go to Setup > Accounting > Setup Tasks > Shipping.
- generateReturnLabel Integrated Return Label: boolean
-
Check this box if you are using FedEx-integrated shipping item to return this order. Checking this box generates a shipping label for the selected shipping method to be printed at Transactions > Management > Print Checks and Forms. If you use the Pick, Pack and Ship feature, this order must be in the integrate stage in order to check this box. To set which stage shipping is integrated, go to Setup > Accounting > Setup Tasks > Shipping.
- handlingCost Handling Cost: number (double)
-
The handling cost automatically calculates depending on the shipping method you select in the Ship Via field. To change the cost of handling, go to Lists > Accounting > Shipping Items and select the shipping method with the handling cost you want to change.
- id Internal ID: string
- isBaseCurrency Base Currency: boolean
- iscommittedonly: string
- item: itemFulfillment-itemCollection
- lastModifiedDate Date Last Modified: string (date-time)
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
-
Enter an optional memo with additional information about this fulfillment. What you enter here can be used in searches and shows on reports.
- orderId Order Id: integer (int64)
- orderType Order Type: string
- package: itemFulfillment-packageCollection
- packedDate Packed Date: string (date)
-
Picked * If the Pick Date field is empty, it populates with the current date and the Transaction Date field is populated with the current date. Packed * If the Pick Date field is empty, it populates with the current date. * If the Pack Date field is empty, it populates with the current date and the Transaction Date field is populated with the current date. Shipped * If the Pick Date field is empty, it populates with the current date. * If the Pack Date field is empty, it populates with the current date. * If the Ship Date field is empty, it populates with the current date and the Transaction Date field is populated with the current date. * The Accounting Period field is required and it is populated based on the Ship Date.
- partner: partner
- pickedDate Picked Date: string (date)
-
Picked * If the Pick Date field is empty, it populates with the current date and the Transaction Date field is populated with the current date. Packed * If the Pick Date field is empty, it populates with the current date. * If the Pack Date field is empty, it populates with the current date and the Transaction Date field is populated with the current date. Shipped * If the Pick Date field is empty, it populates with the current date. * If the Pack Date field is empty, it populates with the current date. * If the Ship Date field is empty, it populates with the current date and the Transaction Date field is populated with the current date. * The Accounting Period field is required and it is populated based on the Ship Date.
- postingPeriod: accountingPeriod
- prevDate Previous Effective Date: string (date)
- refName Reference Name: string
- requestedBy: fulfillmentRequest
- returnAddress Return Shipping Address: string
- returnAddressList: nsResource
- returnShipAddr1 Address1: string
- returnShipAddr2 Address2: string
- returnShipCity City: string
- returnShipCountry Country: string
- returnShipMethod: object
-
- id Internal identifier.: string 44 , 45 , 46 , 47 , 48 , 49 , 50 , 51 , 52 , 53 , 10 , 54 , 11 , 55 , 12 , 56 , 13 , 57 , 14 , 15 , 16 , 17 , 18 , 19 , 1 , 2 , 3 , 4 , 5 , 6 , 7 , 8 , 9 , 20 , 21 , 22 , 23 , 24 , 25 , 26 , 27 , 28 , 29 , 30 , 31 , 32 , 33 , 34 , 35 , 36 , 37 , 38 , 40 , 41 , 42 , 43
- refName Reference Name: string
- returnShipState State: string
- returnShipZipCode Zip: string
- returnShippingAddress: itemFulfillment-returnShippingAddress
- returnShippingAddress_text Return Address: string
- salesordchannel: string
- shipAddress Address: string
-
The address this order will be shipped to displays in this field. * Select New in the Address Select field to enter a new shipping address to be used for this transaction and saved with the associated entity record. * Select Custom in the Address Select field to enter a new shipping address to be used for this transaction only (and not saved with the associated entity record). * Click the Edit icon for the Address Select field to edit an existing shipping address.
- shipAddressList: nsResource
- shipCarrier: object
-
- id Internal identifier.: string
- refName Reference Name: string
- shipCompany Shipping Addressee: string
- shipCountry: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- shipIsResidential Residential Address: boolean
-
Check this box if this address is not a business. This helps return accurate rates from UPS and FedEx.
- shipMethod: shipItem
- shipOverride Override: boolean
- shipPhone Shipping Phone: string
- shipStatus: object
-
- id Internal identifier.: string A , B , C
- refName Reference Name: string
- shipmentDetails: itemFulfillment-shipmentDetails
- shipmentPackage: itemFulfillment-shipmentPackageCollection
- shippedDate Shipped Date: string (date)
-
Picked * If the Pick Date field is empty, it populates with the current date and the Transaction Date field is populated with the current date. Packed * If the Pick Date field is empty, it populates with the current date. * If the Pack Date field is empty, it populates with the current date and the Transaction Date field is populated with the current date. Shipped * If the Pick Date field is empty, it populates with the current date. * If the Pack Date field is empty, it populates with the current date. * If the Ship Date field is empty, it populates with the current date and the Transaction Date field is populated with the current date. * The Accounting Period field is required and it is populated based on the Ship Date.
- shippingAddress: itemFulfillment-shippingAddress
- shippingAddress_text Shipping Address: string
- shippingCost Shipping Cost: number (double)
-
If you charge for shipping, enter the amount of shipping costs for this order here.
- status: object
-
- id Internal identifier.: string A , B , C
- refName Reference Name: string
- storeOrder: string
- subsidiary: subsidiary
- tranDate Date: string (date)
-
This is the date you are fulfilling this order. By fulfilling this order, you may be shipping items or completing services. If you want to change the date, enter or click Pick to select a different date.
- tranId Ref No.: string
-
NetSuite increases the largest fulfillment number by one. If you wish, you can type another number. The next fulfillment number will revert to the standard pattern.
- webSite: string
itemFulfillment-accountingBookDetailCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: itemFulfillment-accountingBookDetailElement
-
itemFulfillment-accountingBookDetailElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
itemFulfillment-accountingBookDetailElement
- accountingBook: accountingBook
- exchangeRate Exchange Rate: number (double)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- revRecOnRevCommitment Rev Rec on Rev Commit.: boolean
- subsidiary: subsidiary
- tranIsVsoeBundle Transaction Is VSOE Bundle: boolean
itemFulfillment-appliedRulesCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: itemFulfillment-appliedRulesElement
-
itemFulfillment-appliedRulesElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
itemFulfillment-item-inventoryDetail
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- externalId External ID: string
- inventoryassignment: itemFulfillment-item-inventoryDetail-inventoryassignmentCollection
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemDescription Description: string
-
A more complete Description of the item.
- links Links: nsLink
-
nsLink - location: location
- quantity Quantity: number (float)
-
In the Quantity to Build field, enter the number of assembly items you want to build. You cannot enter a quantity that exceeds the amount displayed in the Buildable Quantity field.
- refName Reference Name: string
- toLocation: location
- unit Units: string
-
If the assembly uses Units of Measure, the base units are displayed in the Units field.
itemFulfillment-item-inventoryDetail-inventoryassignmentCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: itemFulfillment-item-inventoryDetail-inventoryassignmentElement
-
itemFulfillment-item-inventoryDetail-inventoryassignmentElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
itemFulfillment-item-inventoryDetail-inventoryassignmentElement
- binNumber: bin
- expirationDate Expiration Date: string (date)
- internalId Internal ID: integer (int64)
- inventoryDetail Inventory Detail: integer (int64)
- inventoryStatus: inventoryStatus
- issueInventoryNumber: inventoryNumber
- links Links: nsLink
-
nsLink - packCarton Pack Carton: string
- pickCarton Pick Carton: string
- quantity Quantity: number (float)
- quantityAvailable Unpicked Bin Qty: number (float)
- receiptInventoryNumber Serial/Lot Number: string
- refName Reference Name: string
- secondaryQuantity Secondary Quantity: number (float)
- toBinNumber: bin
- toInventoryStatus: inventoryStatus
itemFulfillment-itemCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: itemFulfillment-itemElement
-
itemFulfillment-itemElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
itemFulfillment-itemElement
- amount Amount: number (double)
- class: classification
- createdPo: purchaseOrder
- currency Currency: string
- department: department
- description Description: string
- excludeFromRateRequest Exclude Item from Rate Request: boolean
- inventoryDetail: itemFulfillment-item-inventoryDetail
- isCatchWeightItem: boolean
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemFxAmount Foreign Amount: number (double)
- itemName Item: string
- itemReceive Fulfill/Receive: boolean
- itemSubtype Subtype: string
- itemType Type: string
- itemUnitPrice Unit Price: number (double)
- itemUpc UPC Code: string
- jobName Job: string
- kitMemberOf Member of Line: integer (int64)
- line Transaction Line: integer (int64)
- lineEntity Entity: integer (int64)
- links Links: nsLink
-
nsLink - location: location
- onHand On Hand: number (float)
- orderDoc: nsResource
- orderLine Order Line: integer (int64)
- primaryToSecondaryUnitConversionRate: number (float)
- quantity Quantity: number (float)
- refName Reference Name: string
- secondaryQuantity Secondary Quantity: number (float)
- secondaryUnitConversionRate: number (float)
- secondaryUnits Secondary Units: string
- secondaryUnitsList: string
- units Units: string
- unitsDisplay Units: string
itemFulfillment-package-packageDetails
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- declaredValue Declared Value: number (double)
- description Description: string
- externalId External ID: string
- id Internal ID: integer (int64)
- links Links: nsLink
-
nsLink - packageHeight Height: number (float)
- packageLength Length: number (float)
- packageWidth Width: number (float)
- refName Reference Name: string
itemFulfillment-packageCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: itemFulfillment-packageElement
-
itemFulfillment-packageElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
itemFulfillment-packageElement
- links Links: nsLink
-
nsLink - packageDescr Package Contents Description: string
- packageDetails: itemFulfillment-package-packageDetails
- packageTrackingNumber Package Tracking Number: string
- packageTrackingNumberReturn Return Tracking Number: string
- packageWeight Weight in Pounds: number (float)
- refName Reference Name: string
itemFulfillment-returnShippingAddress
- addr1 Address 1: string
- addr2 Address 2: string
- addr3 Address 3: string
- addrPhone Phone: string
- addrText Address: string
- addressee Addressee: string
- attention Attention: string
- city City: string
- country: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- externalId External ID: string
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - override Override: boolean
- refName Reference Name: string
- state State/Province: string
- zip Zip: string
itemFulfillment-shipmentPackageCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: itemFulfillment-shipmentPackageElement
-
itemFulfillment-shipmentPackageElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
itemFulfillment-shipmentPackageElement
- admissibilityPackageType: object
-
- alcoholRecipientType: object
-
- id Internal identifier.: string CONSUMER , LICENSEE
- refName Reference Name: string
- authorizationNumber Authorization Number: string
- carrierPackaging: object
-
- cashOnDeliveryAmount Cash On Delivery Amount: number (double)
- cashOnDeliveryMethod: object
-
- id Internal identifier.: string 3 , 4 , 5
- refName Reference Name: string
- codOtherCharge C.O.D. Other Charge: number (double)
- contentsDescription Contents Description: string
- declaredValue Declared Value: number (double)
- deliveryConfirmation: object
-
- id Internal identifier.: string 1 , 2
- refName Reference Name: string
- dimensionUnit Dimension Unit: string
- dryIceWeight Dry Ice Weight: number (float)
- freightChargeAddedToCod: object
-
- id Internal identifier.: string NONESELECTED , NET_CHARGE , COD_SURCHARGE , TOTAL_CUSTOMER_CHARGE , NET_FREIGHT
- refName Reference Name: string
- hasAdditionalHandling Has Additional Handling: boolean
- hasCashOnDelivery Has Cash On Delivery: boolean
- hasDeclaredValue Has Declared Value: boolean
- hasInsuredValue Has Insured Value: boolean
- height Height: integer (int64)
- insuredValue Insured Value: number (double)
- isAlcohol Is Alcohol: boolean
- isNonHazardousLiBatteries Is Non Hazardous Lithium Batteries: boolean
- isNonStandardContainer Is Non Standard Container: boolean
- length Length: integer (int64)
- links Links: nsLink
-
nsLink - priorityAlertContent Content Description: string
- priorityAlertType: object
-
- id Internal identifier.: string NONESELECTED , PRIORITY_ALERT , PRIORITY_ALERT_PLUS
- refName Reference Name: string
- refName Reference Name: string
- reference Reference: string
- reference2 Reference #2: string
- sequenceNumber Sequence Number: integer (int64)
- signatureOption: object
-
- id Internal identifier.: string NONESELECTED , PRIORITY_ALERT , PRIORITY_ALERT_PLUS
- refName Reference Name: string
- signatureRelease Signature Release: string
- trackingNumber TrackingNumber: string
- weightInLbs Weight in Pounds: number (float)
- width Width: integer (int64)
- yourPackaging: nsResource
itemFulfillment-shippingAddress
- addr1 Address 1: string
-
Enter the address the way it should appear on forms. For employees, customers, partners, and vendors, what you enter here autofills on forms if this address is marked default for Shipping or Billing. Enter up to 50 characters. This field is required for the Online Bill Pay feature.
- addr2 Address 2: string
-
Enter an optional second address line the way it should appear on forms. For employees, customers, partners, and vendors, what you enter here autofills on forms if this address is marked default for Shipping or Billing. Enter up to 50 characters.
- addr3 Address 3: string
- addrPhone Phone: string
-
Enter the phone number.
- addrText Address: string
-
The values entered in the other address fields are displayed here.
- addressee Addressee: string
-
Enter the name of the entity that should appear on the shipping label here. This name appears on the shipping label below what you enter in the Attention field.
- attention Attention: string
-
Enter the name of the person to whom a shipment is addressed, as it should appear on shipping labels. This field is required for UPS Integration.
- city City: string
-
Enter the city the way it should appear on all forms except checks.
- country: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- externalId External ID: string
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - override Override: boolean
-
Check this box to disable the free-form address text field. When this field is disabled, text entered in the other address fields does not display in the Address text field. Clear this box to allow text entered in the address component fields to appear in the free-form address text field.
- refName Reference Name: string
- state State/Province: string
-
Enter your company's state or province the way it should appear on all forms except checks.
- zip Zip: string
-
Enter the postal code the way it should appear on all forms except checks.
itemFulfillmentCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: itemFulfillment
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
itemFulfillment - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
itemGroup
This record is available as a beta record.
- availableToPartners Available to Adv. Partners: boolean
-
Check this box to make this item available to partners with the Advanced Partner Center role for viewing. These items are also available to partners with roles that are customized for the Advanced Partner Center and include view, create or edit access to item records.
- class: classification
- createdDate Date Created: string (date-time)
- customForm: object
-
- id Internal identifier.: string -220 , -10221 , -10220
- refName Reference Name: string
- defaultItemShipMethod: shipItem
- department: department
- description Description: string
-
Enter a description for this item. This description will appear in the Description column of sales forms.
- displayName Display Name/Code: string
-
Enter an optional name of up to 250 characters for this item in addition to the Item Name. If you are integrating with a Yahoo! store, this field is imported from Yahoo!. The display name prints in the Item column of sales forms when Basic printing is used. If this item is a member of a kit, this name appears in the Item column when the Print Items box is checked. If you do not enter a display name, the item name appears on printed forms.
- externalId External ID: string
- hierarchyVersions: itemGroup-hierarchyVersionsCollection
- id Internal ID: string
- includeChildren Include Children: boolean
-
Check the Include Children box to share the item with all the sub-subsidiaries associated with each subsidiary selected in the Subsidiary field. Note: When sharing items across subsidiaries, all of the options selected on the item record must be compatible across subsidiaries. For example, when entering an inventory item to be shared across subsidiaries, you should select Income and Asset accounts on the item record that are also shared across the same subsidiaries.
- includeStartEndLines Include Start/End Lines: boolean
-
Choose whether the start and end lines of the item group are referenced for sorting picking tickets that include item groups. * Clear the Include Start/End Lines box to delete the start or end line of the group on picking tickets. Then, component items for the group are sorted with other items on the picking ticket. * Check the Include Start/End Lines box to recognize the start or end line of the group on picking tickets.
- isInactive Inactive: boolean
-
When you check this box, this item will no longer appear on a list unless you check the Show All box at the bottom of the list page.
- isVsoeBundle Is VSOE Bundle: boolean
-
Check this box if this group of items is a VSOE bundle. The VSOE price of each item will then be used to allocate revenue across all items sold in the group.
- issueProduct: issueProduct
- itemCarrier: object
-
- id Internal identifier.: string ups , nonups
- refName Reference Name: string
- itemId Item Name/Number: string
-
Enter up to 250 characters for the name of this item. This name appears in lists on transactions. If you have the option of entering a display name and do not, the item name prints in the Item column of sales forms when Basic printing is used. If you have the option to enter a vendor name and do not, the item name prints in the Item column of purchase forms. If you have entered a display name, it will print on purchases instead of the item name when Basic printing is used.
- itemShipMethod: shipItemCollection
- itemType: object
-
- lastModifiedDate Last Modified: string (date-time)
- links Links: nsLink
-
nsLink - location: location
- member: itemGroup-memberCollection
- parent: itemGroup
- printItems Print Items: boolean
-
Check this box to display the member items with their respective display names, quantities and descriptions on sales and purchase forms. Clear this box to display only the description and amount of the group or kit on sales and purchase forms. Note: Assembly items do not display on purchase forms even when this box is checked. Also note that member items are never shown on printed forms; only one line with the group name and summary is printed.
- refName Reference Name: string
- subsidiary: subsidiaryCollection
- upcCode UPC Code: string
-
Enter a maximum of 999 characters in this field to identify an internal name or number to store the item's UPC Code. You can use the text you enter here when adding the item to transactions, searching, or viewing reports. * When you enter text in this field, the SKU/UPC field on item labels displays this UPC Code and prints in UPC bar code format. * When this field is clear, the SKU/UPC field on item labels displays the Item Name/Number and prints in Code-128 bar code format.
- vendorName Vendor Name/Code: string
-
If your vendor uses a name for this item that is different from the name you use, you can enter up to 60 characters as the vendor's name for this item here. The vendor's name for this item prints in the Item column of purchase forms. If you do not enter a vendor name, the item name prints in the Item column of purchase forms. If you have entered a display name, it will print on purchases instead of the item name.
itemGroup-hierarchyVersionsCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: itemGroup-hierarchyVersionsElement
-
itemGroup-hierarchyVersionsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
itemGroup-hierarchyVersionsElement
This record is available as a beta record.
- endDate Hierarchy Version End Date: string (date)
- hierarchyNode: merchandiseHierarchyNode
- hierarchyVersion: merchandiseHierarchyVersion
- isIncluded Included In Version: boolean
- links Links: nsLink
-
nsLink - refName Reference Name: string
- startDate Hierarchy Version Start Date: string (date)
itemGroup-memberCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: itemGroup-memberElement
-
itemGroup-memberElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
itemGroup-memberElement
This record is available as a beta record.
- id Internal ID: integer (int64)
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- lineNumber Line Id: integer (int64)
- links Links: nsLink
-
nsLink - memberDescr Description: string
- memberUnit Units: string
- quantity Quantity: number (float)
- refName Reference Name: string
- vsoeDeferral: object
-
- id Internal identifier.: string DEFERALLUNTIL , DEFERUNTIL
- refName Reference Name: string
- vsoeDelivered Default as Delivered: boolean
- vsoePermitDiscount: object
-
- id Internal identifier.: string IFDELIVERED , NEVER
- refName Reference Name: string
itemGroupCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: itemGroup
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
itemGroup - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
itemLocationConfiguration
This record is available as a beta record.
- advanceWarningThreshold Firm/Release Advance Warning Threshold: integer (int64)
- atpleadtime ATP Lead Time: integer (int64)
-
Enter an ATP Lead Time to use as a planning horizon for supply and demand considerations in the ship date recommendation calculations. It also provides a ship date on orders when no inventory is available based on future supply and demand.
- backwardConsumptionDays Backward Consumption Days: integer (int64)
-
When you use the Forecast Consumption demand source method, set the following: * Forward Consumption – Number of days after the order date to consider * Backward Consumption – Number of days prior to the order date to consider When backward and forward consumption days are entered for an item, these fields determine the window, or time period, that is considered for each sales order when a forecast amount may be consumed to calculate demand. If an order falls within the consumption window, that order quantity is calculated as being consumed and the forecast is adjusted to account for the order consumption. Note: NetSuite always considers backward consumption first. The forecast closest to the order in the backward window is consumed first. The forecast closest to the order in the forward window is considered if there are remaining quantities to be consumed. Note: Only sales order and invoice quantities can consume forecast quantities. Demand from transfer orders and work orders does not consume forecast quantities.
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- defaultreturncost Default Return Cost: number (double)
-
Enter the rate you want to default to show as the cost for this item when it is returned. What you enter in this field defaults to show in the Override Rate field on item receipts. You can still change this value after it appears on the item receipt.
- demandSource: object
-
- id Internal identifier.: string FORECASTANDORDERS , EXISTINGORDERSANDDEPENDENTDEMAND , FORECASTCONSUMPTION , ITEMDEMANDPLAN
- refName Reference Name: string
- demandTimeFence Demand Time Fence: integer (int64)
-
Demand Time Fence defaults to the number entered in the Default Demand Time Fence field. Verify the default or enter a number between zero and 365 to determine the demand time fence for this item.
- externalId External ID: string
- fixedLotSize Fixed Lot Size: number (float)
-
If you selected Fixed Lot Size as the lot sizing method, then enter a quantity in the Fixed Lot Size field. This is the quantity that procurement of this item is always based on, regardless of demand projections.
- forwardConsumptionDays Forward Consumption Days: integer (int64)
-
When you use the Forecast Consumption demand source method, set the following: * Forward Consumption – Number of days after the order date to consider * Backward Consumption – Number of days prior to the order date to consider When backward and forward consumption days are entered for an item, these fields determine the window, or time period, that is considered for each sales order when a forecast amount may be consumed to calculate demand. If an order falls within the consumption window, that order quantity is calculated as being consumed and the forecast is adjusted to account for the order consumption. Note: NetSuite always considers backward consumption first. The forecast closest to the order in the backward window is consumed first. The forecast closest to the order in the forward window is considered if there are remaining quantities to be consumed. Note: Only sales order and invoice quantities can consume forecast quantities. Demand from transfer orders and work orders does not consume forecast quantities.
- id Internal ID: string
- isAutoLocAssignmentAllowed Auto Loc. Assignment Allowed: boolean
- isAutoLocAssignmentSuspended Auto Loc. Assignment Suspended: boolean
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- lastModifiedDate Last Modified Date: string (date-time)
- lateDemandThreshold High Impact Late Demand Threshold: number (float)
- latePeriodDays Late Period Days: integer (int64)
- links Links: nsLink
-
nsLink - location: location
- locationallowstorepickup Allow Store Pickup: boolean
-
Check the Allow Store Pickup box to enable store pickup. All items are enabled for store pickup by default.
- locationstorepickupbufferstock Store Pickup Buffer Stock: number (float)
-
In the Store Pickup Buffer Stock field, enter the minimum inventory to be maintained at the location when creating store pickup orders. NetSuite uses the store pickup buffer stock to calculate the quantity available for store pickup of an item. Visitors to the web store will only be able to create a pickup order if the quantity available for store pickup is greater than zero. The store pickup buffer stock applies to all items at the location.
- memo Memo: string
-
Optionally enter a memo. Later, you can search for the text you enter in this field.
- minimumRescheduleDays Minimum Reschedule Days: integer (int64)
- name Name: string
-
Enter the item name.
- pastDueForecastDays Past Due Forecast Days: integer (int64)
- periodicLotSizeDays Periods of Supply Increment: integer (int64)
-
In the Period of Supply Increment field, enter a number from 1 to 90. The default setting is 1. The increment starts on the first day an order is required. From the first day, NetSuite aggregates all orders in the increment. Orders are placed on the first day of the period. Note: The Periodic Lot Size Increment field is enabled only when you select Interval in the Periodic Lot Size Type field.
- periodicLotSizeType: object
-
- id Internal identifier.: string INTERVAL , WEEKLY , MONTHLY
- refName Reference Name: string
- preferredStockLevel Preferred Stock Level: number (float)
-
The preferred stock level is the optimum quantity to maintain in stock of an item. The quantity you enter here is used to determine your replenishment needs on the Order Items page. It is the quantity you want to have in stock after an order is placed. * Auto-Calculating – Check the Auto-Calculate box if you want NetSuite to calculate the preferred stock level based on demand for the item. The preferred stock level is calculated as: (daily demand * number of days supply preferred). If no preferred stock level is identified, then the default preferred stock level is used from the Set Up Inventory Management page. * Manually Calculating – Clear the Auto-Calculate box to manually enter the preferred stock quantity. The preferred stock level you set is used to calculate the quantity of items to be ordered on the Order Items page.
- refName Reference Name: string
- reorderPoint Reorder Point: number (float)
-
The Reorder Point is the quantity level at which you need to reorder or build more of this item. * Auto-Calculating – Check the Auto-Calculate box if you want NetSuite to calculate the reorder point based on demand for the item over time. The reorder point depends on the safety stock definition and is calculated as follows: o Without safety stock defined: Reorder point = (average lead time days * demand) o With safety stock defined in days: Reorder point = [(average lead time days + safety stock days) * demand] o With safety stock quantity defined: Reorder point = [(average lead time days * demand) + safety stock quantity) * Manually Calculating – Clear the Auto-Calculate box if you want to manually enter the point at which to reorder or build more of this item. If you go to Home > User Preferences and place a check mark in the Inventory Level Warnings box, you are reminded when you have reached the reorder point.
- rescheduleHorizon Reschedule Horizon: integer (int64)
- rescheduleInDays Reschedule In Days: integer (int64)
-
In the Reschedule In Days field, enter a number between one and 90 that is the maximum number of days that the order can be advanced from the current day. For example, if you enter 10 in this field, an order for this item can be moved up ten days earlier, but not eleven or more days. This field defaults to be blank. Note: If this field is left blank, NetSuite does not make recommendations to reschedule orders for this item to a later date.
- rescheduleOutDays Reschedule Out Days: integer (int64)
-
In the Reschedule Out Days field, enter a number between one and 180 that is the maximum number of days that the order can be delayed from the current day. For example, if you enter 10 in this field, an order for this item can be moved to ten days later, but not eleven or more days. This field defaults to be blank. Note: If this field is left blank, NetSuite does not make recommendations to reschedule orders for this item to a later date.
- subsidiary: subsidiary
- supplyLotSizingMethod: object
-
- id Internal identifier.: string FIXED_LOT_SIZE , LOT_FOR_LOT , PERIODIC_LOT_SIZE
- refName Reference Name: string
- supplyTimeFence Planning Time Fence: integer (int64)
-
This field defaults to the number entered in the Default Planning Time Fence field. Verify the default or enter a number between zero and 365 to determine the planning time fence for this item.
- supplyType: object
-
- id Internal identifier.: string TRANSFER , PURCHASE
- refName Reference Name: string
itemLocationConfigurationCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: itemLocationConfiguration
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
itemLocationConfiguration - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
itemReceipt
This record is available as a beta record.
- accountingBookDetail: itemReceipt-accountingBookDetailCollection
- appliedRules: itemReceipt-appliedRulesCollection
- class: classification
- createdDate Date Created: string (date-time)
- createdFrom: nsResource
- currency: currency
- customForm: object
-
- id Internal identifier.: string -9961
- refName Reference Name: string
- department: department
- employee: employee
- entity: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- exchangeRate Exchange Rate: number (double)
-
The currency's exchange rate is shown in this field. You can edit the exchange rate for this transaction only, or you can update the currency record with the exchange rate you enter here.
- excludeFromGLNumbering Exclude from GL Audit Numbering: boolean
- externalId External ID: string
- icto: string
- id Internal ID: string
- inboundShipment: inboundShipment
- incoTerm: nsResource
- item: itemReceipt-itemCollection
- landedCostMethod: object
-
- id Internal identifier.: string WEIGHT , QUANTITY , VALUE
- refName Reference Name: string
- lastModifiedDate Date Last Modified: string (date-time)
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
-
Enter an optional reference memo for this receipt. Later, you can search for this receipt by text entered in the memo.
- orderId Order Id: integer (int64)
- orderType Order Type: string
- partner: partner
- postingPeriod: accountingPeriod
- prevDate Previous Effective Date: string (date)
- refName Reference Name: string
- subsidiary: subsidiary
- tranDate Date: string (date)
-
This is the date you are receiving this order. If you want to change the date, enter or click Pick to select a different date.
- tranId Ref No.: string
-
NetSuite increases the largest item receipt number by one. If you wish, you can type another number. The next item receipt number will revert to the standard pattern.
- transferlocation: location
itemReceipt-accountingBookDetailCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: itemReceipt-accountingBookDetailElement
-
itemReceipt-accountingBookDetailElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
itemReceipt-accountingBookDetailElement
This record is available as a beta record.
- accountingBook: accountingBook
- exchangeRate Exchange Rate: number (double)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- revRecOnRevCommitment Rev Rec on Rev Commit.: boolean
- subsidiary: subsidiary
- tranIsVsoeBundle Transaction Is VSOE Bundle: boolean
itemReceipt-appliedRulesCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: itemReceipt-appliedRulesElement
-
itemReceipt-appliedRulesElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
itemReceipt-item-inventoryDetail
This record is available as a beta record.
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- externalId External ID: string
- inventoryassignment: itemReceipt-item-inventoryDetail-inventoryassignmentCollection
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemDescription Description: string
-
A more complete Description of the item.
- links Links: nsLink
-
nsLink - location: location
- quantity Quantity: number (float)
-
In the Quantity to Build field, enter the number of assembly items you want to build. You cannot enter a quantity that exceeds the amount displayed in the Buildable Quantity field.
- refName Reference Name: string
- toLocation: location
- unit Units: string
-
If the assembly uses Units of Measure, the base units are displayed in the Units field.
itemReceipt-item-inventoryDetail-inventoryassignmentCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: itemReceipt-item-inventoryDetail-inventoryassignmentElement
-
itemReceipt-item-inventoryDetail-inventoryassignmentElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
itemReceipt-item-inventoryDetail-inventoryassignmentElement
This record is available as a beta record.
- binNumber: bin
- expirationDate Expiration Date: string (date)
- internalId Internal ID: integer (int64)
- inventoryDetail Inventory Detail: integer (int64)
- inventoryStatus: inventoryStatus
- issueInventoryNumber: inventoryNumber
- links Links: nsLink
-
nsLink - packCarton Pack Carton: string
- pickCarton Pick Carton: string
- quantity Quantity: number (float)
- quantityAvailable Unpicked Bin Qty: number (float)
- receiptInventoryNumber Serial/Lot Number: string
- refName Reference Name: string
- secondaryQuantity Secondary Quantity: number (float)
- toBinNumber: bin
- toInventoryStatus: inventoryStatus
itemReceipt-itemCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: itemReceipt-itemElement
-
itemReceipt-itemElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
itemReceipt-itemElement
This record is available as a beta record.
- amount Amount: number (double)
- billVarianceStatus: object
-
- id Internal identifier.: string NOVARIANCES , JOURNALNOTPOSTED , JOURNALPOSTED
- refName Reference Name: string
- class: classification
- currency Currency: string
- department: department
- description Description: string
- distribDate: string (date)
- fromlocation: string
- inventoryDetail: itemReceipt-item-inventoryDetail
- isCatchWeightItem: boolean
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemFxAmount Foreign Amount: number (double)
- itemName Item: string
- itemReceive Fulfill/Receive: boolean
- itemSubtype Subtype: string
- itemType Type: string
- itemUnitPrice Unit Price: number (double)
- itemUpc UPC Code: string
- jobName Job: string
- kitMemberOf Member of Line: integer (int64)
- line Transaction Line: integer (int64)
- lineEntity Entity: integer (int64)
- links Links: nsLink
-
nsLink - location: location
- onHand On Hand: number (float)
- orderDoc: nsResource
- orderLine Order Line: integer (int64)
- primaryToSecondaryUnitConversionRate: number (float)
- quantity Quantity: number (float)
- refName Reference Name: string
- secondaryQuantity Secondary Quantity: number (float)
- secondaryUnitConversionRate: number (float)
- secondaryUnits Secondary Units: string
- secondaryUnitsList: string
- units Units: string
- unitsDisplay Units: string
- vendorName Vendor Name: string
itemReceiptCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: itemReceipt
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
itemReceipt - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
itemRevision
This record is available as a beta record.
- effectiveDate Effective Date: string (date)
-
Enter the revision Effective Date.
- effectiveDateValid: boolean
- externalId External ID: string
- id Internal ID: string
- inactive Inactive: boolean
-
Check the Inactive box to not display this revision in lists.
- item: assemblyItem
- links Links: nsLink
-
nsLink - memo Memo: string
-
Enter a Memo about this revision. You can later search for this version by memo text.
- name Name: string
-
Enter a revision Name. For example, Version One.
- nameValid: boolean
- obsoleteDate Obsolete Date: string (date)
-
Obsolete dates on a revision record cannot be edited. You can set the effective date and when the revision is saved. The obsolete date is determined by NetSuite to avoid gaps or overlaps in dates covered by revisions.
- refName Reference Name: string
- target: string
itemRevisionCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: itemRevision
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
itemRevision - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
itemSupplyPlan
This record is available as a beta record.
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- externalId External ID: string
- id Internal ID: string
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
-
Optionally enter a memo. You can later search for this plan using this text.
- order: itemSupplyPlan-orderCollection
- planningmessage: itemSupplyPlan-planningmessageCollection
- refName Reference Name: string
- subsidiary: subsidiary
- units Unit of Measure: string
-
Select a Unit of Measure to create a supply plan based on the unit.
itemSupplyPlan-orderCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: itemSupplyPlan-orderElement
-
itemSupplyPlan-orderElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
itemSupplyPlan-planningmessageCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: itemSupplyPlan-planningmessageElement
-
itemSupplyPlan-planningmessageElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
itemSupplyPlan-planningmessageElement
This record is available as a beta record.
- creationdate Date Created: string (date)
- links Links: nsLink
-
nsLink - message Message: string
- messagecode Message Code: integer (int64)
- orderurl: string
- quantity Quantity: number (float)
- receiptdate Date: string (date)
- refName Reference Name: string
- rescheduledate Reschedule Date: string (date)
- transactionid: nsResource
- transactionlineid Order Line: string
itemSupplyPlanCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: itemSupplyPlan
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
itemSupplyPlan - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
job
This record is available as a beta record.
- accountNumber Account: string
-
If you assign account numbers for projects, enter the account number here.
- actualTime Actual Work: string
-
Indicates the actual time entered for the project, including open, pending approval, approved, unapproved, and rejected time transactions. This total includes time transactions entered against project tasks and the project as a whole without a specified task. If this project is set to include CRM tasks in project totals, then Actual Work also includes time entered for CRM tasks associated with this project.
- addressBook: job-addressBookCollection
- allocatedTime Allocated Work: string
-
Allocated work is the total number of hours allocated to this project. This includes hours allocated directly to project tasks.
- allowAllResourcesForTasks Display All Resources for Project Task Assignment: boolean
-
Check this box to allow any employee or vendor designated as a project resource on the entity record or any employee or vendor that has previously been assigned to a project to be assigned to a project task. When you enable this preference, any resource that has been previously assigned to a project appears in the list of available resources. This allows for the possibility that an employee or vendor no longer designated as a project resource can still be assigned to a new project task. Clear the box if you want to restrict project task assignment to resources you add to the Resources subtab. If you use Resource Allocations, enabling this preference overrides the need to allocate resources prior to making task assignments. Disabling this preference requires you to allocate defined resources prior to making task assignments. Generic resources are available for task assignments regardless of project allocation.
- allowExpenses Allow Expenses: boolean
-
Check this box to allow expenses to be entered for this project. If the Limit Time Entry to Assignees field is also checked, then only resources listed on the Resource subtab will be able to see this project in the Customer/Project select list for Expense Reporting.
- allowTaskTimeForRsrcAlloc Allow Allocated Resources to Enter Time to All Tasks: boolean
-
Check this box to allow resources allocated to this project to enter time against project tasks regardless of being assigned to the task. When this preference is enabled, the estimated work for a project task is updated with any additional time tracked by an allocated resource.
- allowTime Allow Time Entry: boolean
-
Check this box to enable time to be entered for this project. If the Limit Time Entry to Assignees field is checked, the project appears only in the Customer/Project dropdown for resources listed on the Resource tab of the project.
- alternateContact Alt. Contact: string
- applyProjectExpenseTypeToAll Apply to all time entries: boolean
-
Check this box to apply the selected project expense type to all time entries for this project. This preference overrides any other project expense type for time transactions recorded for this project.
- autoName Auto: boolean
-
Clear the box to manually enter an ID for this project. If you leave the box checked, then NetSuite copies the project name to create the ID.
- bBudget: job-bBudgetCollection
- bBudgetMonthids: string
- bBudgetShowCalculatedLines Show Calculated Lines: boolean
-
Check this box to show calculated budgets for each category.
- bBudgetUseCalculatedValues Use Calculated Values for all Billing Budgets: boolean
-
Check this box to use calculated values for billing budget categories. You will no longer be able to manually enter amounts. Billing budgets will not be calculated for non-billable tasks.
- baselineBudget: nsResource
- billingAccount: billingAccount
- billingRateCard: billingRateCard
- billingSchedule: billingSchedule
- cBudget: job-cBudgetCollection
- cBudgetLaborBudgetFromAlloc Calculate Labor Budgets from Resource Allocations: boolean
-
Check this box to automatically calculate labor budgets from resource allocations. You will no longer be able to enter budget amounts manually.
- cBudgetMonthids: string
- cBudgetShowCalculatedLines Show Calculated Lines: boolean
-
Check this box to show calculated amounts for all categories.
- cBudgetUseCalculatedValues Use Calculated Values for all Cost Budgets: boolean
-
Check this box to automatically calculate labor budgets. You will no longer be able to enter budget amounts manually.
- calculatedEndDate Calculated End Date: string (date)
-
NetSuite calculates the end date for the project as the date that all project tasks will be complete according to the current project schedule. Calculated End Date changes as the project schedule changes.
- calculatedEndDateBaseline Calculated End Date Baseline: string (date)
-
The Calculated End Date when the baseline was set.
- calculatedStartDate Calculated Start Date: string (date)
-
If you selected Backward in the Scheduling Method field, NetSuite displays the calculated start date of your project here.
- calculatedStartDateBaseline Calculated Start Date Baseline: string (date)
- calculatedWork Calculated Work: string
-
Total time calculated by NetSuite based on planned and actual time entered for project tasks. The Calculated Work field cannot be manually edited.
- calculatedWorkBaseline Calculated Work Baseline: string
- category: customerCategory
- chargeAmountBilled Processed: number (double)
-
This is the total amount that has been billed to the customer.
- chargeAmountHoldForBilling Hold: number (double)
-
The amount displayed is the total of charges with a Hold status. These charges must be set to Ready for Billing to be included on project sales orders.
- chargeAmountPending Total Pending Charges: number (double)
-
This is the total amount of charges that have been generated but not yet billed. Click the amount in this field to open the Manage Pending Charges page. This page allows you to review and update the stage of charges generated for this project.
- chargeAmountReadyForBilling Ready: number (double)
-
This amount is the total of charges with a status of Ready for Billing. These charges can be included on a project sales order.
- chargeAmountRemaining Remaining: number (double)
-
This is the total charge amount that has not been billed or put in the Ready stage.
- chargeExpenseAmount Expense: number (double)
-
The total billed expense charges are displayed here.
- chargeLaborAmount Labor: number (double)
-
The total billed labor charges are displayed here.
- comments Comments: string
-
Enter other information about this project.
- companyName Project Name: string
-
Enter a unique project name. If you use Auto-Generated Numbering, it is important to enter the project name here because the Project ID does not include the project name.
- contact: contact
- contactList: contactCollection
- createChargeRule Create Charge Rule: boolean
- currency: currency
- currencyPrecision Currency Precision: integer (int64)
- customForm: object
-
- id Internal identifier.: string -10003 , -3 , -10006
- refName Reference Name: string
- customer: customer
- dateCreated Date Created: string (date-time)
-
Indicates the date the project was created.
- defaultAddress Default Address: string
-
Enter a default address.
- defaultShippingAddress Default Shipping Address: string
- endDate Actual End Date: string (date)
-
Enter the date the project is finished.
- entityId Entity ID: string
-
NetSuite copies the Project Name as the Project ID. If you want to manually enter a Project ID, clear the Auto check box next to the field and enter the ID. If you use Auto-Generated Numbering, then NetSuite creates this ID automatically based on your settings at Setup > Company Set Up Auto-Generated Numbers.
- entityStatus: object
-
- id Internal identifier.: string
- refName Reference Name: string
- estimateAtCompletionBudget: nsResource
- estimateRevRecTemplate: revRecTemplate
- estimatedLaborCostBaseLine Estimated Labor Cost Baseline: number (double)
-
The value of Estimated Labor Cost when the baseline was set.
- estimatedTime Initial Time Budget: string
-
Indicates the sum of the initial time budgeted for the CRM Tasks that are included in this project.
- estimatedTimeOverrideBaseline Estimated Work Baseline: string
-
The value in the Estimated Work field when the baseline was set.
- estimatedcost Estimated Cost: number (double)
-
Enter the projected cost to complete this project.
- estimatedcostjc Estimated Cost: number (double)
-
The estimated cost for completing the project is displayed here. This cost is calculated from the labor cost of project tasks.
- estimatedgrossprofit Estimated Gross Profit: number (double)
-
Estimated Gross Profit is calculated as follows: For Time and Materials projects: [Estimated Labor Revenue - Estimated Labor Cost] For Fixed Bid projects: [Project Price - Estimated Labor cost]
- estimatedgrossprofitpercent Estimated Gross Profit Percent: number (double)
-
Shows the expected profit percentage, calculated as: For Time and Materials projects: [Estimated Gross Profit / Estimated Labor Revenue For Fixed Bid projects: [Estimated Gross Profit / Project Price]
- estimatedlaborcost Estimated Labor Cost: number (double)
-
Estimated Labor Cost is the total amount expected to be spent on labor for the project.
- estimatedlaborrevenue Estimated Labor Revenue: number (double)
-
Indicates the projected revenue to be billed for work performed on this project.
- estimatedrevenue Estimated Revenue: number (double)
-
Enter the projected revenue to be billed for work performed on this project.
- estimatedrevenuejc Estimated Revenue: number (double)
-
The estimated revenue for this project is displayed here. The estimate is calculated from the labor price of project tasks.
- estimatedtimeoverride Estimated Work: string
-
Estimated Work is the sum of the estimated work for all project tasks. Estimated Work also includes the Current Time Budget amounts for all CRM tasks if the Include CRM Tasks in Project Totals check box is selected for this project.
- externalId External ID: string
- forecastChargeRunOnDemand Forecast Charge Run on Demand: boolean
-
Check this box to only update actual and forecast charge runs when manually triggered and during the nightly update. Actual and forecast charges will no longer be automatically updated when a change to the project is made.
- fxRate Exchange Rate: number (double)
-
Shows the currency's exchange rate when you create the project. You can edit the rate for this project if you want to use a different rate for cost and labor estimates.
- id Internal ID: string
- includeCrmTasksInTotals Include CRM Task In Project Totals: boolean
-
Check this box to allow CRM tasks to be included in costs, planned time, and actual time for this project.
- isBudgetRebuilding: boolean
- isExemptTime Classify Time as Exempt: boolean
-
Exempt time is excluded when calculating utilization. It is not included in the numerator or denominator of the utilization formula.
- isInactive Inactive: boolean
-
If you check this box, then the project no longer appears on the list of projects. You cannot edit or make any changes to a project marked inactive. Check the Show Inactives box at the bottom of the List page to view inactive projects.
- isProductiveTime Classify Time as Productive: boolean
-
Productive time is time worked on a project but not included when calculating revenue for the project. Productive time is not billed to the customer. Training and pre-sales support are examples of productive time.
- isUtilizedTime Classify Time as Utilized: boolean
-
Utilized time directly contributes to the revenue for a project.
- jobBillingType: object
-
- id Internal identifier.: string FBM , STD , TM , FBI , CB
- refName Reference Name: string
- jobItem: nsResource
- jobPrice Project Price: number (double)
-
Enter the price billed to the customer on transactions. Project Price is also used to calculate the gross profit margin for the project.
- jobResources: job-jobResourcesCollection
- jobType: jobType
- language: object
-
- id Internal identifier.: string ro_RO , af_ZA , tl_PH , pt_BR , th_TH , bn_BD , cs_CZ , ca_ES , hu_HU , kn_IN , sk_SK , es_ES , nl_NL , is_IS , te_IN , sv_SE , sq_AL , es_AR , da_DK , ta_IN , sr_RS , en , ar , hr_HR , ko_KR , en_US , lt_LT , no_NO , el_GR , it_IT , ru_RU , pl_PL , en_AU , tr_TR , id_ID , hi_IN , mr_IN , fr_FR , he_IL , ja_JP , de_DE , ms_MY , zh_TW , fr_CA , pa_IN , fa_IR , bg_BG , vi_VN , hy_AM , lb_LU , xx_US , sh_RS , ht_HT , fi_FI , en_GB , gu_IN , et_EE , en_CA , lv_LV , uk_UA , bs_BA , zh_CN , sl_SI , pt_PT
- refName Reference Name: string
- lastBaseLineDate Last Baseline Date: string (date)
-
The date when the last project baseline was set.
- lastModifiedDate Last Modified Date: string (date-time)
- limitTimeToAssignees Limit Time and Expenses To Resources: boolean
-
Check this box to allow only resources listed on the Resources subtab for the project to enter time and expenses. Clearing this box allows any project resource to track time against this project and its project tasks. Only resources listed on the Resource tab will be able to see the project in Project select lists for time and expenses. Note: Regardless of whether this box is marked, in the Vendor Center, this project will only show if the vendor is listed as a resource of the project.
- links Links: nsLink
-
nsLink - materializeTime Create Planned Time Entries: boolean
-
Check this box to generate time entries for planned work on project tasks. Resources assigned to this project will be able to see their planned time in Time Tracking or Timesheets. If you use Project Budgets, planned time entries are required to generate calculated costs.
- openingBalance Opening Balance: number (double)
- openingBalanceAccount: account
- openingBalanceDate Opening Balance Date: string (date)
- originatingActualLine: string
- originatingDoc: string
- originatingItem: string
- originatingLine: string
- paStatement: job-paStatementCollection
- parent: nsResource
- percentComplete Rev Rec Override Percent Complete: number (double)
-
Enter an estimate of how much of the total project work is complete. This percentage is not calculated or updated by NetSuite.
- percentCompleteByRsrcAlloc Percent Complete by Allocated Work: number (double)
-
Percent Complete by Allocated Work is the progress of the project based on the allocated resources. This field can be useful in showing when projects require more effort than was originally planned.
- percentCompleteOverride: job-percentCompleteOverrideCollection
- percentTimeComplete Percent Work Complete: number (double)
-
Shows the percent of the total planned project time that has been completed. Percent Work Complete is calculated by dividing the total number of actual hours worked and reported in Time Tracking by the number of hours entered in the Estimated Work field for each project task. The percentage is 100% when the status of all project tasks is Completed.
- plStatement: job-plStatementCollection
- plannedwork Planned Work: string
-
Total of all planned time entered for project tasks. This field is not updated when time is entered outside the planned time. Planned time can only be updated by manually adding addition time to project tasks.
- plannedworkbaseline Planned Work Baseline: string
- primaryContact Primary Contact: string
- projectCompletelyBilled Project Completely Billed: boolean
- projectExpenseType: projectExpenseType
- projectManager: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- projectTasks_count: integer (int64)
- projectedEndDate Estimated End Date: string (date)
-
Enter the date you plan to complete all project tasks by. You can update this date at any time. If you use Advanced Projects, NetSuite calculates an end date based on the project schedule and displays it in Calculated End Date.
- projectedEndDateBaseline Estimated End Date Baseline: string (date)
-
The Estimated End Date when the baseline was set. Baseline information is available only if you use Advanced Projects.
- propagateActivity: boolean
- refName Reference Name: string
- revRecForecastRule: nsResource
- scheduledEndDateBaseline Scheduled End Date Baseline: string (date)
- scheduledenddate Scheduled End Date: string (date)
-
If you selected Backward in the Scheduling Method field, enter the end date for your project.
- schedulingMethod: object
-
- id Internal identifier.: string BACKWARD , FORWARD
- refName Reference Name: string
- sourceServiceItemFromRateCard Source Service Item to Task Assignments from Rate Card: boolean
- startDateBaseline Start Date Baseline: string (date)
-
The Start Date when the baseline was set. Baseline information is available only if you use Advanced Projects.
- startdate Start Date: string (date)
-
Enter the estimated date work will start on the project. You can change this date at any time during the life of the project. NetSuite schedules all project tasks without predecessors to start on this date.
- subTab_bBudget Billing Budget: string
- subTab_cBudget Cost Budget: string
- subsidiary: subsidiary
- targetname: string
- targettype: string
- timeRemaining Remaining Work: string
-
Indicates the time for work yet to be done on all project tasks, calculated as: [Estimated Work(all tasks) - Actual Work (all tasks)]
- timeapproval: object
-
- id Internal identifier.: string 1 , 2 , 3 , 4
- refName Reference Name: string
- useAllocatedTimeForForecast Use Allocated Time for Forecast: boolean
-
Check this box to use allocated time for project forecast reports.
- usePercentCompleteOverride Use Percent Complete Override for Forecasting: boolean
-
Check this box to generate forecast revenue plans based on the latest status of the Rev Rec Percent Complete Override subtab. Any planned time entries in the project record are ignored for revenue recognition and forecasting purposes. The Cumulative Percent Complete on the subtab must equal 100. For more information, see the help topic Using the Rev Rec Percent Complete Override Subtab.
- wbs: nsResource
- workassignment: job-workassignmentCollection
job-addressBook-addressBookAddress
This record is available as a beta record.
- addr1 Address 1: string
- addr2 Address 2: string
- addr3 Address 3: string
- addrPhone Phone: string
- addrText Address: string
- addressee Addressee: string
- attention Attention: string
- city City: string
- country: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- externalId External ID: string
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - override Override: boolean
- refName Reference Name: string
- state State/Province: string
- zip Zip: string
job-addressBookCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: job-addressBookElement
-
job-addressBookElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
job-addressBookElement
This record is available as a beta record.
- addressBookAddress: job-addressBook-addressBookAddress
- addressBookAddress_text Address: string
- addressId Internal ID: string
- defaultBilling Default Billing: boolean
- defaultShipping Default Shipping: boolean
- id ID: integer (int64)
- internalId Internal ID: integer (int64)
- isResidential Residential Address: boolean
- label Label: string
- links Links: nsLink
-
nsLink - refName Reference Name: string
job-bBudgetCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: job-bBudgetElement
-
job-bBudgetElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
job-cBudgetCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: job-cBudgetElement
-
job-cBudgetElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
job-jobResourcesCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: job-jobResourcesElement
-
job-jobResourcesElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
job-jobResourcesElement
This record is available as a beta record.
- defaultCost: number (double)
- email: string
- jobResource: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- links Links: nsLink
-
nsLink - overridenCost Cost Override: number (double)
- refName Reference Name: string
- role: nsResourceCollection
job-paStatementCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: job-paStatementElement
-
job-paStatementElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
job-paStatementElement
This record is available as a beta record.
- committedCost Committed Costs: number (double)
- committedRevenue Committed Revenue: number (double)
- cost Actual Cost: number (double)
- isTotal: string
- itemGroup Item Group: string
- job: job
- links Links: nsLink
-
nsLink - margin Margin: number (double)
- profit Profit: number (double)
- refName Reference Name: string
- revenue Actual Revenue: number (double)
job-percentCompleteOverrideCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: job-percentCompleteOverrideElement
-
job-percentCompleteOverrideElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
job-percentCompleteOverrideElement
This record is available as a beta record.
- comments Comments: string
- links Links: nsLink
-
nsLink - percent Cumulative Percent Complete: number (double)
- period: accountingPeriod
- refName Reference Name: string
job-plStatementCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: job-plStatementElement
-
job-plStatementElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
job-plStatementElement
This record is available as a beta record.
- cost Cost: number (double)
- costCategory Cost Category: string
- costCategoryRef: integer (int64)
- costCategorySubtype: string
- costCategoryType: string
- isTotal: string
- job: job
- links Links: nsLink
-
nsLink - margin Margin: number (double)
- profit Profit: number (double)
- refName Reference Name: string
- revenue Revenue: number (double)
job-workassignmentCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: job-workassignmentElement
-
job-workassignmentElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
job-workassignmentElement
This record is available as a beta record.
- assignee: nsResource
- billingclass: billingClass
- createddate Created Date: string (date-time)
- deadline Deadline: string (date)
- enddate End Date: string (date)
- externalid External ID: string
- id Internal ID: integer (int64)
- isinactive Inactive: boolean
- lastmodifieddate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - plannedhours Planned Hours: string
- projecttask: projectTask
- refName Reference Name: string
- reqline: boolean
- serviceitem: nsResource
- startdate Start Date: string (date)
- status: object
-
- id Internal identifier.: string UNASSIGNED , COMPLETED , ACCEPTED , CANCELED , STARTED , PENDING
- refName Reference Name: string
- title Title: string
jobCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: job
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
job - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
jobStatus
This record is available as a beta record.
- description Description: string
-
Enter a description of this other list item.
- externalId External ID: string
- id Internal ID: string
- isInactive Inactive: boolean
-
Check this box to remove all references to this record from your account. You can reactivate the record at any time.
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - longitemtype: string
- name Status: string
-
Enter the name for this record. This name appears in lists that include this record.
- refName Reference Name: string
- tname: string
jobStatusCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: jobStatus
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
jobStatus - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
jobType
This record is available as a beta record.
- externalId External ID: string
- id Internal ID: string
- isInactive Inactive: boolean
-
Check this box to remove all references to this record from your account. You can reactivate the record at any time.
- links Links: nsLink
-
nsLink - longitemtype: string
- name Project Type: string
-
Enter the name for this record. This name appears in lists that include this record.
- parent: jobType
- refName Reference Name: string
- tname: string
jobTypeCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: jobType
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
jobType - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
journalEntry
- accountingBook: accountingBook
- accountingBookDetail: journalEntry-accountingBookDetailCollection
- appliedRules: journalEntry-appliedRulesCollection
- approvalStatus: object
-
- id Internal identifier.: string 11 , 1 , 2 , 3
- refName Reference Name: string
- approved Approved: boolean
-
Check this box to indicate that this journal entry is approved. If you check this box, this journal entry will post immediately. If you do not check this box, this journal entry must be approved before it posts.
- class: classification
- createdDate Date Created: string (date-time)
- createdFrom: nsResource
- currency: currency
- customForm: object
-
- id Internal identifier.: string -9970 , 30
- refName Reference Name: string
- department: department
- exchangeRate Exchange Rate: number (double)
-
This field displays the default exchange rate of the To Subsidiary's currency to the Subsidiary's currency. You can edit the exchange rate for this transaction only, or you can update the currency exchange rates list.
- excludeFromGLNumbering Exclude from GL Audit Numbering: boolean
- externalId External ID: string
- id Internal ID: string
- isReversal Is Reversal: boolean
- lastModifiedDate Date Last Modified: string (date-time)
- line: journalEntry-lineCollection
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
-
If you wish, enter a memo to describe this journal entry. It will appear on this transaction detail as well as reports such as a 2-line account register.
- nextApprover: employee
- parentExpenseAlloc: nsResource
- postingPeriod: accountingPeriod
- refName Reference Name: string
- reversalDate Reversal Date: string (date)
-
If this journal entry is intended to be reversed, enter the date for the reversing entry to be posted. If Defer Entry is checked, this field is mandatory.
- reversalDefer Defer Entry: boolean
-
Check this box to make the reversal a memorized transaction that automatically occurs on the date entered in the required Reversal Date field. Clear this box to make the reversal an immediately entered transaction with the date in the Reversal Date field.
- subsidiary: subsidiary
- toSubsidiary: subsidiary
- tranDate Date: string (date)
-
NetSuite inserts today's date as the date of this journal entry. You can enter or select another date.
- tranId Entry No.: string
-
NetSuite increases the largest journal entry number by one. If you wish, you can type another number. The next journal entry number will revert to the standard pattern. You can enter a maximum of 45 characters in this field.
- void Void: boolean
journalEntry-accountingBookDetailCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: journalEntry-accountingBookDetailElement
-
journalEntry-accountingBookDetailElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
journalEntry-accountingBookDetailElement
- accountingBook: accountingBook
- exchangeRate Exchange Rate: number (double)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- revRecOnRevCommitment Rev Rec on Rev Commit.: boolean
- subsidiary: subsidiary
- tranIsVsoeBundle Transaction Is VSOE Bundle: boolean
journalEntry-appliedRulesCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: journalEntry-appliedRulesElement
-
journalEntry-appliedRulesElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
journalEntry-lineCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: journalEntry-lineElement
-
journalEntry-lineElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
journalEntry-lineElement
- account: account
- amortizationType Type: string
- class: classification
- cleared Cleared: boolean
- clearedDate Date Cleared: string (date)
- credit Credit: number (double)
- debit Debit: number (double)
- department: department
- eliminate Eliminate: boolean
- endDate End Date: string (date)
- entity: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- giftCertCode: giftCertificate
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- line Line Id: integer (int64)
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
- refName Reference Name: string
- residual Residual: number (double)
- revenueRecognitionRule: nsResource
- schedule: nsResource
- scheduleNum: nsResource
- scheduleType: object
-
- id Internal identifier.: string Amortization , RevRec
- refName Reference Name: string
- startDate Start Date: string (date)
journalEntryCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: journalEntry
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
journalEntry - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
kitItem
This record is available as a beta record.
- VSOEDeferral: object
-
- id Internal identifier.: string DEFERALLUNTIL , DEFERUNTIL
- refName Reference Name: string
- VSOEDelivered Default as Delivered: boolean
-
Check this box to automatically set this item to a Delivered status when this item is added to a transaction. Clear this box to leave the delivery status clear by default.
- VSOEPermitDiscount: object
-
- id Internal identifier.: string IFDELIVERED , NEVER
- refName Reference Name: string
- VSOEPrice Allocation Price: number (double)
-
Enter the VSOE Price for this item if it is known. Note: If you need to use more than one VSOE price for an item, you can set the most common price here and then change the price on each order manually.
- VSOESopGroup: object
-
- id Internal identifier.: string EXCLUDE , NORMAL , SOFTWARE
- refName Reference Name: string
- accountingBookDetail: kitItem-accountingBookDetailCollection
- amortizationPeriod Amortization Period: integer (int64)
- amortizationTemplate: amortizationTemplate
- autoExpandKitForRevenuemgmt Auto-Expansion for Revenue Management: boolean
-
When this box is checked, the parent kit item and its child product items become revenue elements. The child items include the fair value and accounting rules for advanced revenue management. By default, this box is checked. For a full description of this item-level preference, see Auto-Expansion of Kit Items.
- availableToPartners Available to Adv. Partners: boolean
-
Check this box to make this item available to partners with the Advanced Partner Center role for viewing. These items are also available to partners with roles that are customized for the Advanced Partner Center and include view, create or edit access to item records.
- billingSchedule: billingSchedule
- class: classification
- contingentRevenueHandling Eligible For Contingent Revenue Handling: boolean
-
Check this box to indicate that the item is subject to contingent revenue handling. When checked, revenue allocation is affected.
- correlatedItems: kitItem-correlatedItemsCollection
- costEstimate Item Defined Cost: number (double)
-
Enter an Item Defined Cost amount.
- countryOfManufacture: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- createExpensePlansOn: nsResource
- createRevenuePlansOn: nsResource
- createdDate Date Created: string (date-time)
- customForm: object
-
- id Internal identifier.: string -220 , -10221 , -10220
- refName Reference Name: string
- defaultItemShipMethod: shipItem
- deferralAccount: account
- deferredRevenueAccount: account
- department: department
- description Description: string
-
Enter a description for this item. This description will appear in the Description column of sales forms.
- directRevenuePosting Direct Revenue Posting: boolean
-
Check this box to disable advanced revenue management for this item. When checked, posting transactions that include this item post directly to the item revenue account. No revenue element or revenue arrangement is created. When you check this box, the Deferred Revenue Account on the Accounting subtab is disabled. When you create sales transactions that include items that have this box checked, all the items in the transaction must have the box checked. You cannot mix items that post directly to revenue with items that post to deferred revenue in the same transaction. This restriction also applies to kit items. All items in a kit must post either to revenue or to deferred revenue. You cannot check or clear the box after the item has been used in a transaction with advanced revenue management. By default, this box is not checked.
- displayName Display Name/Code: string
-
Enter an optional name of up to 250 characters for this item in addition to the Item Name. If you are integrating with a Yahoo! store, this field is imported from Yahoo!. The display name prints in the Item column of sales forms when Basic printing is used. If this item is a member of a kit, this name appears in the Item column when the Print Items box is checked. If you do not enter a display name, the item name appears on printed forms.
- dontShowPrice Don't Show Price: boolean
-
Check this box to hide the price of this item online. This is useful for items you want to advertise but don't want to sell or for items that you track inventory for and want to display but are offered in combination with other items.
- enforceminqtyinternally Enforce Minimum Internally: boolean
-
Check this box to apply the minimum quantity restriction on sales orders generated from NetSuite. When you clear this box, but enter a number in the Minimum Quantity field, the minimum quantity is only applied to web store orders.
- excludeFromSiteMap Exclude from Sitemap: boolean
-
Check this box to exclude a tab, category or item page from the site map.
- expenseAmortizationRule: nsResource
- externalId External ID: string
- featuredDescription Featured Description: string
-
If this item is displayed on the home page of your Web site, enter a featured description for this item. This description appears below the item's store display name on the Home page of your store or site. You can enter up to 999 characters including basic HTML code. Enter and format text using the formatting options, or click the HTML Source Code link to enter HTML.
- froogleProductFeed Google Base Product Feed: boolean
-
Check this box to include this item when exporting item lists to Froogle. Clear this box to remove this item when exporting item lists to Froogle.
- handlingCost Handling Cost: number (double)
-
As an option, you may enter a handling cost for this item in dollars. You must also create a shipping item for per-item shipping and handling costs at Lists > Shipping Items > New. When this item is selected on sales orders, invoices or cash sales, the appropriate shipping and handling charges are automatically calculated.
- hazmatHazardClass Hazmat Hazard Class: string
-
Enter the DOT hazardous material class or division.
- hazmatId Hazmat Id: string
-
Enter the regulatory identifier for the commodity from the Federal Express Ground Hazardous Materials Shipping Guide. The format is UNXXXX, where XXXX is a four digit number.
- hazmatItemUnits Hazmat Item Units: string
-
Enter the unit of measure for this item, such as kg or ml.
- hazmatItemUnitsQty Hazmat Item Units Quantity: number (float)
-
Enter the quantity for the item units.
- hazmatPackingGroup: object
-
- id Internal identifier.: string , DEFAULT , I , II , III
- refName Reference Name: string
- hazmatShippingName Hazmat Shipping Name: string
-
Enter the shipping name for the ID as listed in the Federal Express Ground Hazardous Materials Shipping Guide. This item appears on the OP950 form.
- hierarchyVersions: kitItem-hierarchyVersionsCollection
- id Internal ID: string
- includeChildren Include Children: boolean
-
Check the Include Children box to share the item with all the sub-subsidiaries associated with each subsidiary selected in the Subsidiary field. Note: When sharing items across subsidiaries, all of the options selected on the item record must be compatible across subsidiaries. For example, when entering an inventory item to be shared across subsidiaries, you should select Income and Asset accounts on the item record that are also shared across the same subsidiaries.
- incomeAccount: account
- internalId Internal ID: integer (int64)
-
Use this ID number to create smart tags for your item templates, site templates, and custom Web site that you host with NetSuite. Smart tags use the following format:
- isFulfillable Can be Fulfilled: boolean
-
Check the Can be Fulfilled/Received box to enable this item to be received and fulfilled during order processing. Clear this box if this item does not require being received and fulfilled. Note: Once this item has been added to transactions, this setting cannot be changed. This field is used when the Advanced Billing and Advanced Shipping features are both enabled.
- isGCoCompliant Google Checkout Compliant: boolean
- isHazmatItem Hazmat/Dangerous Goods: boolean
-
Check this box if this item is categorized as either hazardous material or dangerous goods. These items can only be shipped using FedEx integration.
- isInactive Inactive: boolean
-
When you check this box, this item will no longer appear on a list unless you check the Show All box at the bottom of the list page.
- isOnline Display in Website: boolean
-
Check this box to make this item available online in your Web site. You cannot sell this item online unless you check this box. If the item is of the Other Charge for Sale or Resale subtype, checking this box does not make it available in the web store catalog. However, it becomes available during web store checkout.
- issueProduct: issueProduct
- itemCarrier: object
-
- id Internal identifier.: string ups , nonups
- refName Reference Name: string
- itemId Item Name/Number: string
-
Enter up to 250 characters for the name of this item. This name appears in lists on transactions. If you have the option of entering a display name and do not, the item name prints in the Item column of sales forms when Basic printing is used. If you have the option to enter a vendor name and do not, the item name prints in the Item column of purchase forms. If you have entered a display name, it will print on purchases instead of the item name when Basic printing is used.
- itemRevenueCategory: nsResource
- itemShipMethod: shipItemCollection
- itemType: object
-
- lastModifiedDate Last Modified: string (date-time)
- links Links: nsLink
-
nsLink - location: location
- manufacturer Manufacturer: string
-
Enter the name of the company that manufactures this item.
- manufacturerAddr1 Manufacturer Address: string
-
Enter the address of the manufacturer. This is necessary to fill out international shipping forms when you sell and ship this item.
- manufacturerCity Manufacturer City: string
-
Enter the city location of the manufacturer of this item. This is necessary to automatically fill out international forms when you ship this item across borders.
- manufacturerState Manufacturer State: string
-
Enter the state where this item's manufacturer is located. This is necessary to fill out international forms when you ship this item.
- manufacturerTariff HS Tariff Number: string
-
Enter the Harmonized System (HS) tariff code number or the Harmonized Tariff Schedule (HTS) code number. This number should be six to ten characters.
- manufacturerTaxId Manufacturer Tax Id: string
-
Enter the Tax ID Number (TIN) for the manufacturer.
- manufacturerZip Manufacturer Zip Code: string
-
Enter the postal code of the location of this manufacturer. This is necessary to create international forms when you ship this item.
- maximumquantity Maximum Order Qty: integer (int64)
-
Enter the greatest quantity of this item that customers can purchase. If customers enter an item quantity above the maximum amount, a warning message is displayed. Web store customers are unable to complete checkout unless they enter a quantity equal to or below the maximum quantity. Leave this field empty to allow customers to check out without maximum quantity restrictions. You can edit this warning at Setup > Site Builder/SuiteCommerce Advanced > Customize Text.
- member: kitItem-memberCollection
- metaTagHtml Meta Tag HTML: string
-
Enter the Meta Tag HTML you want to appear in the < head > section of this item page. Meta tags enable your Web site to be found by search engines.
- minimumquantity Minimum Order Qty: integer (int64)
-
Enter the lowest quantity that customers can purchase. Web store customers receive a warning and cannot check out if they enter an item quantity below this minimum. Leave this field empty to allow customers to check out with no minimum quantity restrictions. You can edit this warning at Setup > Site Builder/SuiteCommerce Advanced > Customize Text.
- mpn Manufacturer Part Number: string
-
MPN (Manufacturers Part Number) - Enter the part number used by the manufacturer to identify this item.
- multManufactureAddr Multiple Manufacturer Addresses: boolean
-
Check the Multiple Manufacture Addresses box if this manufacturer uses more than one address.
- nexTagCategory NexTag Category: string
-
Enter the name of the NexTag category this item should be included in. This category is included in the product feeds you can export at Setup > Web Site > Product Feeds.
- nexTagProductFeed NexTag Product Feed: boolean
-
Check this box to include this item when exporting item lists to NexTag. Clear this box to remove this item when exporting item lists to NexTag.
- noPriceMessage No Price Message: string
-
If you opted to not show a price online, enter the message that should show instead of the price. For example, you might enter "Call for Price."
- offerSupport Offer Support: boolean
-
Check this box to offer support for this particular item. By offering support for items, customers can select on case records which item they are having trouble with.
- onSpecial On Special: boolean
-
If you want to put this item on special, check this box. The item then appears in the Specials category in your store or site.
- outOfStockBehavior: object
-
- id Internal identifier.: string DISABLE , ENABLENMSG , REMOVE , ENABLE , DEFAULT
- refName Reference Name: string
- outOfStockMessage Out Of Stock Message: string
-
You can enter a custom out of stock message for this item. The message here replaces the default out of stock message.
- overallQuantityPricingType: object
-
- id Internal identifier.: string ITEM , PARENT , SCHEDULE
- refName Reference Name: string
- pageTitle Page Title: string
-
Enter the text you want to appear as the page's title for this item. This text appears in the browser tab. Use a descriptive title for the item page, this can help achieve better results with search engine ranking.
- parent: kitItem
- parentOnly Use as Category Only: boolean
- preferenceCriterion: object
-
- id Internal identifier.: string , A , B , C , D , E , F
- refName Reference Name: string
- presentationItem: kitItem-presentationItemCollection
- price: kitItem-price
- pricesIncludeTax Prices Include Tax: boolean
-
Check this box to save the base price as the tax inclusive price. Clear this box to save the base price as the tax exclusive price.
- pricingGroup: pricingGroup
- printItems Print Items: boolean
-
Check this box to display the member items with their respective display names, quantities and descriptions on sales and purchase forms. Clear this box to display only the description and amount of the group or kit on sales and purchase forms. Note: Assembly items do not display on purchase forms even when this box is checked. Also note that member items are never shown on printed forms; only one line with the group name and summary is printed.
- quantityPricingSchedule: nsResource
- rate Price: number (double)
-
Enter the rate for this discount or markup. The rate can be either a percentage or dollar amount. A percentage discount must be followed by a % sign. A dollar amount should be entered as a positive number.
- rateIncludingTax Price Including Tax: number (double)
- refName Reference Name: string
- residual Residual: number (double)
- revRecForecastRule: nsResource
- revReclassFxAccount: account
- revenueAllocationGroup: nsResource
- revenueRecognitionRule: nsResource
- scheduleBCode: object
-
- scheduleBNumber Schedule B Number: string
-
Enter the number for the Schedule B form for this item.
- scheduleBQuantity Schedule B Quantity: number (float)
-
Enter the numeric quantity in relation to the unit of measure entered in the Schedule B Code field. These two fields are used together to determine the amount represented by one of this item on the Schedule B form for Shipping Export Declarations. For example, if you enter 5 in the Schedule B Quantity field, and you select kilogram in the Schedule B Code field, when you fulfill two of these items on an order, the Schedule B form presents the items’ amount as 10 kilograms.
- searchKeywords Search Keywords: string
-
Enter alternative search keywords that customers might use to find this item using your Web store’s internal search. These can include synonyms, acronyms, alternate languages or misspellings. These keywords are seen as equally important as the item name when searches are conducted.
- shipIndividually Ships Individually: boolean
-
Check this box if this item always ships alone and with no other items in the same package. This helps determine the number of packages needed and the shipping rate on order fulfillments.
- shipPackage: nsResource
- shippingCost Shipping Cost: number (double)
-
As an option, you may enter a shipping cost for this item in dollars. You must also create a shipping item for per-item shipping costs at Lists > Shipping Items > New. When this item is selected on sales orders, invoices or cash sales, the appropriate shipping charges are automatically calculated.
- shoppingDotComCategory Shopping.com Category: string
-
Enter the name of the Shopping.com category that this item should go under. This category is included in the product feeds that you can export from Setup > Web Site > Product Feeds. Go to www.shopping.com for more information on the categories available. This is an optional field only available for following item records: Kit/Package, Non-inventory Item for Sale, Non-inventory Item for Resale, Assembly (lot and serialized), and Inventory (lot and serialized).
- shoppingProductFeed Shopping Product Feed: boolean
-
Check this box to include this item when exporting item lists to Shopping.com. Clear this box to remove this item when exporting item lists to Shopping.com.
- shopzillaCategoryId Shopzilla Category ID: integer (int64)
-
Enter the name of the Shopzilla category this item should be included in. This category is included in the product feeds you export at Setup > Web Site > Product Feeds. Go to www.shopzilla.com for more information on the available categories. This is an optional field only displayed for the following item records: Kit/Package, Non-inventory Item for Sale, Non-inventory Item for Resale, Assembly (lot and serialized), and Inventory (lot and serialized).
- shopzillaProductFeed Shopzilla Product Feed: boolean
-
Check this box to include this item when exporting item lists to Shopzilla. Clear this box to remove this item when exporting item lists to Shopzilla.
- siteCategory: kitItem-siteCategoryCollection
- siteMapPriority: object
-
- stockDescription Stock Description: string
-
Enter up to 21 characters to specify information about this item, such as New, Refurbished or Ships 2-3 days.
- storeDescription Store Description: string
-
The store description appears under the item's store display name on item list pages in your store or site. You can enter letters, numbers, and basic HTML code. Note: To make the store description display when an item is in the Web store shopping cart, go to Setup > Web Site > Set Up Web Site. Click the Cart subtab, and check the box next to Store Description.
- storeDetailedDescription Detailed Description: string
-
Enter a detailed description for this item. When your customers click an item's store display name for more information, they see this description. You can enter letters, numbers or basic HTML code. If you are using Internet Explorer, you can also clear the View Source box below to enter and format text using the formatting options above. This eliminates the need for HTML code. If you do not see the View Source box, make sure Rich Text Editing is enabled at Home > Set Preferences > Appearance.
- storeDisplayImage: nsResource
- storeDisplayName Store Display Name: string
-
Enter the name of this item as you want it displayed in your Web site. You can enter up to 250 characters.
- storeDisplayThumbnail: nsResource
- subsidiary: subsidiaryCollection
- upcCode UPC Code: string
-
Enter a maximum of 999 characters in this field to identify an internal name or number to store the item's UPC Code. You can use the text you enter here when adding the item to transactions, searching, or viewing reports. * When you enter text in this field, the SKU/UPC field on item labels displays this UPC Code and prints in UPC bar code format. * When this field is clear, the SKU/UPC field on item labels displays the Item Name/Number and prints in Code-128 bar code format.
- urlComponent URL Component: string
-
Enter a short, descriptive name for this item to appear as part of its URL in the Web store. Setting a name to show in the URL can result in better ranking from search engines. If you leave this field blank, NetSuite terms and numbers are used as identifiers in the URL. Note: Descriptive URL components are case sensitive. Descriptive URLs must match the case used in the URL Component field of an item record to point to the correct page.
- useMarginalRates Use Marginal Rates: boolean
-
Check this box if you want the quantity discounts in the schedule to be applied to each pricing bracket separately. For example, a schedule offers no discount for the first 100 items sold and a 5% discount if more than 100 are sold. If 150 items are sold, the first 100 are at normal price, and the other fifty items are sold at 5% discount. Leave this box clear if you want the discount to apply to all of the items sold.
- weight Item Weight : number (float)
-
Enter the weight of this item and select the units in the dropdown.
- weightUnit: object
-
- id Internal identifier.: string 1 , 2 , 3 , 4
- refName Reference Name: string
- yahooProductFeed Yahoo Shopping Product Feed: boolean
kitItem-accountingBookDetailCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: kitItem-accountingBookDetailElement
-
kitItem-accountingBookDetailElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
kitItem-accountingBookDetailElement
This record is available as a beta record.
- accountingBook: accountingBook
- amortizationTemplate: amortizationTemplate
- createExpensePlansOn: nsResource
- createRevenuePlansOn: nsResource
- links Links: nsLink
-
nsLink - refName Reference Name: string
- revRecForecastRule: nsResource
- revRecSchedule: revRecTemplate
- revenueRecognitionRule: nsResource
- sameAsPrimaryAmortization Same as Primary Book Amortization: boolean
- sameAsPrimaryRevRec Same as Primary Book Rev Rec: boolean
kitItem-hierarchyVersionsCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: kitItem-hierarchyVersionsElement
-
kitItem-hierarchyVersionsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
kitItem-hierarchyVersionsElement
This record is available as a beta record.
- endDate Hierarchy Version End Date: string (date)
- hierarchyNode: merchandiseHierarchyNode
- hierarchyVersion: merchandiseHierarchyVersion
- isIncluded Included In Version: boolean
- links Links: nsLink
-
nsLink - refName Reference Name: string
- startDate Hierarchy Version Start Date: string (date)
kitItem-memberCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: kitItem-memberElement
-
kitItem-memberElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
kitItem-memberElement
This record is available as a beta record.
- dropShipMember Drop Ship Item: boolean
- id Internal ID: integer (int64)
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- lineNumber Line Id: integer (int64)
- links Links: nsLink
-
nsLink - memberDescr Description: string
- memberUnit Units: string
- quantity Quantity: number (float)
- refName Reference Name: string
kitItem-presentationItemCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: kitItem-presentationItemElement
-
kitItem-presentationItemElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
kitItem-price
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: kitItem-priceElement
-
kitItem-priceElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
kitItem-priceElement
This record is available as a beta record.
- currencyPage: currency
- discountDisplay Default Discount %: number (double)
- isInactive Inactive: boolean
-
When you check this box, this item will no longer appear on a list unless you check the Show All box at the bottom of the list page.
- links Links: nsLink
-
nsLink - price Amount: number (double)
- priceLevel: priceLevel
- priceLevelName Price Level: string
- priceQty Sequence Number: integer (int64)
- quantity: object
-
- value Value: string
- refName Reference Name: string
kitItem-siteCategoryCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: kitItem-siteCategoryElement
-
kitItem-siteCategoryElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
kitItem-siteCategoryElement
This record is available as a beta record.
- category: nsResource
- links Links: nsLink
-
nsLink - refName Reference Name: string
- webSite: webSite
kitItemCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: kitItem
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
kitItem - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
laborBasedProjectRevenueRule
This record is available as a beta record.
- amountLeftToRecognize Difference: number (double)
- billingRateCard: billingRateCard
- chargeRule: laborBasedProjectRevenueRule-chargeRuleCollection
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- description Description: string
-
Enter a description for this project revenue rule.
- externalId External ID: string
- id Internal ID: string
- isInactive Inactive: boolean
-
Check this box to inactivate this rule.
- links Links: nsLink
-
nsLink - name Name: string
-
Enter a name for this project revenue rule.
- project: job
- rateMultiplier Rate Multiplier: number (float)
-
Enter a decimal number you want to multiply the calculated rate by to determine the recognized amount for the revenue created by this rule.
- rateRoundingType: object
-
- id Internal identifier.: string NEXT4HOUR , NEXT8HOUR , NEXT1HOUR
- refName Reference Name: string
- rateSourceType: object
-
- id Internal identifier.: string RESOURCES , CLASSES , ITEMS
- refName Reference Name: string
- recognizedAmountSoFar Revenue: number (double)
- refName Reference Name: string
- resourceRateOverride: laborBasedProjectRevenueRule-resourceRateOverrideCollection
- revenueReconciled Revenue Reconciled: boolean
- savedSearch Saved Search: integer (int64)
- serviceItem: nsResource
- totalAmountToRecognize Charges: number (double)
-
This is the total amount of charges available for this rule.
laborBasedProjectRevenueRule-chargeRuleCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: laborBasedProjectRevenueRule-chargeRuleElement
-
laborBasedProjectRevenueRule-chargeRuleElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
laborBasedProjectRevenueRule-chargeRuleElement
This record is available as a beta record.
- billingItem: nsResource
- chargeRule: chargeRule
- description Description: string
- forecastAmount Amount: number (double)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- ruleType: object
-
- id Internal identifier.: string PROJECTPROGRESS , MILESTONE , FIXEDDATE , TIMEBASED , EXPENSEBASED , PURCHASE
- refName Reference Name: string
laborBasedProjectRevenueRule-resourceRateOverrideCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: laborBasedProjectRevenueRule-resourceRateOverrideElement
-
laborBasedProjectRevenueRule-resourceRateOverrideElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
laborBasedProjectRevenueRuleCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: laborBasedProjectRevenueRule
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
laborBasedProjectRevenueRule - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
location
This record is available as a beta record.
- allowStorePickup Allow Store Pickup: boolean
-
Check the Allow Store Pickup box to set the location as a valid store pickup location. This enables the location to be used in a store pickup fulfillment workflow. In a sales order, when you set the Fulfillment Choice to Store Pickup, you can select this location as the fulfillment location for line items in the sales order, provided that the line items also have the Allow Store Pickup box checked.
- autoAssignmentRegionSetting: object
-
- id Internal identifier.: string 0 , 1 , 2 , 3
- refName Reference Name: string
- bufferStock Buffer Stock: integer (int64)
-
In the Buffer Stock field, enter the minimum quantity of inventory to be maintained at the location. NetSuite uses this buffer stock when the Automatic Location Assignment feature processes orders. The buffer stock prevents NetSuite from assigning a fulfillment location to a line on an order if doing this causes inventory at the location to drop below the buffer stock. For example, the current item inventory at a location is 6 and the buffer stock for the location is 5. If an order is created with quantity 2, NetSuite will not assign the location to the line because doing this would cause inventory to drop below the buffer stock.
- businessHours: location-businessHoursCollection
- classtranslation: location-classtranslationCollection
- dailyShippingCapacity Daily Shipping Capacity: integer (int64)
-
Enter the maximum number of orders that can be shipped from a location in one day. Shipping capacity is based on the number of fulfillment requests created for the location in a one day interval. Automatic location assignment will not assign orders to the location if the daily shipping capacity has been reached. This field is only available when the Fulfillment Request feature is enabled. Note: The shipping capacity can be exceeded if the location is set manually on a sales order line.
- defaultAllocationPriority Default Allocation Priority: number (float)
-
Enter a default allocation priority number to designate the priority for this customer.
- docNumbering: location-docNumberingCollection
- excludeLocationRegions: location-excludeLocationRegionsCollection
- externalId External ID: string
- fullName Full Name: string
- geolocationMethod: object
-
- id Internal identifier.: string POSTALCODE , LATLONG
- refName Reference Name: string
- hasBins: boolean
- hasOpenSalesOrders: boolean
- hasTransactions: boolean
- id Internal ID: string
- includeChildren Include Children: boolean
-
Check the Include Children box to associate the location with all the sub-subsidiaries associated with each subsidiary selected in the Subsidiary field.
- includeInControlTower Include In Control Tower: boolean
-
Check this box to include this location when generating snapshots using the Supply Chain Control Tower feature.
- includeInSupplyPlanning Include in Supply Planning: boolean
-
When the Plan Through Distribution Network preference is enabled, NetSuite completes supply planning calculations to include only locations that have this setting enabled.
- includeLocationRegions: location-includeLocationRegionsCollection
- internalId Internal ID: integer (int64)
-
The NetSuite Internal ID related to this location.
- inventoryBalance: location-inventoryBalanceCollection
- invtTurnoverVelocity General inventory turn-over velocity: integer (int64)
- isInactive Location is Inactive: boolean
-
Check this box to inactivate this location record. Inactive locations do not show in lists of locations on records and transactions.
- lastModifiedDate Last Modified Date: string (date-time)
- latitude Latitude: number (float)
-
Enter the latitude coordinate of the location in decimal format, for example, "37.5367". Latitude is between -90 and 90. Use at least four decimal places to achieve a precise location. The decimal symbol you use depends on the number format in your user preferences.
- links Links: nsLink
-
nsLink - locationType: object
-
- id Internal identifier.: string 1 , 2
- refName Reference Name: string
- logo: nsResource
- longitude Longitude: number (float)
-
Enter the longitude coordinate of the location in decimal format, for example, "-122.3285". Longitude is between -180 and 180. Use at least four decimal places to achieve a precise location. The decimal symbol you use depends on the number format in your user preferences.
- mainAddress: location-mainAddress
- makeInventoryAvailable Make Inventory Available: boolean
-
Check this box to make on-hand inventory stored at the location available to orders. Clear this box to exclude on-hand inventory stored at the location from the available count.
- makeInventoryAvailableStore Make Inventory Available in Web Store: boolean
-
Check this box to include on-hand inventory stored at the location in the total quantity available to display in the Web Store. Clear this box to exclude the on-hand inventory stored at the location from the total quantity available to display in the Web Store.
- name Name: string
-
Enter a name for this location. The name you enter here is the name that shows in location lists on records and transactions. The name can be alphanumeric. The maximum number of characters is 31.
- nextPickupCutoffTime Next Pickup Cut-Off Time: string (date-time)
-
The next cut-off time for same day pickup orders at the location. NetSuite determines this time based on the same day pickup cut-off times in the business hours. The next pickup cut-off time might not be on the current day if one of the following is true: * The current day does not have a same day pickup cut-off time defined. * The same day pickup cut-off time has already passed on the current day. This field is read only.
- parent: location
- pickupAlertEmail Email for Store Pickup Alerts: string
-
Enter the email address of the store.
- refName Reference Name: string
- returnAddress: location-returnAddress
- sameDayShipCutOff Same day ship cut-off: string
- soPredConfidence Sales Order Predicted Risk Confidence: number (double)
-
Enter the predicted percentage of confidence the sales order might be late.
- soPredictedDays Sales Order Predicted Days Late/Early: integer (int64)
-
Enter the predicted number of days the sales order might be late or early.
- storeFulfillmentMemo Memo: string
-
Enter any additional information you want to add about store pickup at the location.
- storePickupBufferStock Store Pickup Buffer Stock: number (float)
-
In the Store Pickup Buffer Stock field, enter the minimum inventory to be maintained at the location when creating store pickup orders. NetSuite uses the store pickup buffer stock to calculate the quantity available for store pickup of an item. Visitors to the web store will only be able to create a pickup order if the quantity available for store pickup is greater than zero. The store pickup buffer stock applies to all items at the location.
- subsidiary: subsidiaryCollection
- timeZone: object
-
- id Internal identifier.: string America/Sao_Paulo , Asia/Vladivostok , Africa/Nairobi , Asia/Hong_Kong , Asia/Riyadh , Pacific/Kwajalein , America/Montevideo , Africa/Cairo , Africa/Windhoek , Europe/Moscow , Asia/Karachi , Pacific/Honolulu , America/Guatemala , Australia/Hobart , Australia/Perth , Australia/Darwin , Europe/London , Asia/Kuala_Lumpur , Asia/Baghdad , Europe/Budapest , Asia/Rangoon , America/Bogota , America/Manaus , Asia/Calcutta , America/Tijuana , Asia/Kabul , Pacific/Tongatapu , America/New_York , Asia/Beirut , Atlantic/Azores , Asia/Yerevan , Etc/GMT+12 , America/Chihuahua , Asia/Krasnoyarsk , GMT , America/Anchorage , Europe/Warsaw , Asia/Yakutsk , America/Chicago , America/Halifax , Etc/GMT-1 , Africa/Johannesburg , America/Godthab , Europe/Paris , Europe/Istanbul , Etc/GMT-3 , America/Santiago , Pacific/Auckland , Europe/Minsk , Asia/Baku , America/Caracas , Europe/Kiev , Asia/Tehran , Asia/Dacca , Pacific/Samoa , Atlantic/Reykjavik , America/La_Paz , Asia/Taipei , America/Regina , Asia/Tashkent , Asia/Manila , Asia/Bangkok , Pacific/Guam , Asia/Irkutsk , America/St_Johns , Asia/Muscat , US/East-Indiana , America/Denver , Europe/Amsterdam , America/Buenos_Aires , America/Noronha , Asia/Seoul , Asia/Amman , Australia/Sydney , Asia/Tokyo , Australia/Adelaide , Asia/Katmandu , Asia/Almaty , America/Phoenix , Australia/Brisbane , America/Los_Angeles , America/Mexico_City , Pacific/Guadalcanal , Etc/GMT+3 , Asia/Yekaterinburg , Asia/Jerusalem , Etc/GMT+1
- refName Reference Name: string
- toPredConfidence Transfer Order Predicted Risk Confidence: number (double)
-
Enter the predicted percentage of confidence the transfer order might be late.
- toPredictedDays Transfer Order Predicted Days Late/Early: integer (int64)
-
Enter the predicted number of days the transfer order might be late or early.
- totalShippingCapacity Total Shipping Capacity: integer (int64)
-
The maximum number of shipping orders that can accumulate in the backlog of orders to be shipped from the location. Shipping orders are based on the number of open fulfillment requests. The fulfillment workload distribution strategy in a rule uses this field to calculate current available work capacity at locations. This field is only available when the Fulfillment Request feature is enabled.
- tranInternalPrefix Transaction Number Prefix: string
-
If you want to use location-specific document and transaction numbering, enter up to eight alphanumeric characters to be a prefix for autogenerated numbers. This prefix indicates that transaction numbers are associated with this location. Note: You must set up location-specific transaction numbering on the Set Up Auto-Generated Numbers page at Setup > Company > Setup Tasks > Auto-Generated Numbers. On the Transaction Numbers subtab of this page, check the Use Location box next to each type of transaction that you want use location-specific numbering.
- tranNumbering: location-tranNumberingCollection
- tranPrefix Document Number Prefix: string
-
When you use auto-generated numbering with the Locations feature, you can make your transaction number sequences independent per location. Enter up to 8 alphanumeric characters in this field to number transactions with a prefix to signify this location. Then, click Save. To set up auto-generated numbering, go to Setup > Setup Tasks > Auto-Generated Numbers. On the Document Numbers subtab, check the Use Location box next to each transaction this prefix should apply to.
- useBins Use Bins: boolean
-
Check this box to use bins to track inventory at this location. Clear this box to not use bins track inventory at this location.
- useWarehouseManagement Use Warehouse Management: boolean
-
Check this box to enable Warehouse Management for a warehouse location.
location-businessHoursCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: location-businessHoursElement
-
location-businessHoursElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
location-businessHoursElement
This record is available as a beta record.
- endTime End time: string
- isFriday Friday: boolean
- isMonday Monday: boolean
- isSaturday Saturday: boolean
- isSunday Sunday: boolean
- isThursday Thursday: boolean
- isTuesday Tuesday: boolean
- isWednesday Wednesday: boolean
- links Links: nsLink
-
nsLink - refName Reference Name: string
- sameDayPickupCutOffTime Same Day Pickup Cut-Off Time: string
- startTime Start Time: string
location-classtranslationCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: location-classtranslationElement
-
location-classtranslationElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
location-classtranslationElement
This record is available as a beta record.
- language Language: string
- links Links: nsLink
-
nsLink - locale: object
-
- id Internal identifier.: string it_CH , en_TC , af_ZA , es_EA , es_EC , pt_BR , en_CY , fr_LU , nl_AN , es_UY , en_TT , es_ES , pt_ST , en_DM , en_TZ , es_ES_EURO , fr_ML , de_DE_onLQA , es_VE , nl_BE , da_DK , pt_AO , to_TO , en_UG , am_ET , ss_SZ , nl_BQ , ar , pt_AW , ko_KR , en_US , fr_BE_EURO , ko_KP , si_AQ , fr_MG , el_GR , be_BY , en_AU , he_IL , en_AW , es_SV , en_BB , ar_YE , es_CO , es_CL , en_BM , es_CR , pa_IN , en_SC , en_BS , sm_WS , it_IT_EURO , fr_KM , es_CU , en_SB , en_SG , en_BW , en_SH , en_BZ , en_SL , az_AZ , fi_FI , en_SS , sr_YU , en_CD , en_CA , ka_GE , lv_LV , uk_UA , es_DO , ur_PK , ar_IQ , fr_LU_EURO , pt_PT , fr_FR_EURO , en_PH , th_TH , bn_BD , si_LK , en_PG , hu_HU , ar_SA , ar_SD , ru_KZ , ar_BH , nl_BE_EURO , ro_MD , en_QA , ru_KG , es_AR , ta_IN , sr_RS , aa_ER , en , de_DE_EURO , zh_MO , en_AE , ar_SY , es_BO , en_AI , no_NO , en_AG , nl_SR , fr_VU , en_MW , gu_AQ , ar_TN , nl_SX , hi_IN , en_NA , mn_MN , en_NG , fr_FR , ms_MY , nl_CW , uz_UZ , ar_DJ , sr_CS , de_AT_EURO , en_NZ , es_PE , es_PA , fa_IR , ar_DZ , fr_GN , lb_LU , xx_US , pt_CV , sh_RS , ht_HT , fr_WF , es_AR_onLQA , es_PR , ar_EG , es_PY , fr_GA , en_KW , de_AT , ro_RO , en_KY , fr_FR_onLQA , fr_DJ , ca_ES_EURO , cs_CZ , en_LC , pl_AQ , fr_TD , fr_TG , es_MX , sv_AX , sk_SK , en_LR , en_LS , ar_OM , dz_BT , te_IN , de_LU_EURO , sq_AL , sv_SE , sn_ZW , es_NI , en_IE_EURO , my_MM , en_MF , en_MU , it_IT , pl_PL , fr_BE , fr_BF , tr_TR , fr_BI , fr_BJ , id_ID , fr_RW , en_ZM , km_KH , ja_JP , de_DE , fr_BL , tg_TJ , ar_QA , de_CH , zh_HK , pt_PT_EURO , en_JO , en_JM , fr_CA , nl_NL_EURO , fr_CF , fr_CG , fr_CD , pa_AQ , fr_CH , xx_US_wthId , fr_CI , pt_GW , vi_VN , ru_MD , fr_CM , fr_SC , en_KE , ne_NP , bs_BA , sl_SI , en_KN , fr_SN , ar_AE , en_GY , tl_PH , ca_ES , es_IC , lo_LA , kn_IN , so_SO , fr_PF , ar_JO , nl_NL , is_IS , fi_FI_EURO , pt_MZ , sk_SK_EURO , sl_SI_EURO , en_IE , ms_BN , hr_HR , ar_KW , de_LU , lt_LT , en_IN , ps_AF , en_ZA , en_VC , ru_RU , sh_YU , ar_LB , mr_IN , dv_MV , fj_FJ , zh_TW , tk_TM , ar_LY , en_VU , fr_NE , en_FK , es_GT , fr_NC , es_GQ , fa_AF , bg_BG , hy_AM , en_CY_EURO , mk_MK , ar_MA , en_GD , en_GB , es_HN , gu_IN , en_GH , et_EE , en_GI , zh_CN , en_GM , ar_MR
- refName Reference Name: string
- name Name: string
- refName Reference Name: string
location-docNumberingCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: location-docNumberingElement
-
location-docNumberingElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
location-excludeLocationRegionsCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: location-excludeLocationRegionsElement
-
location-excludeLocationRegionsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
location-excludeLocationRegionsElement
This record is available as a beta record.
- links Links: nsLink
-
nsLink - name Region name: string
- ranking Ranking: integer (int64)
- refName Reference Name: string
- region: nsResource
location-includeLocationRegionsCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: location-includeLocationRegionsElement
-
location-includeLocationRegionsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
location-includeLocationRegionsElement
This record is available as a beta record.
- links Links: nsLink
-
nsLink - name Region name: string
- ranking Ranking: integer (int64)
- refName Reference Name: string
- region: nsResource
location-inventoryBalanceCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: location-inventoryBalanceElement
-
location-inventoryBalanceElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
location-inventoryBalanceElement
This record is available as a beta record.
- binNumber: bin
- committedQtyPerLocation Committed Quantity (Per Location): string
- committedQtyPerSerialLotNumber Committed Quantity (Per Serial/Lot Number): string
- committedQtyPerSerialLotNumberLocation Committed Quantity (Per Serial/Lot Number & Location): string
- inventoryNumber: inventoryNumber
- inventoryStatus: inventoryStatus
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- links Links: nsLink
-
nsLink - quantityAvailable Available Quantity: string
- quantityOnHand On-Hand Quantity: string
- quantityPicked Picked Quantity: string
- refName Reference Name: string
location-mainAddress
This record is available as a beta record.
- addr1 Address 1: string
- addr2 Address 2: string
- addr3 Address 3: string
- addrPhone Phone: string
- addrText Address: string
- addressee Addressee: string
- attention Attention: string
- city City: string
- country: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- externalId External ID: string
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - override Override: boolean
- refName Reference Name: string
- state State/Province: string
- zip Zip: string
location-returnAddress
This record is available as a beta record.
- addr1 Address 1: string
- addr2 Address 2: string
- addr3 Address 3: string
- addrPhone Phone: string
- addrText Address: string
- addressee Addressee: string
- attention Attention: string
- city City: string
- country: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- externalId External ID: string
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - override Override: boolean
- refName Reference Name: string
- state State/Province: string
- zip Zip: string
location-tranNumberingCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: location-tranNumberingElement
-
location-tranNumberingElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
locationCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: location
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
location - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
manufacturingCostTemplate
This record is available as a beta record.
- costDetail: manufacturingCostTemplate-costDetailCollection
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- externalId External ID: string
- id Internal ID: string
- isInactive Inactive: boolean
-
Check the Inactive box if you do not want this template to show in lists on forms and records. Clear this box if you do want this template to show in lists.
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - memo Memo: string
-
Optionally enter a memo. You can search for text you enter here to find this template later.
- name Name: string
-
Enter a name for this template.
- nameValid: boolean
- refName Reference Name: string
- subsidiary: subsidiary
manufacturingCostTemplate-costDetailCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: manufacturingCostTemplate-costDetailElement
-
manufacturingCostTemplate-costDetailElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
manufacturingCostTemplate-costDetailElement
This record is available as a beta record.
- costCategory: costCategory
- fixedRate Fixed Rate: number (double)
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- links Links: nsLink
-
nsLink - refName Reference Name: string
- runRate Run Rate: number (double)
manufacturingCostTemplateCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: manufacturingCostTemplate
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
manufacturingCostTemplate - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
manufacturingOperationTask
This record is available as a beta record.
- actualRunTime Actual Run Time (Min): number (float)
- actualSetupTime Actual Setup Time (Min): number (float)
- actualWork Actual Work: string
-
The Actual time in Hours it took to complete this task.
- autoCalculateLag Auto-calculate Lag: boolean
-
Check the Auto-Calculate Lag box if you want NetSuite to calculate lag times for operation tasks. For more information, see Operations Overlap.
- completedQuantity Completed Quantity: number (float)
-
The total number of items created during this task.
- constraintType: object
-
- id Internal identifier.: string FIXEDSTART , ASAP
- refName Reference Name: string
- contact: contact
- costDetail: manufacturingOperationTask-costDetailCollection
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- doRecalculate: boolean
- endDate End Date: string (date-time)
-
In the Production End Date field, enter the date you expect to complete assembly production. This field defaults to today's date plus lead time. * Demand Planning bases assembly supply on the production end date. * Manufacturing Routing production end date depends on whether NetSuite uses forward or backward scheduling to calculate production requirements. To learn more, see Production Scheduling Methods Overview.
- endDateBaseline End Date Baseline: string (date-time)
- estimatedwork Estimated Work: number (float)
-
NetSuite calculates Estimated Hours as the expected time to complete a task based on total setup time + quantity x run rate.
- estimatedworkbaseline Estimated Work Baseline: number (float)
- eventId Project Task ID: integer (int64)
- externalId External ID: string
- finishByDate Finish No Later Than: string (date)
- id Internal ID: string
- inputQuantity Input Quantity: number (float)
-
The number of items entered or created during this task.
- insertBefore: manufacturingOperationTask
- isMilestone Milestone: boolean
- isOnCriticalPath: boolean
- isSummaryTask Summary Task: boolean
- laborResources Labor Resources: number (float)
-
Enter the number of Labor Resources required for this work center. If this labor resource is used in multiple work centers, enter a decimal amount. For example, if a welder only spends two hours in this work center in a day, enter .025.
- lastModifiedDate Last Modified Date: string (date-time)
- lastTask: string
- lateEnd: string (date)
- lateStart: string (date)
- links Links: nsLink
-
nsLink - machineResources Machine Resources: number (float)
-
Enter the number of Machine Resources required for this work center. If this machine is used in multiple work centers, enter a decimal amount. For example, if this machine is used by another work center for half the day, enter .05.
- manufacturingCostTemplate: manufacturingCostTemplate
- manufacturingWorkCenter: nsResource
- maxSequence: string
- message Comments: string
-
Additional Comments that are intended to accompany this operation task. For example, "use Shimano spokes when Bontrager spokes are not available."
- operationSequence Operation Sequence: integer (int64)
-
The Operation Sequence represents when the assembly task is scheduled to begin. For example, bicycle assembly setup could be sequence 1.
- owner: employee
- percentTimeComplete Percent Complete: number (double)
- predecessor: manufacturingOperationTask-predecessorCollection
- priority: object
-
- id Internal identifier.: string HIGH , MEDIUM , LOW
- refName Reference Name: string
- project: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- refName Reference Name: string
- remainingWork Remaining Work: string
-
Enter any Remaining Hours of work needed to complete this task.
- runRate Run Rate (Min/Unit): number (float)
-
Enter the operation Run Rate in minutes. This is the amount of time required to complete a run and produce one unit.
- setupTime Setup Time (Min): number (float)
-
Enter the operation Setup Time in minutes required to prepare for this step in the sequence. For example, the time required to warm up a molding machine.
- slackMinutes: number (float)
- startDateBaseline Start Date Baseline: string (date-time)
- startDateTime Start Date: string (date-time)
- status: object
-
- id Internal identifier.: string NOTSTART , PROGRESS , COMPLETE
- refName Reference Name: string
- title Name: string
-
The Name of the Operation.
- units: string
- workOrder: workOrder
manufacturingOperationTask-costDetailCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: manufacturingOperationTask-costDetailElement
-
manufacturingOperationTask-costDetailElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
manufacturingOperationTask-costDetailElement
This record is available as a beta record.
- account Account: integer (int64)
- costCategory: costCategory
- fixedRate Fixed Rate: number (double)
- id Internal ID: integer (int64)
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- links Links: nsLink
-
nsLink - refName Reference Name: string
- runRate Run Rate: number (double)
manufacturingOperationTask-predecessorCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: manufacturingOperationTask-predecessorElement
-
manufacturingOperationTask-predecessorElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
manufacturingOperationTask-predecessorElement
This record is available as a beta record.
- endDate End Date: string (date-time)
- lagAmount Lag Amount: integer (int64)
- lagDays Lag Time: number (float)
- lagType: object
-
- id Internal identifier.: string quantity , timepercent , time , qtypercent
- refName Reference Name: string
- lagUnits Lag Units: string
- links Links: nsLink
-
nsLink - refName Reference Name: string
- startDate Start Date: string (date-time)
- task: manufacturingOperationTask
- tempLagAmount: string
- tempLagType: string
- tempLagUnits: string
- type: object
-
- id Internal identifier.: string FS , SS , FF , SF
- refName Reference Name: string
manufacturingOperationTaskCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: manufacturingOperationTask
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
manufacturingOperationTask - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
manufacturingRouting
This record is available as a beta record.
- autoCalculateLag Auto-calculate Lag: boolean
-
Check the Autocalculate Lag box to autocalculate the routing. NetSuite can automatically calculate the optimal lag amount (the shortest possible lead time for each work order operation). Define the following on the manufacturing routing record: * Lag Amount * Lag Units Once defined, these values default on work orders. The auto-calculated lag amount is the Optimal (minimal) Lag Amount. If lag settings are changed on the operation record, NetSuite reschedules the operation when the task is saved with the new settings and reschedules all affected subsequent tasks. When a work order is scheduled, NetSuite calculates the optimal lag amount and maximal lag amount for each operation that has a preceding operation and has a defined lag type. NetSuite does not allow the lag amount to be defined outside of this range. Note: The autocalculation setting can be changed only when the work order status is Planned or Released. When Auto-calculate Lag is enabled, lag amounts on operations cannot be edited. The only available lag type is Quantity.
- billOfMaterials: bom
- billOfMaterialsBackup Bill of Materials: integer (int64)
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- externalId External ID: string
- id Internal ID: string
- isDefault Default: boolean
-
Check the Default box if you want to default to use this routing for this item on forms. The Default box denotes the default steps for creating a new special work orders and mass created work orders. Clear this box if you do not want this routing to be used by default.
- isInactive Is Inactive: boolean
-
Check the Inactive box if you do not want this routing to show in routing lists on records and forms. Clear this box if you do want this routing to show in lists.
- isNameValid: string
- item: assemblyItem
- links Links: nsLink
-
nsLink - location: locationCollection
- memo Memo: string
-
Optionally enter a memo for this routing. Later you can search for the text you enter in this field. For example, enter Use Beta Alternate when primary widget supply is unavailable.
- name Name: string
-
Enter a name for this routing template. This name will show for selection in the list of routings available in the Manufacturing Routing field on records and forms. For example, enter Beta Alternate Supply Routing.
- refName Reference Name: string
- routingComponent: manufacturingRouting-routingComponentCollection
- routingStep: manufacturingRouting-routingStepCollection
- subsidiary: subsidiary
- units: string
manufacturingRouting-routingComponentCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: manufacturingRouting-routingComponentElement
-
manufacturingRouting-routingComponentElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
manufacturingRouting-routingComponentElement
This record is available as a beta record.
- assemblyItemMember Member Item: string
- bomQuantity BoM Quantity: number (float)
- component: string
- description Description: string
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemName Item Name: string
- itemUrl: string
- links Links: nsLink
-
nsLink - operationDisplayText Operation: string
- operationSequenceNumber Operation Sequence: integer (int64)
- quantity Quantity: number (float)
- refName Reference Name: string
- revision: bomRevision
- units Units: string
- yield Yield: number (double)
manufacturingRouting-routingStepCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: manufacturingRouting-routingStepElement
-
manufacturingRouting-routingStepElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
manufacturingRouting-routingStepElement
This record is available as a beta record.
- id ID: string
- laborResources Labor Resources: number (float)
- lagAmount Lag Amount: integer (int64)
- lagType: object
-
- id Internal identifier.: string quantity , timepercent , time , qtypercent
- refName Reference Name: string
- lagUnits Lag Units: string
- links Links: nsLink
-
nsLink - machineResources Machine Resources: number (float)
- manufacturingCostTemplate: manufacturingCostTemplate
- manufacturingWorkCenter: nsResource
- operationName Operation Name: string
- operationSequence Operation Sequence: integer (int64)
- operationYield Operation Yield: number (double)
- refName Reference Name: string
- runRate Run Rate (Min/Unit): number (float)
- setupTime Setup Time (Min): number (float)
- tempLagAmount: string
- tempLagType: string
- tempLagUnits: string
manufacturingRoutingCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: manufacturingRouting
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
manufacturingRouting - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
markupItem
This record is available as a beta record.
- account: account
- availableToPartners Available to Adv. Partners: boolean
-
Check this box to make this item available to partners with the Advanced Partner Center role for viewing. These items are also available to partners with roles that are customized for the Advanced Partner Center and include view, create or edit access to item records.
- class: classification
- createdDate Date Created: string (date-time)
- customForm: object
-
- id Internal identifier.: string -10230 , -230
- refName Reference Name: string
- department: department
- description Description: string
-
Enter a description for this item. This description will appear in the Description column of sales forms.
- displayName Display Name/Code: string
-
Enter an optional name of up to 250 characters for this item in addition to the Item Name. If you are integrating with a Yahoo! store, this field is imported from Yahoo!. The display name prints in the Item column of sales forms when Basic printing is used. If this item is a member of a kit, this name appears in the Item column when the Print Items box is checked. If you do not enter a display name, the item name appears on printed forms.
- externalId External ID: string
- id Internal ID: string
- includeChildren Include Children: boolean
-
Check the Include Children box to share the item with all the sub-subsidiaries associated with each subsidiary selected in the Subsidiary field. Note: When sharing items across subsidiaries, all of the options selected on the item record must be compatible across subsidiaries. For example, when entering an inventory item to be shared across subsidiaries, you should select Income and Asset accounts on the item record that are also shared across the same subsidiaries.
- isInactive Inactive: boolean
-
When you check this box, this item will no longer appear on a list unless you check the Show All box at the bottom of the list page.
- isPreTax Apply Before Tax: boolean
-
Check this box to apply this markup or discount before taxes are calculated. Important: This option is only for use in countries that levy sales tax; for example, the United States. In OneWorld accounts, this checkbox does not have any effect on countries that use value-added tax (VAT). However, this option can be used for Brazil, China, and India. For more information, see the Help topic Applying Sales Tax or VAT to Discount Items
- issueProduct: issueProduct
- itemId Item Name/Number: string
-
Enter up to 250 characters for the name of this item. This name appears in lists on transactions. If you have the option of entering a display name and do not, the item name prints in the Item column of sales forms when Basic printing is used. If you have the option to enter a vendor name and do not, the item name prints in the Item column of purchase forms. If you have entered a display name, it will print on purchases instead of the item name when Basic printing is used.
- itemType: object
-
- lastModifiedDate Last Modified: string (date-time)
- links Links: nsLink
-
nsLink - location: location
- nonPosting: object
-
- id Internal identifier.: string T , F
- refName Reference Name: string
- parent: markupItem
- parentOnly Use as Category Only: boolean
- rate Rate: number (double)
-
Enter the rate for this discount or markup. The rate can be either a percentage or dollar amount. A percentage discount must be followed by a % sign. A dollar amount should be entered as a positive number.
- refName Reference Name: string
- subsidiary: subsidiaryCollection
- upcCode UPC Code: string
-
Enter a maximum of 999 characters in this field to identify an internal name or number to store the item's UPC Code. You can use the text you enter here when adding the item to transactions, searching, or viewing reports. * When you enter text in this field, the SKU/UPC field on item labels displays this UPC Code and prints in UPC bar code format. * When this field is clear, the SKU/UPC field on item labels displays the Item Name/Number and prints in Code-128 bar code format.
- vendorName Vendor Name/Code: string
-
If your vendor uses a name for this item that is different from the name you use, you can enter up to 60 characters as the vendor's name for this item here. The vendor's name for this item prints in the Item column of purchase forms. If you do not enter a vendor name, the item name prints in the Item column of purchase forms. If you have entered a display name, it will print on purchases instead of the item name.
markupItemCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: markupItem
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
markupItem - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
merchandiseHierarchyLevel
This record is available as a beta record.
- description Description: string
-
Enter a description of this level.
- externalId External ID: string
- id Internal ID: string
- insertbefore: merchandiseHierarchyLevel
- internalId Internal ID: integer (int64)
- links Links: nsLink
-
nsLink - name Name: string
-
Enter the name of this level.
- rank Rank: integer (int64)
-
Describes where the level appears in the hierarchy. The lowest rank (rank 1) is the top level of the hierarchy. You cannot edit this field. The insert Before field determines the rank of a level.
- refName Reference Name: string
merchandiseHierarchyLevelCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: merchandiseHierarchyLevel
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
merchandiseHierarchyLevel - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
merchandiseHierarchyNode
This record is available as a beta record.
- description Description: string
-
Enter a description of this node.
- externalId External ID: string
- hierarchyversions: merchandiseHierarchyNode-hierarchyversionsCollection
- id Internal ID: string
- internalId Internal ID: integer (int64)
- links Links: nsLink
-
nsLink - name Name: string
-
Enter the name of this node.
- refName Reference Name: string
merchandiseHierarchyNode-hierarchyversionsCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: merchandiseHierarchyNode-hierarchyversionsElement
-
merchandiseHierarchyNode-hierarchyversionsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
merchandiseHierarchyNode-hierarchyversionsElement
This record is available as a beta record.
- enddate Hierarchy Version End Date: string (date)
- hierarchylevel: merchandiseHierarchyLevel
- hierarchyversion: merchandiseHierarchyVersion
- hierarchyversionid Hierarchy Version Id: integer (int64)
- isincluded Included In Version: boolean
- links Links: nsLink
-
nsLink - parentnode Parent Node: string
- path Path: string
- refName Reference Name: string
- startdate Hierarchy Version Start Date: string (date)
merchandiseHierarchyNodeCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: merchandiseHierarchyNode
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
merchandiseHierarchyNode - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
merchandiseHierarchyVersion
This record is available as a beta record.
- description Description: string
-
Enter a description of this version.
- enddate End Date: string (date)
-
Enter the end date of this version.
- externalId External ID: string
- hierarchylevels: merchandiseHierarchyVersion-hierarchylevelsCollection
- id Internal ID: string
- internalId Internal ID: integer (int64)
- links Links: nsLink
-
nsLink - name Name: string
-
Enter the name of this version.
- refName Reference Name: string
- startdate Start Date: string (date)
-
Enter the start date of this version.
merchandiseHierarchyVersion-hierarchylevelsCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: merchandiseHierarchyVersion-hierarchylevelsElement
-
merchandiseHierarchyVersion-hierarchylevelsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
merchandiseHierarchyVersion-hierarchylevelsElement
This record is available as a beta record.
- hierarchylevel: merchandiseHierarchyLevel
- isincluded Included In This Version: boolean
- levelrank Level Rank: integer (int64)
- links Links: nsLink
-
nsLink - refName Reference Name: string
merchandiseHierarchyVersionCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: merchandiseHierarchyVersion
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
merchandiseHierarchyVersion - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
message
- activity: nsResource
- author: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- authorEmail From Email Address: string
- bcc Bcc: string
-
E-mail addresses you enter here receive a copy of this e-mail message, but these addresses do not show to the other recipients of the message. Separate multiple addresses with a comma or a semicolon.
- cc Cc: string
-
Enter the email addresses you would like to receive a copy of this message. Separate multiple addresses with a comma or a semicolon. These email addresses will show to everyone who receives this message.
- emailed Emailed: boolean
-
Check this box if you are pasting in an e-mail message.
- entity: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- externalId External ID: string
- hasAttachment Has Attachments: boolean
- htmlMessage HTML Format: boolean
- id Internal ID: string
- incoming Is Incoming: boolean
- lastModifiedDate Modification Date: string (date-time)
- links Links: nsLink
-
nsLink - message Message: string
-
Paste or enter the text of the message in this field.
- messageDate Date: string (date)
- primaryRecipient: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- recipient: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- recipientEmail Email Address: string
-
Enter the e-mail address of the recipient.
- record Record: string
- recordType Record Type: string
- refName Reference Name: string
- subject Subject: string
-
Enter a subject or title for this email message. This subject is displayed on the messages subtab on the records of those receiving or sending the message.
- template: nsResource
- time Time: string
- transaction: nsResource
messageCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: message
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
message - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
nexus
This record is available as a beta record.
- country: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- description Description: string
-
Enter a description for this record.
- externalId External ID: string
- id Internal ID: string
- isInactive Inactive: boolean
-
Check this box to inactivate this record. Inactive records do not show on transactions and records for selection in lists.
- links Links: nsLink
-
nsLink - parentNexus: nexus
- refName Reference Name: string
- state: nsResource
- taxAgency: vendor
- taxAgencyPst: vendor
- taxCode: nsResource
- taxDateFromFulfillment Use Fulfillment to Modify Tax Point Date: boolean
-
Check this box to use the fulfillment date as the tax point date for this transaction. This overrides the default Nexus setting which uses the transaction date to determine the tax point date. This setting is typically used for jurisdictions which require the item fulfillment date to be used to define the tax point date.
nexusCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: nexus
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
nexus - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
nonInventoryPurchaseItem
This record is available as a beta record.
- VSOEDeferral: object
-
- id Internal identifier.: string DEFERALLUNTIL , DEFERUNTIL
- refName Reference Name: string
- VSOEDelivered Default as Delivered: boolean
- VSOEPermitDiscount: object
-
- id Internal identifier.: string IFDELIVERED , NEVER
- refName Reference Name: string
- VSOEPrice Allocation Price: number (double)
- VSOESopGroup: object
-
- id Internal identifier.: string EXCLUDE , NORMAL , SOFTWARE
- refName Reference Name: string
- accountingBookDetail: nonInventoryPurchaseItem-accountingBookDetailCollection
- amortizationPeriod Amortization Period: integer (int64)
-
Enter the number of periods over which the purchase amount should be amortized. For example, enter 60 to amortize the amount over 60 periods starting from the amortization start date. Note: The starting period is specified by the amortization start date on bills. If no amortization start date is specified, the posting date of the bill is the amortization start date.
- amortizationTemplate: amortizationTemplate
- availableToPartners Available to Adv. Partners: boolean
-
Check this box to make this item available to partners with the Advanced Partner Center role for viewing. These items are also available to partners with roles that are customized for the Advanced Partner Center and include view, create or edit access to item records.
- baseUnit Primary Base Unit: string
- billExchRateVarianceAcct: account
- billPriceVarianceAcct: account
- billQtyVarianceAcct: account
- class: classification
- consumptionUnit Primary Consumption Unit: string
-
If you use the Multiple Units of Measure feature, select the default unit of measure for inventory.
- cost Purchase Price: number (double)
-
Enter the price you pay for this item. If you do not enter a price, purchase orders for this item show the most recent purchase price by default. If you select a preferred vendor for this item, the price is shown in the currency selected on the vendor's record. If no preferred vendor is selected, the price is shown in your base currency.
- createExpensePlansOn: nsResource
- createdDate Date Created: string (date-time)
- currency: currency
- customForm: object
-
- id Internal identifier.: string -210 , -10211 , -10210
- refName Reference Name: string
- deferralAccount: account
- department: department
- description Description: string
- displayName Display Name/Code: string
-
Enter an optional name of up to 250 characters for this item in addition to the Item Name. If you are integrating with a Yahoo! store, this field is imported from Yahoo!. The display name prints in the Item column of sales forms when Basic printing is used. If this item is a member of a kit, this name appears in the Item column when the Print Items box is checked. If you do not enter a display name, the item name appears on printed forms.
- exchangeRate: string
- expenseAccount: account
- expenseAmortizationRule: nsResource
- externalId External ID: string
- generateAccruals Generate Accruals: boolean
-
Check this box to automatically generate and post an accrual to the General Ledger.
- hierarchyVersions: nonInventoryPurchaseItem-hierarchyVersionsCollection
- id Internal ID: string
- includeChildren Include Children: boolean
-
Check the Include Children box to share the item with all the sub-subsidiaries associated with each subsidiary selected in the Subsidiary field. Note: When sharing items across subsidiaries, all of the options selected on the item record must be compatible across subsidiaries. For example, when entering an inventory item to be shared across subsidiaries, you should select Income and Asset accounts on the item record that are also shared across the same subsidiaries.
- insertItemAttribute: object
-
- id Internal identifier.: string class , department , itemid , location , issueproduct , vendorname
- refName Reference Name: string
- isFulfillable Can be Fulfilled: boolean
-
Check the Can be Fulfilled/Received box to enable this item to be received and fulfilled during order processing. Clear this box if this item does not require being received and fulfilled. Note: Once this item has been added to transactions, this setting cannot be changed. This field is used when the Advanced Billing and Advanced Shipping features are both enabled.
- isInactive Inactive: boolean
-
When you check this box, this item will no longer appear on a list unless you check the Show All box at the bottom of the list page.
- issueProduct: issueProduct
- itemId Item Name/Number: string
-
Enter up to 250 characters for the name of this item. This name appears in lists on transactions. If you have the option of entering a display name and do not, the item name prints in the Item column of sales forms when Basic printing is used. If you have the option to enter a vendor name and do not, the item name prints in the Item column of purchase forms. If you have entered a display name, it will print on purchases instead of the item name when Basic printing is used.
- itemType: object
-
- itemVendor: nonInventoryPurchaseItem-itemVendorCollection
- lastModifiedDate Last Modified: string (date-time)
- links Links: nsLink
-
nsLink - location: location
- matrixItemNameTemplate Matrix Item Name Template: string
-
This field is used to control how the matrix item will be displayed in the Matrix Item Name/Number field. Compose the order in which attributes and matrix options are displayed by selecting from the Insert Item Attribute and Insert Matrix Option dropdown lists. Add custom separator characters to easier distinguish the various options. Example: Item Name: Fabric / Color / Waist / Length [Location]
- matrixItemNameTemplateHelp Matrix Item Name Template: string
- matrixType: object
-
- id Internal identifier.: string , PARENT , CHILD
- refName Reference Name: string
- parent: nonInventoryPurchaseItem
- parentOnly Use as Category Only: boolean
- purchaseDescription Purchase Description: string
-
Enter up to 999 characters of text for a description of this item to appear on vendor orders. Include the unit of measure in this description.
- purchaseOrderAmount Vendor Bill - Purchase Order Amount Tolerance: number (float)
-
Enter the tolerance limit for the discrepancy between the amount on the vendor bill and purchase order.
- purchaseOrderQuantity Vendor Bill - Purchase Order Quantity Tolerance: number (float)
-
Enter the tolerance limit for the discrepancy between the quantity on the vendor bill and purchase order.
- purchaseOrderQuantityDiff Vendor Bill - Purchase Order Quantity Difference: number (float)
-
Enter the difference limit for the discrepancy between the quantity on the vendor bill and purchase order.
- purchaseUnit Primary Purchase Unit: string
-
Select the unit you use to purchase this item from the vendor.
- receiptAmount Vendor Bill - Item Receipt Amount Tolerance: number (float)
-
Enter the tolerance limit for the discrepancy between the amount on the vendor bill and item receipt.
- receiptQuantity Vendor Bill - Item Receipt Quantity Tolerance: number (float)
-
Enter the tolerance limit for the discrepancy between the quantity on the vendor bill and item receipt.
- receiptQuantityDiff Vendor Bill - Item Receipt Quantity Difference: number (float)
-
Enter the difference limit for the discrepancy between the quantity on the vendor bill and item receipt.
- refName Reference Name: string
- residual Residual: number (double)
-
Enter an amount or percentage to remain in the deferral account and not be amortized. A residual amount generally represents the salvage value of a fixed asset. Note: A residual amount entered on a transaction overrides a residual amount entered on an item record.
- subsidiary: subsidiaryCollection
- unitsType: unitsType
- upcCode UPC Code: string
-
Enter a maximum of 999 characters in this field to identify an internal name or number to store the item's UPC Code. You can use the text you enter here when adding the item to transactions, searching, or viewing reports. * When you enter text in this field, the SKU/UPC field on item labels displays this UPC Code and prints in UPC bar code format. * When this field is clear, the SKU/UPC field on item labels displays the Item Name/Number and prints in Code-128 bar code format.
- vendor: vendor
- vendorName Vendor Name/Code: string
-
If your vendor uses a name for this item that is different from the name you use, you can enter up to 60 characters as the vendor's name for this item here. The vendor's name for this item prints in the Item column of purchase forms. If you do not enter a vendor name, the item name prints in the Item column of purchase forms. If you have entered a display name, it will print on purchases instead of the item name.
nonInventoryPurchaseItem-accountingBookDetailCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: nonInventoryPurchaseItem-accountingBookDetailElement
-
nonInventoryPurchaseItem-accountingBookDetailElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
nonInventoryPurchaseItem-accountingBookDetailElement
This record is available as a beta record.
- accountingBook: accountingBook
- amortizationTemplate: amortizationTemplate
- createExpensePlansOn: nsResource
- createRevenuePlansOn: nsResource
- links Links: nsLink
-
nsLink - refName Reference Name: string
- revRecForecastRule: nsResource
- revRecSchedule: revRecTemplate
- revenueRecognitionRule: nsResource
- sameAsPrimaryAmortization Same as Primary Book Amortization: boolean
- sameAsPrimaryRevRec Same as Primary Book Rev Rec: boolean
nonInventoryPurchaseItem-hierarchyVersionsCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: nonInventoryPurchaseItem-hierarchyVersionsElement
-
nonInventoryPurchaseItem-hierarchyVersionsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
nonInventoryPurchaseItem-hierarchyVersionsElement
This record is available as a beta record.
- endDate Hierarchy Version End Date: string (date)
- hierarchyNode: merchandiseHierarchyNode
- hierarchyVersion: merchandiseHierarchyVersion
- isIncluded Included In Version: boolean
- links Links: nsLink
-
nsLink - refName Reference Name: string
- startDate Hierarchy Version Start Date: string (date)
nonInventoryPurchaseItem-itemVendor-itemVendorPrice
This record is available as a beta record.
- externalId External ID: string
- itemvendorpricelines: nonInventoryPurchaseItem-itemVendor-itemVendorPrice-itemvendorpricelinesCollection
- links Links: nsLink
-
nsLink - refName Reference Name: string
nonInventoryPurchaseItem-itemVendor-itemVendorPrice-itemvendorpricelinesCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: nonInventoryPurchaseItem-itemVendor-itemVendorPrice-itemvendorpricelinesElement
-
nonInventoryPurchaseItem-itemVendor-itemVendorPrice-itemvendorpricelinesElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
nonInventoryPurchaseItem-itemVendorCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: nonInventoryPurchaseItem-itemVendorElement
-
nonInventoryPurchaseItem-itemVendorElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
nonInventoryPurchaseItem-itemVendorElement
This record is available as a beta record.
- itemVendorPrice: nonInventoryPurchaseItem-itemVendor-itemVendorPrice
- links Links: nsLink
-
nsLink - predConfidence Predicted Risk Confidence: number (double)
- predictedDays Predicted Days Late/Early: integer (int64)
- preferredVendor Preferred: boolean
- purchasePrice Purchase Price: number (double)
- refName Reference Name: string
- schedule: nsResource
- subsidiary: subsidiary
- vendor: vendor
- vendorCode Code: string
- vendorCurrencyName Currency: string
nonInventoryPurchaseItemCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: nonInventoryPurchaseItem
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
nonInventoryPurchaseItem - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
nonInventoryResaleItem
This record is available as a beta record.
- VSOEDeferral: object
-
- id Internal identifier.: string DEFERALLUNTIL , DEFERUNTIL
- refName Reference Name: string
- VSOEDelivered Default as Delivered: boolean
-
Check this box to automatically set this item to a Delivered status when this item is added to a transaction. Clear this box to leave the delivery status clear by default.
- VSOEPermitDiscount: object
-
- id Internal identifier.: string IFDELIVERED , NEVER
- refName Reference Name: string
- VSOEPrice Allocation Price: number (double)
-
Enter the VSOE Price for this item if it is known. Note: If you need to use more than one VSOE price for an item, you can set the most common price here and then change the price on each order manually.
- VSOESopGroup: object
-
- id Internal identifier.: string EXCLUDE , NORMAL , SOFTWARE
- refName Reference Name: string
- accountingBookDetail: nonInventoryResaleItem-accountingBookDetailCollection
- amortizationPeriod Amortization Period: integer (int64)
-
Enter the number of periods over which the purchase amount should be amortized. For example, enter 60 to amortize the amount over 60 periods starting from the amortization start date. Note: The starting period is specified by the amortization start date on bills. If no amortization start date is specified, the posting date of the bill is the amortization start date.
- amortizationTemplate: amortizationTemplate
- autoExpandKitForRevenuemgmt Auto-Expansion for Revenue Management: boolean
- availableToPartners Available to Adv. Partners: boolean
-
Check this box to make this item available to partners with the Advanced Partner Center role for viewing. These items are also available to partners with roles that are customized for the Advanced Partner Center and include view, create or edit access to item records.
- baseUnit Primary Base Unit: string
- billExchRateVarianceAcct: account
- billPriceVarianceAcct: account
- billQtyVarianceAcct: account
- billingSchedule: billingSchedule
- class: classification
- consumptionUnit Primary Consumption Unit: string
-
If you use the Multiple Units of Measure feature, select the default unit of measure for inventory.
- contingentRevenueHandling Eligible For Contingent Revenue Handling: boolean
- copyDescription Copy from Sales Order: boolean
-
Check this box to copy the purchase description from the item description you enter on a sales order. Clear this box to enter a purchase description in the field above.
- correlatedItems: nonInventoryResaleItem-correlatedItemsCollection
- cost Purchase Price: number (double)
-
Enter the price you pay for this item. If you do not enter a price, purchase orders for this item show the most recent purchase price by default. If you select a preferred vendor for this item, the price is shown in the currency selected on the vendor's record. If no preferred vendor is selected, the price is shown in your base currency.
- costEstimate Item Defined Cost: number (double)
-
Enter an Item Defined Cost amount.
- costEstimateUnits Est. Cost Unit: string
- countryOfManufacture: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- createExpensePlansOn: nsResource
- createRevenuePlansOn: nsResource
- createdDate Date Created: string (date-time)
- currency: currency
- customForm: object
-
- id Internal identifier.: string -210 , -10211 , -10210
- refName Reference Name: string
- defaultItemShipMethod: shipItem
- deferralAccount: account
- deferredRevenueAccount: account
- department: department
- description Description: string
- directRevenuePosting Direct Revenue Posting: boolean
-
Check this box to disable advanced revenue management for this item. When checked, posting transactions that include this item post directly to the item revenue account. No revenue element or revenue arrangement is created. When you check this box, the Deferred Revenue Account on the Accounting subtab is disabled. When you create sales transactions that include items that have this box checked, all the items in the transaction must have the box checked. You cannot mix items that post directly to revenue with items that post to deferred revenue in the same transaction. This restriction also applies to kit items. All items in a kit must post either to revenue or to deferred revenue. You cannot check or clear the box after the item has been used in a transaction with advanced revenue management. By default, this box is not checked.
- displayName Display Name/Code: string
-
Enter an optional name of up to 250 characters for this item in addition to the Item Name. If you are integrating with a Yahoo! store, this field is imported from Yahoo!. The display name prints in the Item column of sales forms when Basic printing is used. If this item is a member of a kit, this name appears in the Item column when the Print Items box is checked. If you do not enter a display name, the item name appears on printed forms.
- dontShowPrice Don't Show Price: boolean
-
Check this box to hide the price of this item online. This is useful for items you want to advertise but don't want to sell or for items that you track inventory for and want to display but are offered in combination with other items.
- dropShipExpenseAccount: account
- enforceminqtyinternally Enforce Minimum Internally: boolean
-
Check this box to apply the minimum quantity restriction on sales orders generated from NetSuite. When you clear this box, but enter a number in the Minimum Quantity field, the minimum quantity is only applied to web store orders.
- exchangeRate: string
- excludeFromSiteMap Exclude from Sitemap: boolean
-
Check this box to exclude a tab, category or item page from the site map.
- expenseAccount: account
- expenseAmortizationRule: nsResource
- externalId External ID: string
- featuredDescription Featured Description: string
-
If this item is displayed on the home page of your Web site, enter a featured description for this item. This description appears below the item's store display name on the Home page of your store or site. You can enter up to 999 characters including basic HTML code. Enter and format text using the formatting options, or click the HTML Source Code link to enter HTML.
- froogleProductFeed Google Base Product Feed: boolean
- generateAccruals Generate Accruals: boolean
-
Check this box to automatically generate and post an accrual to the General Ledger.
- handlingCost Handling Cost: number (double)
-
As an option, you may enter a handling cost for this item in dollars. You must also create a shipping item for per-item shipping and handling costs at Lists > Shipping Items > New. When this item is selected on sales orders, invoices or cash sales, the appropriate shipping and handling charges are automatically calculated.
- hazmatHazardClass Hazmat Hazard Class: string
-
Enter the DOT hazardous material class or division.
- hazmatId Hazmat Id: string
-
Enter the regulatory identifier for the commodity from the Federal Express Ground Hazardous Materials Shipping Guide. The format is UNXXXX, where XXXX is a four digit number.
- hazmatItemUnits Hazmat Item Units: string
-
Enter the unit of measure for this item, such as kg or ml.
- hazmatItemUnitsQty Hazmat Item Units Quantity: number (float)
-
Enter the quantity for the item units.
- hazmatPackingGroup: object
-
- id Internal identifier.: string , DEFAULT , I , II , III
- refName Reference Name: string
- hazmatShippingName Hazmat Shipping Name: string
-
Enter the shipping name for the ID as listed in the Federal Express Ground Hazardous Materials Shipping Guide. This item appears on the OP950 form.
- hierarchyVersions: nonInventoryResaleItem-hierarchyVersionsCollection
- id Internal ID: string
- includeChildren Include Children: boolean
-
Check the Include Children box to share the item with all the sub-subsidiaries associated with each subsidiary selected in the Subsidiary field. Note: When sharing items across subsidiaries, all of the options selected on the item record must be compatible across subsidiaries. For example, when entering an inventory item to be shared across subsidiaries, you should select Income and Asset accounts on the item record that are also shared across the same subsidiaries.
- incomeAccount: account
- insertItemAttribute: object
-
- id Internal identifier.: string class , department , itemid , location , issueproduct , vendorname
- refName Reference Name: string
- interCoDefRevAccount: account
- intercoExpenseAccount: account
- intercoIncomeAccount: account
- internalId Internal ID: integer (int64)
- isDropShipItem Drop Ship Item: boolean
-
Check the Drop Ship Item box to have this item default as a drop ship item on sales orders. When a sales transaction for a drop ship item is approved, a linked purchase order for the preferred vendor is automatically generated. The vendor ships this item to your customer directly. Note: an item can be a drop ship or a special order, but not both.
- isFulfillable Can be Fulfilled: boolean
-
Check the Can be Fulfilled/Received box to enable this item to be received and fulfilled during order processing. Clear this box if this item does not require being received and fulfilled. Note: Once this item has been added to transactions, this setting cannot be changed. This field is used when the Advanced Billing and Advanced Shipping features are both enabled.
- isGCoCompliant Google Checkout Compliant: boolean
- isHazmatItem Hazmat/Dangerous Goods: boolean
-
Check this box if this item is categorized as either hazardous material or dangerous goods. These items can only be shipped using FedEx integration.
- isInactive Inactive: boolean
-
When you check this box, this item will no longer appear on a list unless you check the Show All box at the bottom of the list page.
- isOnline Display in Website: boolean
-
Check this box to make this item available online in your Web site. You cannot sell this item online unless you check this box. If the item is of the Other Charge for Sale or Resale subtype, checking this box does not make it available in the web store catalog. However, it becomes available during web store checkout.
- isSpecialOrderItem Special Order Item: boolean
-
Check this box if you want this item to default as a special order on sales transactions. When a sales transaction for a special order item is approved, a linked purchase order is automatically generated. Then, the order cannot be fulfilled until the linked purchase order is received. Special order items can be used for custom orders or "just-in-time" inventory. Important: You must identify a preferred vendor and a purchase price on an item record in order for that item to be selected as a special order. Note: An item can be a drop ship or a special order, but not both.
- issueProduct: issueProduct
- itemCarrier: object
-
- id Internal identifier.: string ups , nonups
- refName Reference Name: string
- itemId Item Name/Number: string
-
Enter up to 250 characters for the name of this item. This name appears in lists on transactions. If you have the option of entering a display name and do not, the item name prints in the Item column of sales forms when Basic printing is used. If you have the option to enter a vendor name and do not, the item name prints in the Item column of purchase forms. If you have entered a display name, it will print on purchases instead of the item name when Basic printing is used.
- itemRevenueCategory: nsResource
- itemShipMethod: shipItemCollection
- itemType: object
-
- itemVendor: nonInventoryResaleItem-itemVendorCollection
- lastModifiedDate Last Modified: string (date-time)
- links Links: nsLink
-
nsLink - location: location
- manufacturer Manufacturer: string
-
Enter the name of the company that manufactures this item.
- manufacturerAddr1 Manufacturer Address: string
-
Enter the address of the manufacturer. This is necessary to fill out international shipping forms when you sell and ship this item.
- manufacturerCity Manufacturer City: string
-
Enter the city location of the manufacturer of this item. This is necessary to automatically fill out international forms when you ship this item across borders.
- manufacturerState Manufacturer State: string
-
Enter the state where this item's manufacturer is located. This is necessary to fill out international forms when you ship this item.
- manufacturerTariff HS Tariff Number: string
-
Enter the Harmonized System (HS) tariff code number or the Harmonized Tariff Schedule (HTS) code number. This number should be six to ten characters.
- manufacturerTaxId Manufacturer Tax Id: string
-
Enter the Tax ID Number (TIN) for the manufacturer.
- manufacturerZip Manufacturer Zip Code: string
-
Enter the postal code of the location of this manufacturer. This is necessary to create international forms when you ship this item.
- matrixItemNameTemplate Matrix Item Name Template: string
-
This field is used to control how the matrix item will be displayed in the Matrix Item Name/Number field. Compose the order in which attributes and matrix options are displayed by selecting from the Insert Item Attribute and Insert Matrix Option dropdown lists. Add custom separator characters to easier distinguish the various options. Example: Item Name: Fabric / Color / Waist / Length [Location]
- matrixItemNameTemplateHelp Matrix Item Name Template: string
- matrixType: object
-
- id Internal identifier.: string , PARENT , CHILD
- refName Reference Name: string
- maximumquantity Maximum Order Qty: integer (int64)
-
Enter the greatest quantity of this item that customers can purchase. If customers enter an item quantity above the maximum amount, a warning message is displayed. Web store customers are unable to complete checkout unless they enter a quantity equal to or below the maximum quantity. Leave this field empty to allow customers to check out without maximum quantity restrictions. You can edit this warning at Setup > Site Builder/SuiteCommerce Advanced > Customize Text.
- metaTagHtml Meta Tag HTML: string
-
Enter the Meta Tag HTML you want to appear in the < head > section of this item page. Meta tags enable your Web site to be found by search engines.
- minimumquantity Minimum Order Qty: integer (int64)
-
Enter the lowest quantity that customers can purchase. Web store customers receive a warning and cannot check out if they enter an item quantity below this minimum. Leave this field empty to allow customers to check out with no minimum quantity restrictions. You can edit this warning at Setup > Site Builder/SuiteCommerce Advanced > Customize Text.
- mpn Manufacturer Part Number: string
-
MPN (Manufacturers Part Number) - Enter the part number used by the manufacturer to identify this item.
- multManufactureAddr Multiple Manufacturer Addresses: boolean
-
Check the Multiple Manufacture Addresses box if this manufacturer uses more than one address.
- nexTagCategory NexTag Category: string
-
Enter the name of the NexTag category this item should be included in. This category is included in the product feeds you can export at Setup > Web Site > Product Feeds.
- nexTagProductFeed NexTag Product Feed: boolean
- noPriceMessage No Price Message: string
-
If you opted to not show a price online, enter the message that should show instead of the price. For example, you might enter "Call for Price."
- offerSupport Offer Support: boolean
-
Check this box to offer support for this particular item. By offering support for items, customers can select on case records which item they are having trouble with.
- onSpecial On Special: boolean
-
If you want to put this item on special, check this box. The item then appears in the Specials category in your store or site.
- outOfStockBehavior: object
-
- id Internal identifier.: string DISABLE , ENABLENMSG , REMOVE , ENABLE , DEFAULT
- refName Reference Name: string
- outOfStockMessage Out Of Stock Message: string
-
You can enter a custom out of stock message for this item. The message here replaces the default out of stock message.
- overallQuantityPricingType: object
-
- id Internal identifier.: string ITEM , PARENT , SCHEDULE
- refName Reference Name: string
- pageTitle Page Title: string
-
Enter the text you want to appear as the page's title for this item. This text appears in the browser tab. Use a descriptive title for the item page, this can help achieve better results with search engine ranking.
- parent: nonInventoryResaleItem
- parentOnly Use as Category Only: boolean
- preferenceCriterion: object
-
- id Internal identifier.: string , A , B , C , D , E , F
- refName Reference Name: string
- presentationItem: nonInventoryResaleItem-presentationItemCollection
- price: nonInventoryResaleItem-price
- pricesIncludeTax Prices Include Tax: boolean
-
Check this box to save the base price as the tax inclusive price. Clear this box to save the base price as the tax exclusive price.
- pricingGroup: pricingGroup
- purchaseDescription Purchase Description: string
-
Enter up to 999 characters of text for a description of this item to appear on vendor orders. Include the unit of measure in this description.
- purchaseOrderAmount Vendor Bill - Purchase Order Amount Tolerance: number (float)
-
Enter the tolerance limit for the discrepancy between the amount on the vendor bill and purchase order.
- purchaseOrderQuantity Vendor Bill - Purchase Order Quantity Tolerance: number (float)
-
Enter the tolerance limit for the discrepancy between the quantity on the vendor bill and purchase order.
- purchaseOrderQuantityDiff Vendor Bill - Purchase Order Quantity Difference: number (float)
-
Enter the difference limit for the discrepancy between the quantity on the vendor bill and purchase order.
- purchaseUnit Primary Purchase Unit: string
-
Select the unit you use to purchase this item from the vendor.
- quantityPricingSchedule: nsResource
- rate Price: number (double)
-
Enter the rate for this discount or markup. The rate can be either a percentage or dollar amount. A percentage discount must be followed by a % sign. A dollar amount should be entered as a positive number.
- rateIncludingTax Price Including Tax: number (double)
- receiptAmount Vendor Bill - Item Receipt Amount Tolerance: number (float)
-
Enter the tolerance limit for the discrepancy between the amount on the vendor bill and item receipt.
- receiptQuantity Vendor Bill - Item Receipt Quantity Tolerance: number (float)
-
Enter the tolerance limit for the discrepancy between the quantity on the vendor bill and item receipt.
- receiptQuantityDiff Vendor Bill - Item Receipt Quantity Difference: number (float)
-
Enter the difference limit for the discrepancy between the quantity on the vendor bill and item receipt.
- refName Reference Name: string
- residual Residual: number (double)
-
Enter an amount or percentage to remain in the deferral account and not be amortized. A residual amount generally represents the salvage value of a fixed asset. Note: A residual amount entered on a transaction overrides a residual amount entered on an item record.
- revRecForecastRule: nsResource
- revReclassFxAccount: account
- revenueAllocationGroup: nsResource
- revenueRecognitionRule: nsResource
- saleUnit Primary Sale Unit: string
-
Select the unit you use to sell this item to customers on sales transactions.
- salesDescription Sales Description: string
-
Enter a sales description for this item. You can enter letters and numbers. There is a 999 character limit. The sales description displays on transactions such as sales orders, cash sales and invoices. If you use the Web Store feature, the sales description displays immediately under the item's store display name on item list pages in your store or site, if you have not entered a store description for an item. Enter the store description on the Store subtab of the item record. The sales description also displays by default when the item is in the Web store shopping cart.
- scheduleBCode: object
-
- scheduleBNumber Schedule B Number: string
-
Enter the number for the Schedule B form for this item.
- scheduleBQuantity Schedule B Quantity: number (float)
-
Enter the numeric quantity in relation to the unit of measure entered in the Schedule B Code field. These two fields are used together to determine the amount represented by one of this item on the Schedule B form for Shipping Export Declarations. For example, if you enter 5 in the Schedule B Quantity field, and you select kilogram in the Schedule B Code field, when you fulfill two of these items on an order, the Schedule B form presents the items’ amount as 10 kilograms.
- searchKeywords Search Keywords: string
-
Enter alternative search keywords that customers might use to find this item using your Web store’s internal search. These can include synonyms, acronyms, alternate languages or misspellings. These keywords are seen as equally important as the item name when searches are conducted.
- shipIndividually Ships Individually: boolean
-
Check this box if this item always ships alone and with no other items in the same package. This helps determine the number of packages needed and the shipping rate on order fulfillments.
- shipPackage: nsResource
- shippingCost Shipping Cost: number (double)
-
As an option, you may enter a shipping cost for this item in dollars. You must also create a shipping item for per-item shipping costs at Lists > Shipping Items > New. When this item is selected on sales orders, invoices or cash sales, the appropriate shipping charges are automatically calculated.
- shoppingDotComCategory Shopping.com Category: string
-
Enter the name of the Shopping.com category that this item should go under. This category is included in the product feeds that you can export from Setup > Web Site > Product Feeds. Go to www.shopping.com for more information on the categories available. This is an optional field only available for following item records: Kit/Package, Non-inventory Item for Sale, Non-inventory Item for Resale, Assembly (lot and serialized), and Inventory (lot and serialized).
- shoppingProductFeed Shopping Product Feed: boolean
- shopzillaCategoryId Shopzilla Category ID: integer (int64)
-
Enter the name of the Shopzilla category this item should be included in. This category is included in the product feeds you export at Setup > Web Site > Product Feeds. Go to www.shopzilla.com for more information on the available categories. This is an optional field only displayed for the following item records: Kit/Package, Non-inventory Item for Sale, Non-inventory Item for Resale, Assembly (lot and serialized), and Inventory (lot and serialized).
- shopzillaProductFeed Shopzilla Product Feed: boolean
- siteCategory: nonInventoryResaleItem-siteCategoryCollection
- siteMapPriority: object
-
- stockDescription Stock Description: string
-
Enter up to 21 characters to specify information about this item, such as New, Refurbished or Ships 2-3 days.
- storeDescription Store Description: string
-
The store description appears under the item's store display name on item list pages in your store or site. You can enter letters, numbers, and basic HTML code. Note: To make the store description display when an item is in the Web store shopping cart, go to Setup > Web Site > Set Up Web Site. Click the Cart subtab, and check the box next to Store Description.
- storeDetailedDescription Detailed Description: string
-
Enter a detailed description for this item. When your customers click an item's store display name for more information, they see this description. You can enter letters, numbers or basic HTML code. If you are using Internet Explorer, you can also clear the View Source box below to enter and format text using the formatting options above. This eliminates the need for HTML code. If you do not see the View Source box, make sure Rich Text Editing is enabled at Home > Set Preferences > Appearance.
- storeDisplayImage: nsResource
- storeDisplayName Store Display Name: string
-
Enter the name of this item as you want it displayed in your Web site. You can enter up to 250 characters.
- storeDisplayThumbnail: nsResource
- subsidiary: subsidiaryCollection
- unitsType: unitsType
- upcCode UPC Code: string
-
Enter a maximum of 999 characters in this field to identify an internal name or number to store the item's UPC Code. You can use the text you enter here when adding the item to transactions, searching, or viewing reports. * When you enter text in this field, the SKU/UPC field on item labels displays this UPC Code and prints in UPC bar code format. * When this field is clear, the SKU/UPC field on item labels displays the Item Name/Number and prints in Code-128 bar code format.
- urlComponent URL Component: string
-
Enter a short, descriptive name for this item to appear as part of its URL in the Web store. Setting a name to show in the URL can result in better ranking from search engines. If you leave this field blank, NetSuite terms and numbers are used as identifiers in the URL. Note: Descriptive URL components are case sensitive. Descriptive URLs must match the case used in the URL Component field of an item record to point to the correct page.
- useMarginalRates Use Marginal Rates: boolean
-
Check this box if you want the quantity discounts in the schedule to be applied to each pricing bracket separately. For example, a schedule offers no discount for the first 100 items sold and a 5% discount if more than 100 are sold. If 150 items are sold, the first 100 are at normal price, and the other fifty items are sold at 5% discount. Leave this box clear if you want the discount to apply to all of the items sold.
- vendor: vendor
- vendorName Vendor Name/Code: string
-
If your vendor uses a name for this item that is different from the name you use, you can enter up to 60 characters as the vendor's name for this item here. The vendor's name for this item prints in the Item column of purchase forms. If you do not enter a vendor name, the item name prints in the Item column of purchase forms. If you have entered a display name, it will print on purchases instead of the item name.
- weight Item Weight : number (float)
-
Enter the weight of this item and select the units in the dropdown.
- weightUnit: object
-
- id Internal identifier.: string 1 , 2 , 3 , 4
- refName Reference Name: string
- weightUnits Weight Units: string
- yahooProductFeed Yahoo Shopping Product Feed: boolean
nonInventoryResaleItem-accountingBookDetailCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: nonInventoryResaleItem-accountingBookDetailElement
-
nonInventoryResaleItem-accountingBookDetailElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
nonInventoryResaleItem-accountingBookDetailElement
This record is available as a beta record.
- accountingBook: accountingBook
- amortizationTemplate: amortizationTemplate
- createExpensePlansOn: nsResource
- createRevenuePlansOn: nsResource
- links Links: nsLink
-
nsLink - refName Reference Name: string
- revRecForecastRule: nsResource
- revRecSchedule: revRecTemplate
- revenueRecognitionRule: nsResource
- sameAsPrimaryAmortization Same as Primary Book Amortization: boolean
- sameAsPrimaryRevRec Same as Primary Book Rev Rec: boolean
nonInventoryResaleItem-hierarchyVersionsCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: nonInventoryResaleItem-hierarchyVersionsElement
-
nonInventoryResaleItem-hierarchyVersionsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
nonInventoryResaleItem-hierarchyVersionsElement
This record is available as a beta record.
- endDate Hierarchy Version End Date: string (date)
- hierarchyNode: merchandiseHierarchyNode
- hierarchyVersion: merchandiseHierarchyVersion
- isIncluded Included In Version: boolean
- links Links: nsLink
-
nsLink - refName Reference Name: string
- startDate Hierarchy Version Start Date: string (date)
nonInventoryResaleItem-itemVendor-itemVendorPrice
This record is available as a beta record.
- externalId External ID: string
- itemvendorpricelines: nonInventoryResaleItem-itemVendor-itemVendorPrice-itemvendorpricelinesCollection
- links Links: nsLink
-
nsLink - refName Reference Name: string
nonInventoryResaleItem-itemVendor-itemVendorPrice-itemvendorpricelinesCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: nonInventoryResaleItem-itemVendor-itemVendorPrice-itemvendorpricelinesElement
-
nonInventoryResaleItem-itemVendor-itemVendorPrice-itemvendorpricelinesElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
nonInventoryResaleItem-itemVendorCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: nonInventoryResaleItem-itemVendorElement
-
nonInventoryResaleItem-itemVendorElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
nonInventoryResaleItem-itemVendorElement
This record is available as a beta record.
- itemVendorPrice: nonInventoryResaleItem-itemVendor-itemVendorPrice
- links Links: nsLink
-
nsLink - predConfidence Predicted Risk Confidence: number (double)
- predictedDays Predicted Days Late/Early: integer (int64)
- preferredVendor Preferred: boolean
- purchasePrice Purchase Price: number (double)
- refName Reference Name: string
- schedule: nsResource
- subsidiary: subsidiary
- vendor: vendor
- vendorCode Code: string
- vendorCurrencyName Currency: string
nonInventoryResaleItem-presentationItemCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: nonInventoryResaleItem-presentationItemElement
-
nonInventoryResaleItem-presentationItemElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
nonInventoryResaleItem-price
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: nonInventoryResaleItem-priceElement
-
nonInventoryResaleItem-priceElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
nonInventoryResaleItem-priceElement
This record is available as a beta record.
- currencyPage: currency
- discountDisplay Default Discount %: number (double)
- isInactive Inactive: boolean
-
When you check this box, this item will no longer appear on a list unless you check the Show All box at the bottom of the list page.
- links Links: nsLink
-
nsLink - price Amount: number (double)
- priceLevel: priceLevel
- priceLevelName Price Level: string
- priceQty Sequence Number: integer (int64)
- quantity: object
-
- value Value: string
- refName Reference Name: string
nonInventoryResaleItem-siteCategoryCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: nonInventoryResaleItem-siteCategoryElement
-
nonInventoryResaleItem-siteCategoryElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
nonInventoryResaleItem-siteCategoryElement
This record is available as a beta record.
- category: nsResource
- links Links: nsLink
-
nsLink - refName Reference Name: string
- webSite: webSite
nonInventoryResaleItemCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: nonInventoryResaleItem
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
nonInventoryResaleItem - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
nonInventorySaleItem
- VSOEDeferral: object
-
- id Internal identifier.: string DEFERALLUNTIL , DEFERUNTIL
- refName Reference Name: string
- VSOEDelivered Default as Delivered: boolean
-
Check this box to automatically set this item to a Delivered status when this item is added to a transaction. Clear this box to leave the delivery status clear by default.
- VSOEPermitDiscount: object
-
- id Internal identifier.: string IFDELIVERED , NEVER
- refName Reference Name: string
- VSOEPrice Allocation Price: number (double)
-
Enter the VSOE Price for this item if it is known. Note: If you need to use more than one VSOE price for an item, you can set the most common price here and then change the price on each order manually.
- VSOESopGroup: object
-
- id Internal identifier.: string EXCLUDE , NORMAL , SOFTWARE
- refName Reference Name: string
- accountingBookDetail: nonInventorySaleItem-accountingBookDetailCollection
- amortizationPeriod Amortization Period: integer (int64)
- amortizationTemplate: amortizationTemplate
- autoExpandKitForRevenuemgmt Auto-Expansion for Revenue Management: boolean
- availableToPartners Available to Adv. Partners: boolean
-
Check this box to make this item available to partners with the Advanced Partner Center role for viewing. These items are also available to partners with roles that are customized for the Advanced Partner Center and include view, create or edit access to item records.
- baseUnit Primary Base Unit: string
- billExchRateVarianceAcct: account
- billPriceVarianceAcct: account
- billQtyVarianceAcct: account
- billingSchedule: billingSchedule
- class: classification
- consumptionUnit Primary Consumption Unit: string
-
If you use the Multiple Units of Measure feature, select the default unit of measure for inventory.
- contingentRevenueHandling Eligible For Contingent Revenue Handling: boolean
-
Check this box to indicate that the item is subject to contingent revenue handling. When checked, revenue allocation is affected.
- correlatedItems: nonInventorySaleItem-correlatedItemsCollection
- costEstimate Item Defined Cost: number (double)
-
Enter an Item Defined Cost amount.
- costEstimateUnits Est. Cost Unit: string
- countryOfManufacture: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- createExpensePlansOn: nsResource
- createRevenuePlansOn: nsResource
- createdDate Date Created: string (date-time)
- customForm: object
-
- id Internal identifier.: string -210 , -10211 , -10210
- refName Reference Name: string
- defaultItemShipMethod: shipItem
- deferralAccount: account
- deferredRevenueAccount: account
- department: department
- description Description: string
- directRevenuePosting Direct Revenue Posting: boolean
-
Check this box to disable advanced revenue management for this item. When checked, posting transactions that include this item post directly to the item revenue account. No revenue element or revenue arrangement is created. When you check this box, the Deferred Revenue Account on the Accounting subtab is disabled. When you create sales transactions that include items that have this box checked, all the items in the transaction must have the box checked. You cannot mix items that post directly to revenue with items that post to deferred revenue in the same transaction. This restriction also applies to kit items. All items in a kit must post either to revenue or to deferred revenue. You cannot check or clear the box after the item has been used in a transaction with advanced revenue management. By default, this box is not checked.
- displayName Display Name/Code: string
-
Enter an optional name of up to 250 characters for this item in addition to the Item Name. If you are integrating with a Yahoo! store, this field is imported from Yahoo!. The display name prints in the Item column of sales forms when Basic printing is used. If this item is a member of a kit, this name appears in the Item column when the Print Items box is checked. If you do not enter a display name, the item name appears on printed forms.
- dontShowPrice Don't Show Price: boolean
-
Check this box to hide the price of this item online. This is useful for items you want to advertise but don't want to sell or for items that you track inventory for and want to display but are offered in combination with other items.
- enforceminqtyinternally Enforce Minimum Internally: boolean
-
Check this box to apply the minimum quantity restriction on sales orders generated from NetSuite. When you clear this box, but enter a number in the Minimum Quantity field, the minimum quantity is only applied to web store orders.
- excludeFromSiteMap Exclude from Sitemap: boolean
-
Check this box to exclude a tab, category or item page from the site map.
- expenseAmortizationRule: nsResource
- externalId External ID: string
- featuredDescription Featured Description: string
-
If this item is displayed on the home page of your Web site, enter a featured description for this item. This description appears below the item's store display name on the Home page of your store or site. You can enter up to 999 characters including basic HTML code. Enter and format text using the formatting options, or click the HTML Source Code link to enter HTML.
- froogleProductFeed Google Base Product Feed: boolean
- handlingCost Handling Cost: number (double)
-
As an option, you may enter a handling cost for this item in dollars. You must also create a shipping item for per-item shipping and handling costs at Lists > Shipping Items > New. When this item is selected on sales orders, invoices or cash sales, the appropriate shipping and handling charges are automatically calculated.
- hazmatHazardClass Hazmat Hazard Class: string
-
Enter the DOT hazardous material class or division.
- hazmatId Hazmat Id: string
-
Enter the regulatory identifier for the commodity from the Federal Express Ground Hazardous Materials Shipping Guide. The format is UNXXXX, where XXXX is a four digit number.
- hazmatItemUnits Hazmat Item Units: string
-
Enter the unit of measure for this item, such as kg or ml.
- hazmatItemUnitsQty Hazmat Item Units Quantity: number (float)
-
Enter the quantity for the item units.
- hazmatPackingGroup: object
-
- id Internal identifier.: string , DEFAULT , I , II , III
- refName Reference Name: string
- hazmatShippingName Hazmat Shipping Name: string
-
Enter the shipping name for the ID as listed in the Federal Express Ground Hazardous Materials Shipping Guide. This item appears on the OP950 form.
- hierarchyVersions: nonInventorySaleItem-hierarchyVersionsCollection
- id Internal ID: string
- includeChildren Include Children: boolean
-
Check the Include Children box to share the item with all the sub-subsidiaries associated with each subsidiary selected in the Subsidiary field. Note: When sharing items across subsidiaries, all of the options selected on the item record must be compatible across subsidiaries. For example, when entering an inventory item to be shared across subsidiaries, you should select Income and Asset accounts on the item record that are also shared across the same subsidiaries.
- incomeAccount: account
- insertItemAttribute: object
-
- id Internal identifier.: string class , department , itemid , location , issueproduct , vendorname
- refName Reference Name: string
- internalId Internal ID: integer (int64)
- isFulfillable Can be Fulfilled: boolean
-
Check the Can be Fulfilled/Received box to enable this item to be received and fulfilled during order processing. Clear this box if this item does not require being received and fulfilled. Note: Once this item has been added to transactions, this setting cannot be changed. This field is used when the Advanced Billing and Advanced Shipping features are both enabled.
- isGCoCompliant Google Checkout Compliant: boolean
- isHazmatItem Hazmat/Dangerous Goods: boolean
-
Check this box if this item is categorized as either hazardous material or dangerous goods. These items can only be shipped using FedEx integration.
- isInactive Inactive: boolean
-
When you check this box, this item will no longer appear on a list unless you check the Show All box at the bottom of the list page.
- isOnline Display in Website: boolean
-
Check this box to make this item available online in your Web site. You cannot sell this item online unless you check this box. If the item is of the Other Charge for Sale or Resale subtype, checking this box does not make it available in the web store catalog. However, it becomes available during web store checkout.
- issueProduct: issueProduct
- itemCarrier: object
-
- id Internal identifier.: string ups , nonups
- refName Reference Name: string
- itemId Item Name/Number: string
-
Enter up to 250 characters for the name of this item. This name appears in lists on transactions. If you have the option of entering a display name and do not, the item name prints in the Item column of sales forms when Basic printing is used. If you have the option to enter a vendor name and do not, the item name prints in the Item column of purchase forms. If you have entered a display name, it will print on purchases instead of the item name when Basic printing is used.
- itemRevenueCategory: nsResource
- itemShipMethod: shipItemCollection
- itemType: object
-
- lastModifiedDate Last Modified: string (date-time)
- links Links: nsLink
-
nsLink - location: location
- manufacturer Manufacturer: string
-
Enter the name of the company that manufactures this item.
- manufacturerAddr1 Manufacturer Address: string
-
Enter the address of the manufacturer. This is necessary to fill out international shipping forms when you sell and ship this item.
- manufacturerCity Manufacturer City: string
-
Enter the city location of the manufacturer of this item. This is necessary to automatically fill out international forms when you ship this item across borders.
- manufacturerState Manufacturer State: string
-
Enter the state where this item's manufacturer is located. This is necessary to fill out international forms when you ship this item.
- manufacturerTariff HS Tariff Number: string
-
Enter the Harmonized System (HS) tariff code number or the Harmonized Tariff Schedule (HTS) code number. This number should be six to ten characters.
- manufacturerTaxId Manufacturer Tax Id: string
-
Enter the Tax ID Number (TIN) for the manufacturer.
- manufacturerZip Manufacturer Zip Code: string
-
Enter the postal code of the location of this manufacturer. This is necessary to create international forms when you ship this item.
- matrixItemNameTemplate Matrix Item Name Template: string
-
This field is used to control how the matrix item will be displayed in the Matrix Item Name/Number field. Compose the order in which attributes and matrix options are displayed by selecting from the Insert Item Attribute and Insert Matrix Option dropdown lists. Add custom separator characters to easier distinguish the various options. Example: Item Name: Fabric / Color / Waist / Length [Location]
- matrixItemNameTemplateHelp Matrix Item Name Template: string
- matrixType: object
-
- id Internal identifier.: string , PARENT , CHILD
- refName Reference Name: string
- maximumquantity Maximum Order Qty: integer (int64)
-
Enter the greatest quantity of this item that customers can purchase. If customers enter an item quantity above the maximum amount, a warning message is displayed. Web store customers are unable to complete checkout unless they enter a quantity equal to or below the maximum quantity. Leave this field empty to allow customers to check out without maximum quantity restrictions. You can edit this warning at Setup > Site Builder/SuiteCommerce Advanced > Customize Text.
- metaTagHtml Meta Tag HTML: string
-
Enter the Meta Tag HTML you want to appear in the < head > section of this item page. Meta tags enable your Web site to be found by search engines.
- minimumquantity Minimum Order Qty: integer (int64)
-
Enter the lowest quantity that customers can purchase. Web store customers receive a warning and cannot check out if they enter an item quantity below this minimum. Leave this field empty to allow customers to check out with no minimum quantity restrictions. You can edit this warning at Setup > Site Builder/SuiteCommerce Advanced > Customize Text.
- mpn Manufacturer Part Number: string
-
MPN (Manufacturers Part Number) - Enter the part number used by the manufacturer to identify this item.
- multManufactureAddr Multiple Manufacturer Addresses: boolean
-
Check the Multiple Manufacture Addresses box if this manufacturer uses more than one address.
- nexTagCategory NexTag Category: string
-
Enter the name of the NexTag category this item should be included in. This category is included in the product feeds you can export at Setup > Web Site > Product Feeds.
- nexTagProductFeed NexTag Product Feed: boolean
- noPriceMessage No Price Message: string
-
If you opted to not show a price online, enter the message that should show instead of the price. For example, you might enter "Call for Price."
- offerSupport Offer Support: boolean
-
Check this box to offer support for this particular item. By offering support for items, customers can select on case records which item they are having trouble with.
- onSpecial On Special: boolean
-
If you want to put this item on special, check this box. The item then appears in the Specials category in your store or site.
- outOfStockBehavior: object
-
- id Internal identifier.: string DISABLE , ENABLENMSG , REMOVE , ENABLE , DEFAULT
- refName Reference Name: string
- outOfStockMessage Out Of Stock Message: string
-
You can enter a custom out of stock message for this item. The message here replaces the default out of stock message.
- overallQuantityPricingType: object
-
- id Internal identifier.: string ITEM , PARENT , SCHEDULE
- refName Reference Name: string
- pageTitle Page Title: string
-
Enter the text you want to appear as the page's title for this item. This text appears in the browser tab. Use a descriptive title for the item page, this can help achieve better results with search engine ranking.
- parent: nonInventorySaleItem
- parentOnly Use as Category Only: boolean
- preferenceCriterion: object
-
- id Internal identifier.: string , A , B , C , D , E , F
- refName Reference Name: string
- presentationItem: nonInventorySaleItem-presentationItemCollection
- price: nonInventorySaleItem-price
- pricesIncludeTax Prices Include Tax: boolean
-
Check this box to save the base price as the tax inclusive price. Clear this box to save the base price as the tax exclusive price.
- pricingGroup: pricingGroup
- quantityPricingSchedule: nsResource
- rate Price: number (double)
-
Enter the rate for this discount or markup. The rate can be either a percentage or dollar amount. A percentage discount must be followed by a % sign. A dollar amount should be entered as a positive number.
- rateIncludingTax Price Including Tax: number (double)
- refName Reference Name: string
- residual Residual: number (double)
- revRecForecastRule: nsResource
- revReclassFxAccount: account
- revenueAllocationGroup: nsResource
- revenueRecognitionRule: nsResource
- saleUnit Primary Sale Unit: string
-
Select the unit you use to sell this item to customers on sales transactions.
- salesDescription Sales Description: string
-
Enter a sales description for this item. You can enter letters and numbers. There is a 999 character limit. The sales description displays on transactions such as sales orders, cash sales and invoices. If you use the Web Store feature, the sales description displays immediately under the item's store display name on item list pages in your store or site, if you have not entered a store description for an item. Enter the store description on the Store subtab of the item record. The sales description also displays by default when the item is in the Web store shopping cart.
- scheduleBCode: object
-
- scheduleBNumber Schedule B Number: string
-
Enter the number for the Schedule B form for this item.
- scheduleBQuantity Schedule B Quantity: number (float)
-
Enter the numeric quantity in relation to the unit of measure entered in the Schedule B Code field. These two fields are used together to determine the amount represented by one of this item on the Schedule B form for Shipping Export Declarations. For example, if you enter 5 in the Schedule B Quantity field, and you select kilogram in the Schedule B Code field, when you fulfill two of these items on an order, the Schedule B form presents the items’ amount as 10 kilograms.
- searchKeywords Search Keywords: string
-
Enter alternative search keywords that customers might use to find this item using your Web store’s internal search. These can include synonyms, acronyms, alternate languages or misspellings. These keywords are seen as equally important as the item name when searches are conducted.
- shipIndividually Ships Individually: boolean
-
Check this box if this item always ships alone and with no other items in the same package. This helps determine the number of packages needed and the shipping rate on order fulfillments.
- shipPackage: nsResource
- shippingCost Shipping Cost: number (double)
-
As an option, you may enter a shipping cost for this item in dollars. You must also create a shipping item for per-item shipping costs at Lists > Shipping Items > New. When this item is selected on sales orders, invoices or cash sales, the appropriate shipping charges are automatically calculated.
- shoppingDotComCategory Shopping.com Category: string
-
Enter the name of the Shopping.com category that this item should go under. This category is included in the product feeds that you can export from Setup > Web Site > Product Feeds. Go to www.shopping.com for more information on the categories available. This is an optional field only available for following item records: Kit/Package, Non-inventory Item for Sale, Non-inventory Item for Resale, Assembly (lot and serialized), and Inventory (lot and serialized).
- shoppingProductFeed Shopping Product Feed: boolean
- shopzillaCategoryId Shopzilla Category ID: integer (int64)
-
Enter the name of the Shopzilla category this item should be included in. This category is included in the product feeds you export at Setup > Web Site > Product Feeds. Go to www.shopzilla.com for more information on the available categories. This is an optional field only displayed for the following item records: Kit/Package, Non-inventory Item for Sale, Non-inventory Item for Resale, Assembly (lot and serialized), and Inventory (lot and serialized).
- shopzillaProductFeed Shopzilla Product Feed: boolean
- siteCategory: nonInventorySaleItem-siteCategoryCollection
- siteMapPriority: object
-
- stockDescription Stock Description: string
-
Enter up to 21 characters to specify information about this item, such as New, Refurbished or Ships 2-3 days.
- storeDescription Store Description: string
-
The store description appears under the item's store display name on item list pages in your store or site. You can enter letters, numbers, and basic HTML code. Note: To make the store description display when an item is in the Web store shopping cart, go to Setup > Web Site > Set Up Web Site. Click the Cart subtab, and check the box next to Store Description.
- storeDetailedDescription Detailed Description: string
-
Enter a detailed description for this item. When your customers click an item's store display name for more information, they see this description. You can enter letters, numbers or basic HTML code. If you are using Internet Explorer, you can also clear the View Source box below to enter and format text using the formatting options above. This eliminates the need for HTML code. If you do not see the View Source box, make sure Rich Text Editing is enabled at Home > Set Preferences > Appearance.
- storeDisplayImage: nsResource
- storeDisplayName Store Display Name: string
-
Enter the name of this item as you want it displayed in your Web site. You can enter up to 250 characters.
- storeDisplayThumbnail: nsResource
- subsidiary: subsidiaryCollection
- unitsType: unitsType
- upcCode UPC Code: string
-
Enter a maximum of 999 characters in this field to identify an internal name or number to store the item's UPC Code. You can use the text you enter here when adding the item to transactions, searching, or viewing reports. * When you enter text in this field, the SKU/UPC field on item labels displays this UPC Code and prints in UPC bar code format. * When this field is clear, the SKU/UPC field on item labels displays the Item Name/Number and prints in Code-128 bar code format.
- urlComponent URL Component: string
-
Enter a short, descriptive name for this item to appear as part of its URL in the Web store. Setting a name to show in the URL can result in better ranking from search engines. If you leave this field blank, NetSuite terms and numbers are used as identifiers in the URL. Note: Descriptive URL components are case sensitive. Descriptive URLs must match the case used in the URL Component field of an item record to point to the correct page.
- useMarginalRates Use Marginal Rates: boolean
-
Check this box if you want the quantity discounts in the schedule to be applied to each pricing bracket separately. For example, a schedule offers no discount for the first 100 items sold and a 5% discount if more than 100 are sold. If 150 items are sold, the first 100 are at normal price, and the other fifty items are sold at 5% discount. Leave this box clear if you want the discount to apply to all of the items sold.
- weight Item Weight : number (float)
-
Enter the weight of this item and select the units in the dropdown.
- weightUnit: object
-
- id Internal identifier.: string 1 , 2 , 3 , 4
- refName Reference Name: string
- weightUnits Weight Units: string
- yahooProductFeed Yahoo Shopping Product Feed: boolean
nonInventorySaleItem-accountingBookDetailCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: nonInventorySaleItem-accountingBookDetailElement
-
nonInventorySaleItem-accountingBookDetailElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
nonInventorySaleItem-accountingBookDetailElement
- accountingBook: accountingBook
- amortizationTemplate: amortizationTemplate
- createExpensePlansOn: nsResource
- createRevenuePlansOn: nsResource
- links Links: nsLink
-
nsLink - refName Reference Name: string
- revRecForecastRule: nsResource
- revRecSchedule: revRecTemplate
- revenueRecognitionRule: nsResource
- sameAsPrimaryAmortization Same as Primary Book Amortization: boolean
- sameAsPrimaryRevRec Same as Primary Book Rev Rec: boolean
nonInventorySaleItem-hierarchyVersionsCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: nonInventorySaleItem-hierarchyVersionsElement
-
nonInventorySaleItem-hierarchyVersionsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
nonInventorySaleItem-hierarchyVersionsElement
- endDate Hierarchy Version End Date: string (date)
- hierarchyNode: merchandiseHierarchyNode
- hierarchyVersion: merchandiseHierarchyVersion
- isIncluded Included In Version: boolean
- links Links: nsLink
-
nsLink - refName Reference Name: string
- startDate Hierarchy Version Start Date: string (date)
nonInventorySaleItem-presentationItemCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: nonInventorySaleItem-presentationItemElement
-
nonInventorySaleItem-presentationItemElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
nonInventorySaleItem-price
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: nonInventorySaleItem-priceElement
-
nonInventorySaleItem-priceElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
nonInventorySaleItem-priceElement
- currencyPage: currency
- discountDisplay Default Discount %: number (double)
- isInactive Inactive: boolean
-
When you check this box, this item will no longer appear on a list unless you check the Show All box at the bottom of the list page.
- links Links: nsLink
-
nsLink - price Amount: number (double)
- priceLevel: priceLevel
- priceLevelName Price Level: string
- priceQty Sequence Number: integer (int64)
- quantity: object
-
- value Value: string
- refName Reference Name: string
nonInventorySaleItem-siteCategoryCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: nonInventorySaleItem-siteCategoryElement
-
nonInventorySaleItem-siteCategoryElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
nonInventorySaleItem-siteCategoryElement
- category: nsResource
- links Links: nsLink
-
nsLink - refName Reference Name: string
- webSite: webSite
nonInventorySaleItemCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: nonInventorySaleItem
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
nonInventorySaleItem - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
note
This record is available as a beta record.
- accountingPeriod: nsResource
- activity: nsResource
- author: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- customForm: object
-
- id Internal identifier.: string -900
- refName Reference Name: string
- direction: object
-
- id Internal identifier.: string 1 , 2
- refName Reference Name: string
- entity: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- externalId External ID: string
- folder: nsResource
- id Internal ID: string
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- lastModifiedDate Modification Date: string (date-time)
- links Links: nsLink
-
nsLink - media: nsResource
- note Memo: string
-
Enter the comment or note you want to record. This note could be information about or communications with this company or person.
- noteDate Date: string (date-time)
-
Accept or enter a date for this note.
- noteType: noteType
- refName Reference Name: string
- time Time: string
-
Accept or enter a time for this note.
- title Title: string
-
Enter a title for this note.
- topic: topic
- transaction: nsResource
noteCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: note
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
note - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
noteType
This record is available as a beta record.
- description Description: string
-
Enter a description of this note type.
- externalId External ID: string
- id Internal ID: string
- isInactive Inactive: boolean
-
Check this box to inactivate this contact category.
- links Links: nsLink
-
nsLink - name Note Type: string
-
Enter the name for this contact category.
- refName Reference Name: string
noteTypeCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: noteType
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
noteType - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
nsError
- o:errorDetails: object[]
-
An array containing one or more problem types.
-
object - detail Detail: string
-
A detailed, human-readable description of the problem occurrence.
- o:errorCode Error Code: string
-
The application-specific error code. Similar problem types are grouped together.
- o:errorHeader Error Header: string
-
The name of the HTTP header where the problem occurs.
- o:errorPath Error Path: string (JSONPath)
-
The JSON path that indicates where the problem occurs within the request body.
- o:errorQueryParam Error Query Parameter: string
-
The name of the query parameter where the problem occurs.
- o:errorUrl Error URL: string (URI)
-
The URI of the first element in the request URL where the problem occurs.
- status Status: integer (int32)
-
The HTTP status code generated by the server the request originates from.
- title Title: string
-
A human-readable description of the problem type.
- type Type: string (URI)
-
A URI reference to the documentation about the problem type.
nsResourceCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: nsResource
-
nsResource - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
opportunity
This record is available as a beta record.
- accountingBookDetail: opportunity-accountingBookDetailCollection
- actionitem Action Item: string
-
Record the next step in the negotiation process.
- altSalesRangeHigh Alt. Sales Range High: number (double)
-
Enter the range of alternate sales amounts this deal might be worth. The low amount entered must be lower than or equal to the projected amount in the Alt. Sales Total field. This amount is the Worst Case projected total. The high amount must be greater than or equal to the Alt. Sales Total amount. This amount is the Upside projected total.
- altSalesRangeLow Alt. Sales Range Low: number (double)
-
Enter the range of alternate sales amounts this deal might be worth. The low amount entered must be lower than or equal to the projected amount in the Alt. Sales Total field. This amount is the Worst Case projected total. The high amount must be greater than or equal to the Alt. Sales Total amount. This amount is the Upside projected total.
- altSalesTotal Alt. Sales Total: number (double)
- appliedRules: opportunity-appliedRulesCollection
- billAddr1 Billing Address Line 1: string
- billAddr2 Billing Address Line 2: string
- billAddr3 Billing Address Line 3: string
- billAddress Bill To: string
-
The default billing address autofills this field from the customer's record at Lists > Relationships > Customers. To enter a different address: * Select another address in the Bill To Select field. * Select New in the Bill To Select field to enter a new billing address.
- billAddressList: nsResource
- billAddressee Billing Addressee: string
- billAttention Billing Attention: string
- billCity Billing Address City: string
- billCountry: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- billOverride Override: string
- billPhone Billing Phone: string
- billState Billing Address State: string
- billZip Billing Address Zip Code: string
- billingAddress: opportunity-billingAddress
- billingAddress_text Billing Address: string
- buyingReason: nsResource
- buyingTimeFrame: nsResource
- canHaveStackable Can Stack Promotions: boolean
- class: classification
- closeDate Actual Close: string (date)
-
NetSuite enters the date this opportunity closed.
- competitors: opportunity-competitorsCollection
- contribPct Contribution Percentage: string
- createdDate Date Created: string (date-time)
- currency: currency
- customForm: object
-
- id Internal identifier.: string -9923
- refName Reference Name: string
- daysOpen Days Open: integer (int64)
-
This field shows the number of days this opportunity has been open.
- daysOverdueSearch Days Overdue: integer (int64)
- department: department
- entity: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- entityStatus: customerStatus
- entityTaxRegNum Customer Tax Reg. Number: string
-
Select the customer's tax registration number associated with this opportunity.
- estGrossProfit Est. Gross Profit: number (double)
-
Estimated Gross Profit: Read-only field that equals the revenue amount minus the Est. Cost. At the transaction level, it equals the gross profit of all lines, factoring transaction-level discounts and markups.
- estGrossProfitPercent Est. Gross Profit Percent: number (double)
-
Estimated Gross Profit Margin, as a percentage: Read-only field that equals the Est. Gross Profit divided by revenue, expressed as a percentage. At the transaction level, it equals the gross profit percent of all lines, factoring transaction-level discounts and markups.
- estimatedBudget Estimated Budget: number (double)
-
Enter the estimated budget the prospect or customer has for this opportunity.
- estimates: opportunity-estimatesCollection
- exchangeRate Exchange Rate: number (double)
-
The current exchange rate for this currency shows in this field. You can change this exchange rate for this transaction
- excludeCommission Exclude Commissions: boolean
- expectedCloseDate Expected Close Date: string (date)
-
Enter the date you think this opportunity will close.
- externalId External ID: string
- forecastType: object
-
- id Internal identifier.: string 0 , 1 , 2 , 3
- refName Reference Name: string
- id Internal ID: string
- isBudgetApproved Budget Approved: boolean
-
Check this box if the budget for this opportunity has been approved by the prospect or customer.
- item: opportunity-itemCollection
- job: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- lastModifiedDate Date Last Modified: string (date-time)
- leadSource: nsResource
- links Links: nsLink
-
nsLink - location: location
- memo Details: string
-
Enter additional information about the opportunity.
- nexus: nexus
- oneTime One Time: number (double)
- originator Originator: string
- partner: partner
- partners: opportunity-partnersCollection
- prevDate Previous Effective Date: string (date)
- prevPartner Previous Partner: integer (int64)
- prevRep Previous Representative: integer (int64)
- probability Probability (%): number (double)
-
Enter the probability that this opportunity will be won. If there is an estimate associated with this opportunity, the probability from the estimate is applied to the opportunity.
- projAltSalesAmt Projected Alt. Sales Amount: number (double)
-
This field shows the projected alternate sales amount of the opportunity based on the items selected on the opportunity and the estimates associated with the opportunity.
- projectedTotal Projected Total: number (double)
-
This field shows the projected value of the opportunity based on the items selected on the opportunity and the estimates associated with the opportunity.
- rangeHigh Range High: number (double)
-
Enter the range of amounts this deal might be worth. The low amount entered must be lower than or equal to the projected amount in the Projected Total field. This amount is the Worst Case projected total. The high amount must be greater than or equal to the Projected Total amount. This amount is the Upside projected total.
- rangeLow Range Low: number (double)
-
Enter the range of amounts this deal might be worth. The low amount entered must be lower than or equal to the projected amount in the Projected Total field. This amount is the Worst Case projected total. The high amount must be greater than or equal to the Projected Total amount. This amount is the Upside projected total.
- recurAnnually Annually: number (double)
- recurMonthly Monthly: number (double)
- recurQuarterly Quarterly: number (double)
- recurWeekly Weekly: number (double)
- refName Reference Name: string
- refreshFromSubscription: string
- salesChannel: salesChannel
- salesEffectiveDate Sales Effective Date: string (date)
- salesReadiness: nsResource
- salesRep: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- salesTeam: opportunity-salesTeamCollection
- saleschannelorderpriority: string
- shipAddress Ship To: string
-
The default shipping address autofills this field from the customer's record at Lists > < TASKCATEGORY=CUSTJOB> > Customers. To enter a different address: * Select another address in the Ship To Select field. * Select New in the Ship To Select field to enter a new billing address.
- shipAddressList: nsResource
- shipIsResidential Shipping address is residential: boolean
- shipOverride Override: boolean
- shippingAddress: opportunity-shippingAddress
- shippingAddress_text Shipping Address: string
- source: object
-
- status: object
-
- id Internal identifier.: string A , B , C , D
- refName Reference Name: string
- storeOrder: string
- subsidiary: subsidiary
- subsidiaryTaxRegNum Subsidiary Tax Reg. Number: string
-
This field shows the tax registration number of the transaction nexus. NetSuite automatically populates this field based on the nexus lookup logic. You can override the transaction nexus and tax registration number that NetSuite automatically selects by checking the Nexus Override box. When you select a different tax registration number in the dropdown list, the corresponding nexus is automatically selected in the Nexus field.
- taxDetails: opportunity-taxDetailsCollection
- taxDetailsOverride Tax Details Override: boolean
-
Check this box to override the tax information on the Tax Details subtab of the transaction. Only roles with at least the Edit level of the Tax Details Tab permission can override the tax details.
- taxPointDate Tax Point Date: string (date)
-
Tax point date is a legal requirement in many countries. It is the date of transaction that determines the taxability. It may be different from the transaction date that determines the GL impact. Specific rules then consider the reporting of transactions based on tax point date and other factors.
- taxPointDateOverride Tax Point Date Override: boolean
- taxRegOverride Tax Registration Override: boolean
-
Check this box to override the values in the Nexus and Subsidiary Tax Reg. Number fields. Only roles with at least the Edit level of the Tax Details Tab permission can override the values that NetSuite automatically selects in these fields.
- taxTotal Tax: number (double)
- title Title: string
-
Enter a title for this opportunity. This title appears on lists, reports and on the Opportunities subtab of the record it is associated with.
- total Total: number (double)
- totalAfterTaxes Total After Taxes: number (double)
- totalCostEstimate Est. Cost: number (double)
-
Estimated Cost: Estimated cost of the specific number of items; estimated rate x quantity = estimated cost.
- tranDate Date: string (date)
-
NetSuite enters the date the opportunity record is created. You can change this date.
- tranId Opportunity #: string
-
NetSuite assigns a number to identify this transaction. You can change this number.
- webSite: string
- weightedTotal Weighted Total: number (double)
-
If there are no transactions included in this opportunity or if there is a single transaction, the weighted total for this transaction is the projected total multiplied by the probability of close. If there are multiple transactions associated with this opportunity, the weighted total of the opportunity is the sum of the weighted totals for each transaction. Only estimates marked Include in forecast are included in the weighted total.
- winLossReason: nsResource
opportunity-accountingBookDetailCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: opportunity-accountingBookDetailElement
-
opportunity-accountingBookDetailElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
opportunity-accountingBookDetailElement
This record is available as a beta record.
- accountingBook: accountingBook
- exchangeRate Exchange Rate: number (double)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- revRecOnRevCommitment Rev Rec on Rev Commit.: boolean
- subsidiary: subsidiary
- tranIsVsoeBundle Transaction Is VSOE Bundle: boolean
opportunity-appliedRulesCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: opportunity-appliedRulesElement
-
opportunity-appliedRulesElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
opportunity-billingAddress
This record is available as a beta record.
- addr1 Address 1: string
-
Enter the address the way it should appear on forms. For employees, customers, partners, and vendors, what you enter here autofills on forms if this address is marked default for Shipping or Billing. Enter up to 50 characters. This field is required for the Online Bill Pay feature.
- addr2 Address 2: string
-
Enter an optional second address line the way it should appear on forms. For employees, customers, partners, and vendors, what you enter here autofills on forms if this address is marked default for Shipping or Billing. Enter up to 50 characters.
- addr3 Address 3: string
- addrPhone Phone: string
-
Enter the phone number.
- addrText Address: string
-
The values entered in the other address fields are displayed here.
- addressee Addressee: string
-
Enter the name of the entity that should appear on the shipping label here. This name appears on the shipping label below what you enter in the Attention field.
- attention Attention: string
-
Enter the name of the person to whom a shipment is addressed, as it should appear on shipping labels. This field is required for UPS Integration.
- city City: string
-
Enter the city the way it should appear on all forms except checks.
- country: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- externalId External ID: string
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - override Override: boolean
-
Check this box to disable the free-form address text field. When this field is disabled, text entered in the other address fields does not display in the Address text field. Clear this box to allow text entered in the address component fields to appear in the free-form address text field.
- refName Reference Name: string
- state State/Province: string
-
Enter your company's state or province the way it should appear on all forms except checks.
- zip Zip: string
-
Enter the postal code the way it should appear on all forms except checks.
opportunity-competitorsCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: opportunity-competitorsElement
-
opportunity-competitorsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
opportunity-competitorsElement
This record is available as a beta record.
- competitor: competitor
- links Links: nsLink
-
nsLink - notes Notes: string
- refName Reference Name: string
- strategy Strategy: string
- url URL: string
- winner Winner: boolean
opportunity-estimatesCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: opportunity-estimatesElement
-
opportunity-estimatesElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
opportunity-estimatesElement
This record is available as a beta record.
- expectedclosedate Exp. Close Date: string (date)
- forecasttype: object
-
- id Internal identifier.: string 0 , 1 , 2 , 3
- refName Reference Name: string
- links Links: nsLink
-
nsLink - probability Probability: number (double)
- refName Reference Name: string
- status Status: string
- title Title: string
- total Amount: number (double)
- tranId Number: string
- trandate Date: string (date)
opportunity-itemCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: opportunity-itemElement
-
opportunity-itemElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
opportunity-itemElement
This record is available as a beta record.
- altSalesAmt Alt. Sales Amount: number (double)
- amount Amount: number (double)
- billVarianceStatus: object
-
- id Internal identifier.: string NOVARIANCES , JOURNALNOTPOSTED , JOURNALPOSTED
- refName Reference Name: string
- billingschedule: string
- class: classification
- costEstimate Est. Cost: number (double)
- costEstimateRate Est. Rate: number (double)
- costEstimateType: object
-
- id Internal identifier.: string PREFVENDORRATE , AVGCOST , PURCHORDERRATE , LASTPURCHPRICE , MEMBERDEFINED , CUSTOM , ITEMDEFINED , PURCHPRICE
- refName Reference Name: string
- department: department
- description Description: string
- estGrossProfit Est. Gross Profit: number (double)
- estGrossProfitPercent Est. Gross Profit Percent: number (double)
- expectedShipDate Expected Ship Date: string (date)
- fromJob From Project: boolean
- initOqpBucket Initial OQP Bucket: string
- isClosed Closed: boolean
- isEstimate Estimate: boolean
- isOpen Is Opened: boolean
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemSubtype: object
-
- id Internal identifier.: string Sale , Purchase , Resale
- refName Reference Name: string
- itemType: object
-
- job: job
- licenseCode License Code: string
- line Transaction Line: integer (int64)
- linked Linked: boolean
- links Links: nsLink
-
nsLink - location: location
- marginal Marginal: boolean
- matrixType Matrix Type: string
- minQty Minimum Quantity: number (float)
- options Options: string
- oqpBucket Oqp Bucket: string
- price: priceLevel
- priceIntervalFrequency: string
- priceIntervalFrequencyName Subscription Frequency: string
- priceIntervalRepeatEvery Subscription Frequency Repeat Every: string
- printItems Print Items: boolean
- quantity Quantity: number (float)
- quantityAllocated Quantity Allocated: number (float)
- quantityAvailable Available: number (float)
- quantityCommitted Committed: number (float)
- quantityDemandAllocated Allocated Demand: number (float)
- quantityOnHand On Hand: number (float)
- rate Rate: number (double)
- rateIncludingTax Rate: number (double)
- rateSchedule Rate Schedule: string
- refName Reference Name: string
- subscription: subscription
- subscriptionLine: subscriptionLine
- subscriptionLinePeriodAmount Subscription Amount Per Period: number (double)
- subscriptionLineRate Subscription Rate: number (double)
- subscriptionLineType: string
- subsidiary: subsidiary
- taxAmount Tax Amount: number (double)
- taxDetailsReference Tax Details Reference: string
- units Units: string
opportunity-partnersCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: opportunity-partnersElement
-
opportunity-partnersElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
opportunity-partnersElement
This record is available as a beta record.
- contribution Contribution %: number (double)
- isPrimary Primary: boolean
- links Links: nsLink
-
nsLink - partner: partner
- partnerRole: partnerCategory
- refName Reference Name: string
opportunity-salesTeamCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: opportunity-salesTeamElement
-
opportunity-salesTeamElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
opportunity-shippingAddress
This record is available as a beta record.
- addr1 Address 1: string
-
Enter the address the way it should appear on forms. For employees, customers, partners, and vendors, what you enter here autofills on forms if this address is marked default for Shipping or Billing. Enter up to 50 characters. This field is required for the Online Bill Pay feature.
- addr2 Address 2: string
-
Enter an optional second address line the way it should appear on forms. For employees, customers, partners, and vendors, what you enter here autofills on forms if this address is marked default for Shipping or Billing. Enter up to 50 characters.
- addr3 Address 3: string
- addrPhone Phone: string
-
Enter the phone number.
- addrText Address: string
-
The values entered in the other address fields are displayed here.
- addressee Addressee: string
-
Enter the name of the entity that should appear on the shipping label here. This name appears on the shipping label below what you enter in the Attention field.
- attention Attention: string
-
Enter the name of the person to whom a shipment is addressed, as it should appear on shipping labels. This field is required for UPS Integration.
- city City: string
-
Enter the city the way it should appear on all forms except checks.
- country: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- externalId External ID: string
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - override Override: boolean
-
Check this box to disable the free-form address text field. When this field is disabled, text entered in the other address fields does not display in the Address text field. Clear this box to allow text entered in the address component fields to appear in the free-form address text field.
- refName Reference Name: string
- state State/Province: string
-
Enter your company's state or province the way it should appear on all forms except checks.
- zip Zip: string
-
Enter the postal code the way it should appear on all forms except checks.
opportunity-taxDetailsCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: opportunity-taxDetailsElement
-
opportunity-taxDetailsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
opportunity-taxDetailsElement
This record is available as a beta record.
- calcDetail Details: string
- lineName Name: string
- lineType Line type: string
- links Links: nsLink
-
nsLink - netAmount Net Amount: number (double)
- refName Reference Name: string
- taxAmount Tax Amount: number (double)
- taxBasis Tax Basis: number (double)
- taxCode: salesTaxItem
- taxDetailsReference: object
-
- id Internal identifier.: string
- refName Reference Name: string
- taxRate Tax Rate: number (double)
- taxType Tax Type: string
opportunityCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: opportunity
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
opportunity - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
orderReservation
This record is available as a beta record.
- allocatedDemand Allocated Demand: number (float)
- allocatedSupply Allocated Supply: number (float)
- approvalStatus: object
-
- id Internal identifier.: string 1 , 2 , 3
- refName Reference Name: string
- closed Closed: boolean
- commitmentFirm Commitment Firm: boolean
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- daysLate Days Late: integer (int64)
- deletionreason Deletion Reason: string
- deletionreasonmemo Deletion Reason Memo: string
- endDate End Date: string (date)
- externalId External ID: string
- id Internal ID: string
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- links Links: nsLink
-
nsLink - location: location
- name Name: string
- nextApprover: employee
- oldQuantity: number (float)
- orderAllocationStrategy: nsResource
- orderPriority Order Priority: number (float)
- quantity Quantity: number (float)
- quantityBase: number (float)
- quantityCommitted Quantity Committed: number (float)
- quantityRemaining Quantity Remaining: number (float)
- refName Reference Name: string
- salesChannel: salesChannel
- startDate Start Date: string (date)
- subsidiary: subsidiary
- targetQuantity Target Quantity: number (float)
- tranId ID: string
- transactionDate Transaction Date: string (date)
- units Units: string
orderReservationCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: orderReservation
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
orderReservation - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
otherChargePurchaseItem
This record is available as a beta record.
- VSOEDeferral: object
-
- id Internal identifier.: string DEFERALLUNTIL , DEFERUNTIL
- refName Reference Name: string
- VSOEDelivered Default as Delivered: boolean
- VSOEPermitDiscount: object
-
- id Internal identifier.: string IFDELIVERED , NEVER
- refName Reference Name: string
- VSOEPrice Allocation Price: number (double)
- VSOESopGroup: object
-
- id Internal identifier.: string EXCLUDE , NORMAL , SOFTWARE
- refName Reference Name: string
- accountingBookDetail: otherChargePurchaseItem-accountingBookDetailCollection
- amortizationPeriod Amortization Period: integer (int64)
-
Enter the number of periods over which the purchase amount should be amortized. For example, enter 60 to amortize the amount over 60 periods starting from the amortization start date. Note: The starting period is specified by the amortization start date on bills. If no amortization start date is specified, the posting date of the bill is the amortization start date.
- amortizationTemplate: amortizationTemplate
- availableToPartners Available to Adv. Partners: boolean
-
Check this box to make this item available to partners with the Advanced Partner Center role for viewing. These items are also available to partners with roles that are customized for the Advanced Partner Center and include view, create or edit access to item records.
- baseUnit Primary Base Unit: string
- billExchRateVarianceAcct: account
- billPriceVarianceAcct: account
- billQtyVarianceAcct: account
- class: classification
- consumptionUnit Primary Consumption Unit: string
-
If you use the Multiple Units of Measure feature, select the default unit of measure for inventory.
- cost Purchase Price: number (double)
-
Enter the price you pay for this item. If you do not enter a price, purchase orders for this item show the most recent purchase price by default. If you select a preferred vendor for this item, the price is shown in the currency selected on the vendor's record. If no preferred vendor is selected, the price is shown in your base currency.
- costLabel: string
- createExpensePlansOn: nsResource
- createdDate Date Created: string (date-time)
- currency: currency
- customForm: object
-
- id Internal identifier.: string -210 , -10211 , -10210
- refName Reference Name: string
- deferralAccount: account
- department: department
- description Description: string
- displayName Display Name/Code: string
-
Enter an optional name of up to 250 characters for this item in addition to the Item Name. If you are integrating with a Yahoo! store, this field is imported from Yahoo!. The display name prints in the Item column of sales forms when Basic printing is used. If this item is a member of a kit, this name appears in the Item column when the Print Items box is checked. If you do not enter a display name, the item name appears on printed forms.
- exchangeRate: string
- expenseAccount: account
- expenseAmortizationRule: nsResource
- externalId External ID: string
- generateAccruals Generate Accruals: boolean
-
Check this box to automatically generate and post an accrual to the General Ledger.
- hierarchyVersions: otherChargePurchaseItem-hierarchyVersionsCollection
- id Internal ID: string
- includeChildren Include Children: boolean
-
Check the Include Children box to share the item with all the sub-subsidiaries associated with each subsidiary selected in the Subsidiary field. Note: When sharing items across subsidiaries, all of the options selected on the item record must be compatible across subsidiaries. For example, when entering an inventory item to be shared across subsidiaries, you should select Income and Asset accounts on the item record that are also shared across the same subsidiaries.
- insertItemAttribute: object
-
- id Internal identifier.: string class , department , itemid , location , issueproduct , vendorname
- refName Reference Name: string
- isFulfillable Can be Fulfilled: boolean
-
Check the Can be Fulfilled/Received box to enable this item to be received and fulfilled during order processing. Clear this box if this item does not require being received and fulfilled. Note: Once this item has been added to transactions, this setting cannot be changed. This field is used when the Advanced Billing and Advanced Shipping features are both enabled.
- isInactive Inactive: boolean
-
When you check this box, this item will no longer appear on a list unless you check the Show All box at the bottom of the list page.
- isMaterialOverhead: boolean
- issueProduct: issueProduct
- itemId Item Name/Number: string
-
Enter up to 250 characters for the name of this item. This name appears in lists on transactions. If you have the option of entering a display name and do not, the item name prints in the Item column of sales forms when Basic printing is used. If you have the option to enter a vendor name and do not, the item name prints in the Item column of purchase forms. If you have entered a display name, it will print on purchases instead of the item name when Basic printing is used.
- itemType: object
-
- itemVendor: otherChargePurchaseItem-itemVendorCollection
- lastModifiedDate Last Modified: string (date-time)
- links Links: nsLink
-
nsLink - location: location
- manufacturingChargeItem Manufacturing Charge Item: boolean
-
Check the Manufacturing Charge Item box to define charges for the activity. For example, you can define the hourly cost of activities being performed and the expense account charges are logged against.
- matrixItemNameTemplate Matrix Item Name Template: string
-
This field is used to control how the matrix item will be displayed in the Matrix Item Name/Number field. Compose the order in which attributes and matrix options are displayed by selecting from the Insert Item Attribute and Insert Matrix Option dropdown lists. Add custom separator characters to easier distinguish the various options. Example: Item Name: Fabric / Color / Waist / Length [Location]
- matrixItemNameTemplateHelp Matrix Item Name Template: string
- matrixType: object
-
- id Internal identifier.: string , PARENT , CHILD
- refName Reference Name: string
- overheadType: object
-
- id Internal identifier.: string PERCENTTOTAL , FIXED , PERCENTMATERIAL
- refName Reference Name: string
- parent: otherChargePurchaseItem
- parentOnly Use as Category Only: boolean
- purchaseDescription Purchase Description: string
-
Enter up to 999 characters of text for a description of this item to appear on vendor orders. Include the unit of measure in this description.
- purchaseOrderAmount Vendor Bill - Purchase Order Amount Tolerance: number (float)
-
Enter the tolerance limit for the discrepancy between the amount on the vendor bill and purchase order.
- purchaseOrderQuantity Vendor Bill - Purchase Order Quantity Tolerance: number (float)
-
Enter the tolerance limit for the discrepancy between the quantity on the vendor bill and purchase order.
- purchaseOrderQuantityDiff Vendor Bill - Purchase Order Quantity Difference: number (float)
-
Enter the difference limit for the discrepancy between the quantity on the vendor bill and purchase order.
- purchaseUnit Primary Purchase Unit: string
-
Select the unit you use to purchase this item from the vendor.
- receiptAmount Vendor Bill - Item Receipt Amount Tolerance: number (float)
-
Enter the tolerance limit for the discrepancy between the amount on the vendor bill and item receipt.
- receiptQuantity Vendor Bill - Item Receipt Quantity Tolerance: number (float)
-
Enter the tolerance limit for the discrepancy between the quantity on the vendor bill and item receipt.
- receiptQuantityDiff Vendor Bill - Item Receipt Quantity Difference: number (float)
-
Enter the difference limit for the discrepancy between the quantity on the vendor bill and item receipt.
- refName Reference Name: string
- residual Residual: number (double)
-
Enter an amount or percentage to remain in the deferral account and not be amortized. A residual amount generally represents the salvage value of a fixed asset. Note: A residual amount entered on a transaction overrides a residual amount entered on an item record.
- subsidiary: subsidiaryCollection
- subtype: object
-
- id Internal identifier.: string Sale , Purchase , Resale
- refName Reference Name: string
- unitsType: unitsType
- upcCode UPC Code: string
-
Enter a maximum of 999 characters in this field to identify an internal name or number to store the item's UPC Code. You can use the text you enter here when adding the item to transactions, searching, or viewing reports. * When you enter text in this field, the SKU/UPC field on item labels displays this UPC Code and prints in UPC bar code format. * When this field is clear, the SKU/UPC field on item labels displays the Item Name/Number and prints in Code-128 bar code format.
- vendor: vendor
- vendorName Vendor Name/Code: string
-
If your vendor uses a name for this item that is different from the name you use, you can enter up to 60 characters as the vendor's name for this item here. The vendor's name for this item prints in the Item column of purchase forms. If you do not enter a vendor name, the item name prints in the Item column of purchase forms. If you have entered a display name, it will print on purchases instead of the item name.
otherChargePurchaseItem-accountingBookDetailCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: otherChargePurchaseItem-accountingBookDetailElement
-
otherChargePurchaseItem-accountingBookDetailElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
otherChargePurchaseItem-accountingBookDetailElement
This record is available as a beta record.
- accountingBook: accountingBook
- amortizationTemplate: amortizationTemplate
- createExpensePlansOn: nsResource
- createRevenuePlansOn: nsResource
- links Links: nsLink
-
nsLink - refName Reference Name: string
- revRecForecastRule: nsResource
- revRecSchedule: revRecTemplate
- revenueRecognitionRule: nsResource
- sameAsPrimaryAmortization Same as Primary Book Amortization: boolean
- sameAsPrimaryRevRec Same as Primary Book Rev Rec: boolean
otherChargePurchaseItem-hierarchyVersionsCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: otherChargePurchaseItem-hierarchyVersionsElement
-
otherChargePurchaseItem-hierarchyVersionsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
otherChargePurchaseItem-hierarchyVersionsElement
This record is available as a beta record.
- endDate Hierarchy Version End Date: string (date)
- hierarchyNode: merchandiseHierarchyNode
- hierarchyVersion: merchandiseHierarchyVersion
- isIncluded Included In Version: boolean
- links Links: nsLink
-
nsLink - refName Reference Name: string
- startDate Hierarchy Version Start Date: string (date)
otherChargePurchaseItem-itemVendor-itemVendorPrice
This record is available as a beta record.
- externalId External ID: string
- itemvendorpricelines: otherChargePurchaseItem-itemVendor-itemVendorPrice-itemvendorpricelinesCollection
- links Links: nsLink
-
nsLink - refName Reference Name: string
otherChargePurchaseItem-itemVendor-itemVendorPrice-itemvendorpricelinesCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: otherChargePurchaseItem-itemVendor-itemVendorPrice-itemvendorpricelinesElement
-
otherChargePurchaseItem-itemVendor-itemVendorPrice-itemvendorpricelinesElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
otherChargePurchaseItem-itemVendorCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: otherChargePurchaseItem-itemVendorElement
-
otherChargePurchaseItem-itemVendorElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
otherChargePurchaseItem-itemVendorElement
This record is available as a beta record.
- itemVendorPrice: otherChargePurchaseItem-itemVendor-itemVendorPrice
- links Links: nsLink
-
nsLink - predConfidence Predicted Risk Confidence: number (double)
- predictedDays Predicted Days Late/Early: integer (int64)
- preferredVendor Preferred: boolean
- purchasePrice Purchase Price: number (double)
- refName Reference Name: string
- schedule: nsResource
- subsidiary: subsidiary
- vendor: vendor
- vendorCode Code: string
- vendorCurrencyName Currency: string
otherChargePurchaseItemCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: otherChargePurchaseItem
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
otherChargePurchaseItem - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
otherChargeResaleItem
This record is available as a beta record.
- VSOEDeferral: object
-
- id Internal identifier.: string DEFERALLUNTIL , DEFERUNTIL
- refName Reference Name: string
- VSOEDelivered Default as Delivered: boolean
-
Check this box to automatically set this item to a Delivered status when this item is added to a transaction. Clear this box to leave the delivery status clear by default.
- VSOEPermitDiscount: object
-
- id Internal identifier.: string IFDELIVERED , NEVER
- refName Reference Name: string
- VSOEPrice Allocation Price: number (double)
-
Enter the VSOE Price for this item if it is known. Note: If you need to use more than one VSOE price for an item, you can set the most common price here and then change the price on each order manually.
- VSOESopGroup: object
-
- id Internal identifier.: string EXCLUDE , NORMAL , SOFTWARE
- refName Reference Name: string
- accountingBookDetail: otherChargeResaleItem-accountingBookDetailCollection
- amortizationPeriod Amortization Period: integer (int64)
-
Enter the number of periods over which the purchase amount should be amortized. For example, enter 60 to amortize the amount over 60 periods starting from the amortization start date. Note: The starting period is specified by the amortization start date on bills. If no amortization start date is specified, the posting date of the bill is the amortization start date.
- amortizationTemplate: amortizationTemplate
- autoExpandKitForRevenuemgmt Auto-Expansion for Revenue Management: boolean
- availableToPartners Available to Adv. Partners: boolean
-
Check this box to make this item available to partners with the Advanced Partner Center role for viewing. These items are also available to partners with roles that are customized for the Advanced Partner Center and include view, create or edit access to item records.
- baseUnit Primary Base Unit: string
- billExchRateVarianceAcct: account
- billPriceVarianceAcct: account
- billQtyVarianceAcct: account
- billingSchedule: billingSchedule
- class: classification
- consumptionUnit Primary Consumption Unit: string
-
If you use the Multiple Units of Measure feature, select the default unit of measure for inventory.
- contingentRevenueHandling Eligible For Contingent Revenue Handling: boolean
-
Check this box to indicate that the item is subject to contingent revenue handling. When checked, revenue allocation is affected.
- cost Purchase Price: number (double)
-
Enter the price you pay for this item. If you do not enter a price, purchase orders for this item show the most recent purchase price by default. If you select a preferred vendor for this item, the price is shown in the currency selected on the vendor's record. If no preferred vendor is selected, the price is shown in your base currency.
- costEstimate Item Defined Cost: number (double)
-
Enter an Item Defined Cost amount.
- costEstimateUnits Est. Cost Unit: string
- costLabel: string
- createExpensePlansOn: nsResource
- createRevenuePlansOn: nsResource
- createdDate Date Created: string (date-time)
- currency: currency
- customForm: object
-
- id Internal identifier.: string -210 , -10211 , -10210
- refName Reference Name: string
- deferralAccount: account
- deferredRevenueAccount: account
- department: department
- description Description: string
- directRevenuePosting Direct Revenue Posting: boolean
-
Check this box to disable advanced revenue management for this item. When checked, posting transactions that include this item post directly to the item revenue account. No revenue element or revenue arrangement is created. When you check this box, the Deferred Revenue Account on the Accounting subtab is disabled. When you create sales transactions that include items that have this box checked, all the items in the transaction must have the box checked. You cannot mix items that post directly to revenue with items that post to deferred revenue in the same transaction. This restriction also applies to kit items. All items in a kit must post either to revenue or to deferred revenue. You cannot check or clear the box after the item has been used in a transaction with advanced revenue management. By default, this box is not checked.
- displayName Display Name/Code: string
-
Enter an optional name of up to 250 characters for this item in addition to the Item Name. If you are integrating with a Yahoo! store, this field is imported from Yahoo!. The display name prints in the Item column of sales forms when Basic printing is used. If this item is a member of a kit, this name appears in the Item column when the Print Items box is checked. If you do not enter a display name, the item name appears on printed forms.
- enforceminqtyinternally Enforce Minimum Internally: boolean
-
Check this box to apply the minimum quantity restriction on sales orders generated from NetSuite. When you clear this box, but enter a number in the Minimum Quantity field, the minimum quantity is only applied to web store orders.
- exchangeRate: string
- expenseAccount: account
- expenseAmortizationRule: nsResource
- externalId External ID: string
- generateAccruals Generate Accruals: boolean
-
Check this box to automatically generate and post an accrual to the General Ledger.
- hierarchyVersions: otherChargeResaleItem-hierarchyVersionsCollection
- id Internal ID: string
- includeChildren Include Children: boolean
-
Check the Include Children box to share the item with all the sub-subsidiaries associated with each subsidiary selected in the Subsidiary field. Note: When sharing items across subsidiaries, all of the options selected on the item record must be compatible across subsidiaries. For example, when entering an inventory item to be shared across subsidiaries, you should select Income and Asset accounts on the item record that are also shared across the same subsidiaries.
- incomeAccount: account
- insertItemAttribute: object
-
- id Internal identifier.: string class , department , itemid , location , issueproduct , vendorname
- refName Reference Name: string
- interCoDefRevAccount: account
- intercoExpenseAccount: account
- intercoIncomeAccount: account
- isFulfillable Can be Fulfilled: boolean
-
Check the Can be Fulfilled/Received box to enable this item to be received and fulfilled during order processing. Clear this box if this item does not require being received and fulfilled. Note: Once this item has been added to transactions, this setting cannot be changed. This field is used when the Advanced Billing and Advanced Shipping features are both enabled.
- isGCoCompliant Google Checkout Compliant: boolean
- isInactive Inactive: boolean
-
When you check this box, this item will no longer appear on a list unless you check the Show All box at the bottom of the list page.
- isOnline Display in Website: boolean
-
Check this box to make this item available online in your Web site. You cannot sell this item online unless you check this box. If the item is of the Other Charge for Sale or Resale subtype, checking this box does not make it available in the web store catalog. However, it becomes available during web store checkout.
- issueProduct: issueProduct
- itemId Item Name/Number: string
-
Enter up to 250 characters for the name of this item. This name appears in lists on transactions. If you have the option of entering a display name and do not, the item name prints in the Item column of sales forms when Basic printing is used. If you have the option to enter a vendor name and do not, the item name prints in the Item column of purchase forms. If you have entered a display name, it will print on purchases instead of the item name when Basic printing is used.
- itemRevenueCategory: nsResource
- itemType: object
-
- itemVendor: otherChargeResaleItem-itemVendorCollection
- lastModifiedDate Last Modified: string (date-time)
- links Links: nsLink
-
nsLink - location: location
- manufacturingChargeItem Manufacturing Charge Item: boolean
-
Check the Manufacturing Charge Item box to define charges for the activity. For example, you can define the hourly cost of activities being performed and the expense account charges are logged against.
- matrixItemNameTemplate Matrix Item Name Template: string
-
This field is used to control how the matrix item will be displayed in the Matrix Item Name/Number field. Compose the order in which attributes and matrix options are displayed by selecting from the Insert Item Attribute and Insert Matrix Option dropdown lists. Add custom separator characters to easier distinguish the various options. Example: Item Name: Fabric / Color / Waist / Length [Location]
- matrixItemNameTemplateHelp Matrix Item Name Template: string
- matrixType: object
-
- id Internal identifier.: string , PARENT , CHILD
- refName Reference Name: string
- maximumquantity Maximum Order Qty: integer (int64)
-
Enter the greatest quantity of this item that customers can purchase. If customers enter an item quantity above the maximum amount, a warning message is displayed. Web store customers are unable to complete checkout unless they enter a quantity equal to or below the maximum quantity. Leave this field empty to allow customers to check out without maximum quantity restrictions. You can edit this warning at Setup > Site Builder/SuiteCommerce Advanced > Customize Text.
- minimumquantity Minimum Order Qty: integer (int64)
-
Enter the lowest quantity that customers can purchase. Web store customers receive a warning and cannot check out if they enter an item quantity below this minimum. Leave this field empty to allow customers to check out with no minimum quantity restrictions. You can edit this warning at Setup > Site Builder/SuiteCommerce Advanced > Customize Text.
- offerSupport Offer Support: boolean
-
Check this box to offer support for this particular item. By offering support for items, customers can select on case records which item they are having trouble with.
- overallQuantityPricingType: object
-
- id Internal identifier.: string ITEM , PARENT , SCHEDULE
- refName Reference Name: string
- parent: otherChargeResaleItem
- parentOnly Use as Category Only: boolean
- price: otherChargeResaleItem-price
- pricesIncludeTax Prices Include Tax: boolean
-
Check this box to save the base price as the tax inclusive price. Clear this box to save the base price as the tax exclusive price.
- pricingGroup: pricingGroup
- purchaseDescription Purchase Description: string
-
Enter up to 999 characters of text for a description of this item to appear on vendor orders. Include the unit of measure in this description.
- purchaseOrderAmount Vendor Bill - Purchase Order Amount Tolerance: number (float)
-
Enter the tolerance limit for the discrepancy between the amount on the vendor bill and purchase order.
- purchaseOrderQuantity Vendor Bill - Purchase Order Quantity Tolerance: number (float)
-
Enter the tolerance limit for the discrepancy between the quantity on the vendor bill and purchase order.
- purchaseOrderQuantityDiff Vendor Bill - Purchase Order Quantity Difference: number (float)
-
Enter the difference limit for the discrepancy between the quantity on the vendor bill and purchase order.
- purchaseUnit Primary Purchase Unit: string
-
Select the unit you use to purchase this item from the vendor.
- quantityPricingSchedule: nsResource
- rate Price: number (double)
-
Enter the rate for this discount or markup. The rate can be either a percentage or dollar amount. A percentage discount must be followed by a % sign. A dollar amount should be entered as a positive number.
- rateIncludingTax Price Including Tax: number (double)
- receiptAmount Vendor Bill - Item Receipt Amount Tolerance: number (float)
-
Enter the tolerance limit for the discrepancy between the amount on the vendor bill and item receipt.
- receiptQuantity Vendor Bill - Item Receipt Quantity Tolerance: number (float)
-
Enter the tolerance limit for the discrepancy between the quantity on the vendor bill and item receipt.
- receiptQuantityDiff Vendor Bill - Item Receipt Quantity Difference: number (float)
-
Enter the difference limit for the discrepancy between the quantity on the vendor bill and item receipt.
- refName Reference Name: string
- residual Residual: number (double)
-
Enter an amount or percentage to remain in the deferral account and not be amortized. A residual amount generally represents the salvage value of a fixed asset. Note: A residual amount entered on a transaction overrides a residual amount entered on an item record.
- revRecForecastRule: nsResource
- revReclassFxAccount: account
- revenueAllocationGroup: nsResource
- revenueRecognitionRule: nsResource
- saleUnit Primary Sale Unit: string
-
Select the unit you use to sell this item to customers on sales transactions.
- salesDescription Sales Description: string
-
Enter a sales description for this item. You can enter letters and numbers. There is a 999 character limit. The sales description displays on transactions such as sales orders, cash sales and invoices. If you use the Web Store feature, the sales description displays immediately under the item's store display name on item list pages in your store or site, if you have not entered a store description for an item. Enter the store description on the Store subtab of the item record. The sales description also displays by default when the item is in the Web store shopping cart.
- subsidiary: subsidiaryCollection
- subtype: object
-
- id Internal identifier.: string Sale , Purchase , Resale
- refName Reference Name: string
- unitsType: unitsType
- upcCode UPC Code: string
-
Enter a maximum of 999 characters in this field to identify an internal name or number to store the item's UPC Code. You can use the text you enter here when adding the item to transactions, searching, or viewing reports. * When you enter text in this field, the SKU/UPC field on item labels displays this UPC Code and prints in UPC bar code format. * When this field is clear, the SKU/UPC field on item labels displays the Item Name/Number and prints in Code-128 bar code format.
- useMarginalRates Use Marginal Rates: boolean
-
Check this box if you want the quantity discounts in the schedule to be applied to each pricing bracket separately. For example, a schedule offers no discount for the first 100 items sold and a 5% discount if more than 100 are sold. If 150 items are sold, the first 100 are at normal price, and the other fifty items are sold at 5% discount. Leave this box clear if you want the discount to apply to all of the items sold.
- vendor: vendor
- vendorName Vendor Name/Code: string
-
If your vendor uses a name for this item that is different from the name you use, you can enter up to 60 characters as the vendor's name for this item here. The vendor's name for this item prints in the Item column of purchase forms. If you do not enter a vendor name, the item name prints in the Item column of purchase forms. If you have entered a display name, it will print on purchases instead of the item name.
otherChargeResaleItem-accountingBookDetailCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: otherChargeResaleItem-accountingBookDetailElement
-
otherChargeResaleItem-accountingBookDetailElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
otherChargeResaleItem-accountingBookDetailElement
This record is available as a beta record.
- accountingBook: accountingBook
- amortizationTemplate: amortizationTemplate
- createExpensePlansOn: nsResource
- createRevenuePlansOn: nsResource
- links Links: nsLink
-
nsLink - refName Reference Name: string
- revRecForecastRule: nsResource
- revRecSchedule: revRecTemplate
- revenueRecognitionRule: nsResource
- sameAsPrimaryAmortization Same as Primary Book Amortization: boolean
- sameAsPrimaryRevRec Same as Primary Book Rev Rec: boolean
otherChargeResaleItem-hierarchyVersionsCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: otherChargeResaleItem-hierarchyVersionsElement
-
otherChargeResaleItem-hierarchyVersionsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
otherChargeResaleItem-hierarchyVersionsElement
This record is available as a beta record.
- endDate Hierarchy Version End Date: string (date)
- hierarchyNode: merchandiseHierarchyNode
- hierarchyVersion: merchandiseHierarchyVersion
- isIncluded Included In Version: boolean
- links Links: nsLink
-
nsLink - refName Reference Name: string
- startDate Hierarchy Version Start Date: string (date)
otherChargeResaleItem-itemVendor-itemVendorPrice
This record is available as a beta record.
- externalId External ID: string
- itemvendorpricelines: otherChargeResaleItem-itemVendor-itemVendorPrice-itemvendorpricelinesCollection
- links Links: nsLink
-
nsLink - refName Reference Name: string
otherChargeResaleItem-itemVendor-itemVendorPrice-itemvendorpricelinesCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: otherChargeResaleItem-itemVendor-itemVendorPrice-itemvendorpricelinesElement
-
otherChargeResaleItem-itemVendor-itemVendorPrice-itemvendorpricelinesElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
otherChargeResaleItem-itemVendorCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: otherChargeResaleItem-itemVendorElement
-
otherChargeResaleItem-itemVendorElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
otherChargeResaleItem-itemVendorElement
This record is available as a beta record.
- itemVendorPrice: otherChargeResaleItem-itemVendor-itemVendorPrice
- links Links: nsLink
-
nsLink - predConfidence Predicted Risk Confidence: number (double)
- predictedDays Predicted Days Late/Early: integer (int64)
- preferredVendor Preferred: boolean
- purchasePrice Purchase Price: number (double)
- refName Reference Name: string
- schedule: nsResource
- subsidiary: subsidiary
- vendor: vendor
- vendorCode Code: string
- vendorCurrencyName Currency: string
otherChargeResaleItem-price
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: otherChargeResaleItem-priceElement
-
otherChargeResaleItem-priceElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
otherChargeResaleItem-priceElement
This record is available as a beta record.
- currencyPage: currency
- discountDisplay Default Discount %: number (double)
- isInactive Inactive: boolean
-
When you check this box, this item will no longer appear on a list unless you check the Show All box at the bottom of the list page.
- links Links: nsLink
-
nsLink - price Amount: number (double)
- priceLevel: priceLevel
- priceLevelName Price Level: string
- priceQty Sequence Number: integer (int64)
- quantity: object
-
- value Value: string
- refName Reference Name: string
otherChargeResaleItemCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: otherChargeResaleItem
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
otherChargeResaleItem - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
otherChargeSaleItem
This record is available as a beta record.
- VSOEDeferral: object
-
- id Internal identifier.: string DEFERALLUNTIL , DEFERUNTIL
- refName Reference Name: string
- VSOEDelivered Default as Delivered: boolean
-
Check this box to automatically set this item to a Delivered status when this item is added to a transaction. Clear this box to leave the delivery status clear by default.
- VSOEPermitDiscount: object
-
- id Internal identifier.: string IFDELIVERED , NEVER
- refName Reference Name: string
- VSOEPrice Allocation Price: number (double)
-
Enter the VSOE Price for this item if it is known. Note: If you need to use more than one VSOE price for an item, you can set the most common price here and then change the price on each order manually.
- VSOESopGroup: object
-
- id Internal identifier.: string EXCLUDE , NORMAL , SOFTWARE
- refName Reference Name: string
- accountingBookDetail: otherChargeSaleItem-accountingBookDetailCollection
- amortizationPeriod Amortization Period: integer (int64)
- amortizationTemplate: amortizationTemplate
- autoExpandKitForRevenuemgmt Auto-Expansion for Revenue Management: boolean
- availableToPartners Available to Adv. Partners: boolean
-
Check this box to make this item available to partners with the Advanced Partner Center role for viewing. These items are also available to partners with roles that are customized for the Advanced Partner Center and include view, create or edit access to item records.
- baseUnit Primary Base Unit: string
- billExchRateVarianceAcct: account
- billPriceVarianceAcct: account
- billQtyVarianceAcct: account
- billingSchedule: billingSchedule
- class: classification
- consumptionUnit Primary Consumption Unit: string
-
If you use the Multiple Units of Measure feature, select the default unit of measure for inventory.
- contingentRevenueHandling Eligible For Contingent Revenue Handling: boolean
-
Check this box to indicate that the item is subject to contingent revenue handling. When checked, revenue allocation is affected.
- costEstimate Item Defined Cost: number (double)
-
Enter an Item Defined Cost amount.
- costEstimateUnits Est. Cost Unit: string
- createExpensePlansOn: nsResource
- createRevenuePlansOn: nsResource
- createdDate Date Created: string (date-time)
- customForm: object
-
- id Internal identifier.: string -210 , -10211 , -10210
- refName Reference Name: string
- deferralAccount: account
- deferredRevenueAccount: account
- department: department
- description Description: string
- directRevenuePosting Direct Revenue Posting: boolean
-
Check this box to disable advanced revenue management for this item. When checked, posting transactions that include this item post directly to the item revenue account. No revenue element or revenue arrangement is created. When you check this box, the Deferred Revenue Account on the Accounting subtab is disabled. When you create sales transactions that include items that have this box checked, all the items in the transaction must have the box checked. You cannot mix items that post directly to revenue with items that post to deferred revenue in the same transaction. This restriction also applies to kit items. All items in a kit must post either to revenue or to deferred revenue. You cannot check or clear the box after the item has been used in a transaction with advanced revenue management. By default, this box is not checked.
- displayName Display Name/Code: string
-
Enter an optional name of up to 250 characters for this item in addition to the Item Name. If you are integrating with a Yahoo! store, this field is imported from Yahoo!. The display name prints in the Item column of sales forms when Basic printing is used. If this item is a member of a kit, this name appears in the Item column when the Print Items box is checked. If you do not enter a display name, the item name appears on printed forms.
- enforceminqtyinternally Enforce Minimum Internally: boolean
-
Check this box to apply the minimum quantity restriction on sales orders generated from NetSuite. When you clear this box, but enter a number in the Minimum Quantity field, the minimum quantity is only applied to web store orders.
- expenseAmortizationRule: nsResource
- externalId External ID: string
- hierarchyVersions: otherChargeSaleItem-hierarchyVersionsCollection
- id Internal ID: string
- includeChildren Include Children: boolean
-
Check the Include Children box to share the item with all the sub-subsidiaries associated with each subsidiary selected in the Subsidiary field. Note: When sharing items across subsidiaries, all of the options selected on the item record must be compatible across subsidiaries. For example, when entering an inventory item to be shared across subsidiaries, you should select Income and Asset accounts on the item record that are also shared across the same subsidiaries.
- incomeAccount: account
- insertItemAttribute: object
-
- id Internal identifier.: string class , department , itemid , location , issueproduct , vendorname
- refName Reference Name: string
- isFulfillable Can be Fulfilled: boolean
-
Check the Can be Fulfilled/Received box to enable this item to be received and fulfilled during order processing. Clear this box if this item does not require being received and fulfilled. Note: Once this item has been added to transactions, this setting cannot be changed. This field is used when the Advanced Billing and Advanced Shipping features are both enabled.
- isGCoCompliant Google Checkout Compliant: boolean
- isInactive Inactive: boolean
-
When you check this box, this item will no longer appear on a list unless you check the Show All box at the bottom of the list page.
- isOnline Display in Website: boolean
-
Check this box to make this item available online in your Web site. You cannot sell this item online unless you check this box. If the item is of the Other Charge for Sale or Resale subtype, checking this box does not make it available in the web store catalog. However, it becomes available during web store checkout.
- issueProduct: issueProduct
- itemId Item Name/Number: string
-
Enter up to 250 characters for the name of this item. This name appears in lists on transactions. If you have the option of entering a display name and do not, the item name prints in the Item column of sales forms when Basic printing is used. If you have the option to enter a vendor name and do not, the item name prints in the Item column of purchase forms. If you have entered a display name, it will print on purchases instead of the item name when Basic printing is used.
- itemRevenueCategory: nsResource
- itemType: object
-
- lastModifiedDate Last Modified: string (date-time)
- links Links: nsLink
-
nsLink - location: location
- matrixItemNameTemplate Matrix Item Name Template: string
-
This field is used to control how the matrix item will be displayed in the Matrix Item Name/Number field. Compose the order in which attributes and matrix options are displayed by selecting from the Insert Item Attribute and Insert Matrix Option dropdown lists. Add custom separator characters to easier distinguish the various options. Example: Item Name: Fabric / Color / Waist / Length [Location]
- matrixItemNameTemplateHelp Matrix Item Name Template: string
- matrixType: object
-
- id Internal identifier.: string , PARENT , CHILD
- refName Reference Name: string
- maximumquantity Maximum Order Qty: integer (int64)
-
Enter the greatest quantity of this item that customers can purchase. If customers enter an item quantity above the maximum amount, a warning message is displayed. Web store customers are unable to complete checkout unless they enter a quantity equal to or below the maximum quantity. Leave this field empty to allow customers to check out without maximum quantity restrictions. You can edit this warning at Setup > Site Builder/SuiteCommerce Advanced > Customize Text.
- minimumquantity Minimum Order Qty: integer (int64)
-
Enter the lowest quantity that customers can purchase. Web store customers receive a warning and cannot check out if they enter an item quantity below this minimum. Leave this field empty to allow customers to check out with no minimum quantity restrictions. You can edit this warning at Setup > Site Builder/SuiteCommerce Advanced > Customize Text.
- offerSupport Offer Support: boolean
-
Check this box to offer support for this particular item. By offering support for items, customers can select on case records which item they are having trouble with.
- overallQuantityPricingType: object
-
- id Internal identifier.: string ITEM , PARENT , SCHEDULE
- refName Reference Name: string
- parent: otherChargeSaleItem
- parentOnly Use as Category Only: boolean
- price: otherChargeSaleItem-price
- pricesIncludeTax Prices Include Tax: boolean
-
Check this box to save the base price as the tax inclusive price. Clear this box to save the base price as the tax exclusive price.
- pricingGroup: pricingGroup
- quantityPricingSchedule: nsResource
- rate Price: number (double)
-
Enter the rate for this discount or markup. The rate can be either a percentage or dollar amount. A percentage discount must be followed by a % sign. A dollar amount should be entered as a positive number.
- rateIncludingTax Price Including Tax: number (double)
- refName Reference Name: string
- residual Residual: number (double)
- revRecForecastRule: nsResource
- revReclassFxAccount: account
- revenueAllocationGroup: nsResource
- revenueRecognitionRule: nsResource
- saleUnit Primary Sale Unit: string
-
Select the unit you use to sell this item to customers on sales transactions.
- salesDescription Sales Description: string
-
Enter a sales description for this item. You can enter letters and numbers. There is a 999 character limit. The sales description displays on transactions such as sales orders, cash sales and invoices. If you use the Web Store feature, the sales description displays immediately under the item's store display name on item list pages in your store or site, if you have not entered a store description for an item. Enter the store description on the Store subtab of the item record. The sales description also displays by default when the item is in the Web store shopping cart.
- subsidiary: subsidiaryCollection
- subtype: object
-
- id Internal identifier.: string Sale , Purchase , Resale
- refName Reference Name: string
- unitsType: unitsType
- upcCode UPC Code: string
-
Enter a maximum of 999 characters in this field to identify an internal name or number to store the item's UPC Code. You can use the text you enter here when adding the item to transactions, searching, or viewing reports. * When you enter text in this field, the SKU/UPC field on item labels displays this UPC Code and prints in UPC bar code format. * When this field is clear, the SKU/UPC field on item labels displays the Item Name/Number and prints in Code-128 bar code format.
- useMarginalRates Use Marginal Rates: boolean
-
Check this box if you want the quantity discounts in the schedule to be applied to each pricing bracket separately. For example, a schedule offers no discount for the first 100 items sold and a 5% discount if more than 100 are sold. If 150 items are sold, the first 100 are at normal price, and the other fifty items are sold at 5% discount. Leave this box clear if you want the discount to apply to all of the items sold.
otherChargeSaleItem-accountingBookDetailCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: otherChargeSaleItem-accountingBookDetailElement
-
otherChargeSaleItem-accountingBookDetailElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
otherChargeSaleItem-accountingBookDetailElement
This record is available as a beta record.
- accountingBook: accountingBook
- amortizationTemplate: amortizationTemplate
- createExpensePlansOn: nsResource
- createRevenuePlansOn: nsResource
- links Links: nsLink
-
nsLink - refName Reference Name: string
- revRecForecastRule: nsResource
- revRecSchedule: revRecTemplate
- revenueRecognitionRule: nsResource
- sameAsPrimaryAmortization Same as Primary Book Amortization: boolean
- sameAsPrimaryRevRec Same as Primary Book Rev Rec: boolean
otherChargeSaleItem-hierarchyVersionsCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: otherChargeSaleItem-hierarchyVersionsElement
-
otherChargeSaleItem-hierarchyVersionsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
otherChargeSaleItem-hierarchyVersionsElement
This record is available as a beta record.
- endDate Hierarchy Version End Date: string (date)
- hierarchyNode: merchandiseHierarchyNode
- hierarchyVersion: merchandiseHierarchyVersion
- isIncluded Included In Version: boolean
- links Links: nsLink
-
nsLink - refName Reference Name: string
- startDate Hierarchy Version Start Date: string (date)
otherChargeSaleItem-price
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: otherChargeSaleItem-priceElement
-
otherChargeSaleItem-priceElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
otherChargeSaleItem-priceElement
This record is available as a beta record.
- currencyPage: currency
- discountDisplay Default Discount %: number (double)
- isInactive Inactive: boolean
-
When you check this box, this item will no longer appear on a list unless you check the Show All box at the bottom of the list page.
- links Links: nsLink
-
nsLink - price Amount: number (double)
- priceLevel: priceLevel
- priceLevelName Price Level: string
- priceQty Sequence Number: integer (int64)
- quantity: object
-
- value Value: string
- refName Reference Name: string
otherChargeSaleItemCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: otherChargeSaleItem
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
otherChargeSaleItem - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
otherName
This record is available as a beta record.
- accountNumber Account ID: string
-
If you assign accounts to your customers, enter an account number for this customer here.
- addressBook: otherName-addressBookCollection
- altEmail Alt. Email: string
- autoName Auto: boolean
-
Clear this box to manually enter a name for this record. If you leave this box marked, NetSuite assigns a name or number for this record based on your settings at Setup > Set Up Auto-Generated Numbers.
- balance Balance: number (double)
- campaigns: otherName-campaignsCollection
- category: otherNameCategory
- comments Comments: string
-
Enter any other information you want to note about this person or company.
- companyName Company Name: string
-
Enter the legal name of this person or company. This field is required for the Online Bill Pay feature.
- contact: contact
- contactList: contactCollection
- creditLimit Credit Limit: number (double)
-
Enter a credit limit to define the maximum currency amount the customer is allowed to accrue in outstanding receivables. When you meet or exceed this customer's limit while you are entering transactions, NetSuite can warn you or block the transaction. To set preferences for credit limit handling, an administrator must go to Setup > Accounting > Preferences > Accounting Preferences. On the General subtab, check the Customer Credit Limit Handling box and save. For more information, click Help at the top of the page and search for Customer Credit Limits and Holds.
- currency: currency
- dateCreated Date Created: string (date-time)
- defaultAddress Default Address: string
-
This field automatically shows the default billing address that you enter and add using the Address subtab.
- defaultShippingAddress Default Shipping Address: string
- defaultTaxReg Default Tax Reg. Number: string
-
Select the default tax registration number for this entity.
- email Other Name Email: string
-
Enter this person or company's e-mail address.
- emailPreference: object
-
- id Internal identifier.: string PDF , HTML , DEFAULT
- refName Reference Name: string
- entityId Entity ID: string
-
Enter a name for this other person or company the way it should appear in all lists. This field is required for the Online Bill Pay feature.
- entityStatus: object
-
- id Internal identifier.: string
- refName Reference Name: string
- externalId External ID: string
- fax Fax: string
-
Enter a fax number for this record. You should enter the fax number exactly as it must be dialed. If a '1' is required to fax to this number, be sure to include it at the beginning of the number. The number you enter here automatically appears in the To Be Faxed field of transactions when you select this customer. To fax NetSuite forms, an administrator must first set up fax service at Setup > Set Up Printing, Fax and E-mail > Fax.
- firstName First Name: string
-
Optionally enter a first name here.
- globalSubscriptionStatus: object
-
- id Internal identifier.: string 1 , 2 , 3 , 4
- refName Reference Name: string
- homePhone Home Phone: string
- id Internal ID: string
- image: nsResource
- isInactive Inactive: boolean
-
When you check this box, this item will no longer appear on a list unless you check the Show Inactives box at the bottom of the list page.
- isPerson Is Individual: boolean
-
Choose the type of other name record you are creating by selecting Company or Individual in the Type field. This selection determines which fields and subtabs are used on this record.
- lastModifiedDate Last Modified Date: string (date-time)
- lastName Last Name: string
- links Links: nsLink
-
nsLink - middleName Middle Name: string
- mobilePhone Mobile Phone: string
- openingBalance Opening Balance: number (double)
-
Enter the opening balance of this person or company's account.
- openingBalanceAccount: account
- openingBalanceDate Opening Balance Date: string (date)
-
Enter the date of the balance entered in the Opening Balance field.
- phone Phone: string
-
Enter a phone number for this record. This field is required for the Online Bill Pay feature.
- phoneticName Furigana: string
-
Enter the furigana character you want to use to sort this record.
- printOnCheckAs Print on Check As: string
-
Enter the name of this person or company the way it should appear on checks.
- refName Reference Name: string
- salutation Mr./Ms...: string
- subscriptionMessageHistory: otherName-subscriptionMessageHistoryCollection
- subscriptions: otherName-subscriptionsCollection
- subsidiary: subsidiary
- taxRegistration: otherName-taxRegistrationCollection
- terms: term
- title Job Title: string
- url URL: string
-
Enter this company or organization's Web address. This address acts as a link when you return to this record for viewing.
otherName-addressBook-addressBookAddress
This record is available as a beta record.
- addr1 Address 1: string
- addr2 Address 2: string
- addr3 Address 3: string
- addrPhone Phone: string
- addrText Address: string
- addressee Addressee: string
- attention Attention: string
- city City: string
- country: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- externalId External ID: string
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - override Override: boolean
- refName Reference Name: string
- state State/Province: string
- zip Zip: string
otherName-addressBookCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: otherName-addressBookElement
-
otherName-addressBookElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
otherName-addressBookElement
This record is available as a beta record.
- addressBookAddress: otherName-addressBook-addressBookAddress
- addressBookAddress_text Address: string
- addressId Internal ID: string
- defaultBilling Default Billing: boolean
- defaultShipping Default Shipping: boolean
- id ID: integer (int64)
- internalId Internal ID: integer (int64)
- label Label: string
- links Links: nsLink
-
nsLink - refName Reference Name: string
otherName-campaignsCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: otherName-campaignsElement
-
otherName-campaignsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
otherName-subscriptionMessageHistoryCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: otherName-subscriptionMessageHistoryElement
-
otherName-subscriptionMessageHistoryElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
otherName-subscriptionsCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: otherName-subscriptionsElement
-
otherName-subscriptionsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
otherName-subscriptionsElement
This record is available as a beta record.
- lastModifiedDate Last Modified: string (date-time)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- subscribed Subscribed: boolean
- subscription: nsResource
otherName-taxRegistrationCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: otherName-taxRegistrationElement
-
otherName-taxRegistrationElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
otherName-taxRegistrationElement
This record is available as a beta record.
- address Address: string
- id ID: integer (int64)
- links Links: nsLink
-
nsLink - nexus: nexus
- nexusCountry: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- nexusState: nsResource
- refName Reference Name: string
- taxRegistrationNumber Tax Reg. Number: string
otherNameCategory
This record is available as a beta record.
- externalId External ID: string
- id Internal ID: string
- isInactive Inactive: boolean
-
Check this box to remove all references to this record from your account. You can reactivate the record at any time.
- links Links: nsLink
-
nsLink - name Type: string
-
Enter the name for this record. This name appears in lists that include this record.
- refName Reference Name: string
otherNameCategoryCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: otherNameCategory
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
otherNameCategory - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
otherNameCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: otherName
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
otherName - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
partner
This record is available as a beta record.
- addressBook: partner-addressBookCollection
- altEmail Alt. Email: string
- autoName Auto: boolean
-
Clear this box to manually enter a name for this record. If you leave this box checked, NetSuite assigns a name or number for this record based on your settings at Setup > Company > Auto-Generated Numbers.
- campaigns: partner-campaignsCollection
- category: partnerCategoryCollection
- class: classification
- comments Comments: string
-
Enter any other information you want to note about this partner.
- companyName Company Name: string
-
Enter the legal name of this partner. If you use Auto-Generated Numbers, you may want to make sure you enter the partner name here so that it shows up in the Partners list.
- contact: contact
- contactList: contactCollection
- contactRoles: partner-contactRolesCollection
- customForm: object
-
- id Internal identifier.: string -10052 , -10051 , -10050
- refName Reference Name: string
- dateCreated Date Created: string (date-time)
- defaultAddress Default Address: string
-
This field automatically shows the default billing address that you enter and add using the Address subtab.
- defaultShippingAddress Default Shipping Address: string
- defaultTaxReg Default Tax Reg. Number: string
-
Select the default tax registration number for this entity.
- department: department
- eligibleForCommission Eligible for Commission: boolean
-
Check this box if you want this partner to be able to earn commission or royalties. Partners must be assigned to a partner commission plan before they can earn commission.
- email Partner Email: string
-
Enter this partner's email address. If you enter an email address, you can email this partner directly from the Partners list.
- emailPreference: object
-
- id Internal identifier.: string PDF , HTML , DEFAULT
- refName Reference Name: string
- entityId Entity ID: string
-
Enter the partner's name here the way it should appear in all lists. If you use Auto-Generated Numbering, this field fills with the number for this vendor.
- externalId External ID: string
- fax Fax: string
-
Enter a fax number for this record. You should enter the fax number exactly as it must be dialed. If a '1' is required to fax to this number, be sure to include it at the beginning of the number. The number you enter here automatically appears in the To Be Faxed field of transactions when you select this customer. To fax NetSuite forms, an administrator must first set up fax service at Setup > Set Up Printing, Fax and E-mail > Fax.
- firstName First Name: string
- giveAccess Login Access: boolean
-
Check this box to give your partner access to NetSuite.
- globalSubscriptionStatus: object
-
- id Internal identifier.: string 1 , 2 , 3 , 4
- refName Reference Name: string
- homePhone Home Phone: string
- id Internal ID: string
-
The internal ID for this record is shown here. If you do not want to show internal IDs, clear the Show Internal IDs box at Home > Set Preferences.
- image: nsResource
- isInactive Inactive: boolean
-
When you check this box, this partner no longer appears on the Partners list unless you check the Show Inactives box at the bottom of the page. Also, you can no longer select this partner from any lists on transactions, contact records, task records or event records.
- isPerson Is Individual: boolean
-
Choose the type of customer record you are creating by selecting Company or Individual in the Type field. This selection determines which fields and subtabs are used on this record.
- lastModifiedDate Last Modified Date: string (date-time)
- lastName Last Name: string
- links Links: nsLink
-
nsLink - location: location
- middleName Middle Name: string
- mobilePhone Mobile Phone: string
- parent: partner
- partnerCode Partner Code: string
-
This field autofills with what you entered in the Partner field. You can edit in this field if you need to change the code.
- password Password: string
-
Assign a password to give this partner access to NetSuite. The Password Criteria fields will ensure that you create a password that meets the password policy in effect in your account. You will need to tell the user the password you assign. It is not provided in the email notification. When you assign a password manually, you should also check the Require Password Change on Next Login box. For more information, see the help topic NetSuite Password Requirements.
- password2 Confirm Password: string
-
Reenter the password in this field to confirm that you entered the same password twice.
- phone Phone: string
-
Enter a phone number for this partner. This number appears in the Partners list. This field is required for the Online Bill Pay feature.
- phoneticName Furigana: string
-
Enter the furigana character you want to use to sort this record.
- prevEligibleForCommission: boolean
- printOnCheckAs Print on Check As: string
-
What you enter here prints on the Pay to the Order of line of a check instead of what you entered in the Partner field.
- refName Reference Name: string
- referringUrl Referring URL: string
-
This is the URL you should provide to this partner for referring new customers. When a customer follows this link and registers with your Web site, the partner is associated with the customer record that is created.
- requirePwdChange Require Password Change On Next Login: boolean
-
Check this box to require this user to change their password on their next login to NetSuite. When the user next logs in, they see the Change Password page and cannot access other NetSuite pages until a new password is created and saved. Requiring this action protects your account from unauthorized access using generic passwords and prepares your account for an audit. The Require Password Change on Next Login box never displays as checked. When you check this box and save the record, an internal flag is set. When the password change occurs, the flag is cleared. If you later check the box again and save the record, the internal flag is reset to require another password change.
- salutation Mr./Ms...: string
-
Enter the appropriate salutation for this partner.
- sendEmail Send New Access Notification Email: boolean
-
Check this box to automatically send a notification email to the partner that you have given them access to NetSuite. The standard NetSuite email message also contains a link to let the user create a password. If you do not check this box, you must check the Manually Assign or Change Password box. You must create the password, and tell the user the password, and when and how to log in. For security reasons, do not send the password by email.
- subpartnerLogin Can give login access to sub-partners: boolean
-
Check this box to let this partner create subpartner records and give them access to NetSuite. Subpartners can only see information that applies to their parent partner.
- subscriptionMessageHistory: partner-subscriptionMessageHistoryCollection
- subscriptions: partner-subscriptionsCollection
- subsidiary: subsidiary
- taxRegistration: partner-taxRegistrationCollection
- title Job Title: string
- url URL: string
-
If this partner has a Web site, enter the URL for the site here. Web addresses must begin with http:// or https://
partner-addressBook-addressBookAddress
This record is available as a beta record.
- addr1 Address 1: string
- addr2 Address 2: string
- addr3 Address 3: string
- addrPhone Phone: string
- addrText Address: string
- addressee Addressee: string
- attention Attention: string
- city City: string
- country: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- externalId External ID: string
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - override Override: boolean
- refName Reference Name: string
- state State/Province: string
- zip Zip: string
partner-addressBookCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: partner-addressBookElement
-
partner-addressBookElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
partner-addressBookElement
This record is available as a beta record.
- addressBookAddress: partner-addressBook-addressBookAddress
- addressBookAddress_text Address: string
- addressId Internal ID: string
- defaultBilling Default Billing: boolean
- defaultShipping Default Shipping: boolean
- id ID: integer (int64)
- internalId Internal ID: integer (int64)
- label Label: string
- links Links: nsLink
-
nsLink - refName Reference Name: string
partner-campaignsCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: partner-campaignsElement
-
partner-campaignsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
partner-contactRolesCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: partner-contactRolesElement
-
partner-contactRolesElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
partner-contactRolesElement
This record is available as a beta record.
- contact: contact
- contactName Contact: string
- email Email: string
- giveAccess Access: boolean
- links Links: nsLink
-
nsLink - password Password: string
- passwordConfirm Confirm Password: string
- refName Reference Name: string
- role: nsResource
partner-subscriptionMessageHistoryCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: partner-subscriptionMessageHistoryElement
-
partner-subscriptionMessageHistoryElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
partner-subscriptionsCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: partner-subscriptionsElement
-
partner-subscriptionsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
partner-subscriptionsElement
This record is available as a beta record.
- lastModifiedDate Last Modified: string (date-time)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- subscribed Subscribed: boolean
- subscription: nsResource
partner-taxRegistrationCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: partner-taxRegistrationElement
-
partner-taxRegistrationElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
partner-taxRegistrationElement
This record is available as a beta record.
- address Address: string
- id ID: integer (int64)
- links Links: nsLink
-
nsLink - nexus: nexus
- nexusCountry: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- nexusState: nsResource
- refName Reference Name: string
- taxRegistrationNumber Tax Reg. Number: string
partnerCategory
This record is available as a beta record.
- externalId External ID: string
- id Internal ID: string
- isInactive Inactive: boolean
-
Check this box to inactivate this contact category.
- links Links: nsLink
-
nsLink - name Partner Category/Role: string
-
Enter the name for this contact category.
- parent: partnerCategory
- refName Reference Name: string
partnerCategoryCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: partnerCategory
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
partnerCategory - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
partnerCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: partner
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
partner - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
paycheck
This record is available as a beta record.
- account: account
- address Address: string
-
Accept or enter the address of the employee.
- allowcdlperline Classify Individual Paycheck Lines: boolean
-
Check this box to classify individual line items on this paycheck by department, location, or class. You can classify earnings, deductions, taxes, or contributions.
- balance Balance: number (double)
-
NetSuite displays the balance in the bank account you selected.
- chkamount Amount: number (double)
- class: classification
- cleared Cleared: boolean
- clearedDate Date Cleared: string (date)
- createdDate Date Created: string (date-time)
- department: department
- entity: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- excludeFromGLNumbering Exclude from GL Audit Numbering: boolean
- externalId External ID: string
- id Internal ID: string
- lastModifiedDate Date Last Modified: string (date-time)
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
-
Enter a memo that prints on the check itself.
- origtotal Total: number (float)
- paybonuses: paycheck-paybonusesCollection
- paycomm: paycheck-paycommCollection
- paycontrib: paycheck-paycontribCollection
- paydeduct: paycheck-paydeductCollection
- payearn: paycheck-payearnCollection
- payexp: paycheck-payexpCollection
- paypto: paycheck-payptoCollection
- paysummary: paycheck-paysummaryCollection
- paytax: paycheck-paytaxCollection
- paytime: paycheck-paytimeCollection
- periodEnding Period Ending: string (date)
-
This is the last date in the payroll period.
- postingPeriod: accountingPeriod
- prevDate Previous Effective Date: string (date)
- refName Reference Name: string
- startDate Period Start Date: string (date)
- status Status: string
- statusRef Reference: string
- subsidiary: subsidiary
- tranDate Date: string (date)
-
NetSuite inserts today's date for the posting date of this paycheck. You can type or pick another date. What you enter here determines the date range in which this transaction appears on the Bank Register. You can select or enter custom date ranges on registers.
- tranId Check #: string
-
If you have checked the To Be Printed box, you will choose starting numbers later, when you print those checks. If you are immediately printing this check, NetSuite increases the largest check number by one. You can type another number here, but the next number will revert to the standard pattern.
- useramount Amount: number (double)
-
NetSuite will calculate the net pay amount as you add or edit individual items on the tabs below.
- workplace: workplace
paycheck-paybonusesCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: paycheck-paybonusesElement
-
paycheck-paybonusesElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
paycheck-paybonusesElement
This record is available as a beta record.
- amount Amount: number (double)
- bonusid Bonus: integer (int64)
- bonustype: nsResource
- class: classification
- department: department
- grantdate Award Date: string (date)
- line Line: integer (int64)
- links Links: nsLink
-
nsLink - location: location
- nid ID: integer (int64)
- payitem: payrollItem
- payitemworkplace: workplace
- refName Reference Name: string
paycheck-paycommCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: paycheck-paycommElement
-
paycheck-paycommElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
paycheck-paycommElement
This record is available as a beta record.
- amount Amount: number (double)
- apply Pay: boolean
- line Line: integer (int64)
- links Links: nsLink
-
nsLink - nid ID: integer (int64)
- origdoc Orig Transaction Document: integer (int64)
- payitem: payrollItem
- payitemworkplace: workplace
- refName Reference Name: string
- transaction Transaction: string
paycheck-paycontribCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: paycheck-paycontribElement
-
paycheck-paycontribElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
paycheck-paycontribElement
This record is available as a beta record.
- amount Amount: number (double)
- class: classification
- department: department
- line Line: integer (int64)
- links Links: nsLink
-
nsLink - location: location
- manualentry Manual Entry: boolean
- nid ID: integer (int64)
- payitem: payrollItem
- refName Reference Name: string
- wagebase Wage Base: number (double)
paycheck-paydeductCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: paycheck-paydeductElement
-
paycheck-paydeductElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
paycheck-paydeductElement
This record is available as a beta record.
- amount Amount: number (double)
- class: classification
- department: department
- line Line: integer (int64)
- links Links: nsLink
-
nsLink - location: location
- manualentry Manual Entry: boolean
- nid ID: integer (int64)
- payitem: payrollItem
- refName Reference Name: string
- wagebase Wage Base: number (double)
paycheck-payearnCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: paycheck-payearnElement
-
paycheck-payearnElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
paycheck-payearnElement
This record is available as a beta record.
- basedonquan Based on Quantity: boolean
- class: classification
- count Hours/Base: number (float)
- custjob: nsResource
- department: department
- grossamount Amount: number (double)
- line Line: integer (int64)
- links Links: nsLink
-
nsLink - location: location
- manualentry Manual Entry: boolean
- nid ID: integer (int64)
- payitem: payrollItem
- payitemworkplace: workplace
- rate Rate: number (double)
- refName Reference Name: string
- serviceItem: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
paycheck-payexpCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: paycheck-payexpElement
-
paycheck-payexpElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
paycheck-payexpElement
This record is available as a beta record.
- amount Amount: number (double)
- apply Pay: boolean
- line Line: integer (int64)
- links Links: nsLink
-
nsLink - nid ID: integer (int64)
- origdoc Orig Transaction Document: integer (int64)
- payitem: payrollItem
- refName Reference Name: string
- transaction Transaction: string
paycheck-payptoCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: paycheck-payptoElement
-
paycheck-payptoElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
paycheck-payptoElement
This record is available as a beta record.
- hoursaccrued Hours Accrued: number (float)
- hoursbalance Balance: number (float)
- hoursused Hours Used: number (float)
- links Links: nsLink
-
nsLink - nid ID: integer (int64)
- payitem: payrollItem
- refName Reference Name: string
paycheck-paysummaryCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: paycheck-paysummaryElement
-
paycheck-paysummaryElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
paycheck-paysummaryElement
This record is available as a beta record.
- amount Amount: number (double)
- itemcategory Item Category: string
- links Links: nsLink
-
nsLink - payitem: payrollItem
- payitemtype: object
-
- refName Reference Name: string
- sortcolumn Sort By: string
- value Value: number (double)
paycheck-paytaxCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: paycheck-paytaxElement
-
paycheck-paytaxElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
paycheck-paytaxElement
This record is available as a beta record.
- amount Amount: number (double)
- apply Apply: boolean
- class: classification
- department: department
- editable Edit: string
- isExempt Exempt: boolean
- isresidenttax Resident Status: boolean
- line Line: integer (int64)
- links Links: nsLink
-
nsLink - location: location
- nid ID: integer (int64)
- paytax: payrollItem
- refName Reference Name: string
- reportablewagebase Reportable Wage Base: number (double)
- sequence Sequence # : integer (int64)
- taxablewagebase Taxable Wage Base: number (double)
- taxedwagebase Taxed Wage Base: number (double)
paycheck-paytimeCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: paycheck-paytimeElement
-
paycheck-paytimeElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
paycheck-paytimeElement
This record is available as a beta record.
- amount Amount: number (double)
- apply Pay: boolean
- class: classification
- count Hours: number (float)
- custjob: nsResource
- ddate Date: string (date)
- department: department
- line Line: integer (int64)
- links Links: nsLink
-
nsLink - location: location
- nid ID: integer (int64)
- origdoc Orig Transaction Document: integer (int64)
- payitem: payrollItem
- payitemworkplace: workplace
- rate Rate: number (double)
- refName Reference Name: string
- serviceItem: nsResource
paycheckCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: paycheck
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
paycheck - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
paycheckJournal
This record is available as a beta record.
- account: account
- class: classification
- companycontribution: paycheckJournal-companycontributionCollection
- companytax: paycheckJournal-companytaxCollection
- createdDate Date Created: string (date-time)
- currency: currency
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- deduction: paycheckJournal-deductionCollection
- department: department
- earning: paycheckJournal-earningCollection
- employee: employee
- employeetax: paycheckJournal-employeetaxCollection
- exchangerate Exchange Rate: number (float)
-
The value of this field is set to 1 when a currency is selected and should not be changed. It may be used in the future for multiple currency support.
- excludeFromGLNumbering Exclude from GL Audit Numbering: boolean
- externalId External ID: string
- id Internal ID: string
- lastModifiedDate Date Last Modified: string (date-time)
- links Links: nsLink
-
nsLink - location: location
- postingPeriod: accountingPeriod
- prevDate Previous Effective Date: string (date)
- refName Reference Name: string
- subsidiary: subsidiary
- tranDate Date: string (date)
-
Accept today's Date as the transaction date, or select another date.
- tranId Entry No.: string
-
The transaction ID number shows in this field. If you use auto-generated numbering, the next number in the sequence shows by default.
paycheckJournal-companycontributionCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: paycheckJournal-companycontributionElement
-
paycheckJournal-companycontributionElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
paycheckJournal-companycontributionElement
This record is available as a beta record.
- amount Amount: number (double)
- class: classification
- department: department
- id Line Id: integer (int64)
- links Links: nsLink
-
nsLink - location: location
- payrollItem: payrollItem
- refName Reference Name: string
paycheckJournal-companytaxCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: paycheckJournal-companytaxElement
-
paycheckJournal-companytaxElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
paycheckJournal-companytaxElement
This record is available as a beta record.
- amount Amount: number (double)
- class: classification
- department: department
- id Line Id: integer (int64)
- links Links: nsLink
-
nsLink - location: location
- payrollItem: payrollItem
- refName Reference Name: string
paycheckJournal-deductionCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: paycheckJournal-deductionElement
-
paycheckJournal-deductionElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
paycheckJournal-deductionElement
This record is available as a beta record.
- amount Amount: number (double)
- class: classification
- department: department
- id Line Id: integer (int64)
- links Links: nsLink
-
nsLink - location: location
- payrollItem: payrollItem
- refName Reference Name: string
paycheckJournal-earningCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: paycheckJournal-earningElement
-
paycheckJournal-earningElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
paycheckJournal-earningElement
This record is available as a beta record.
- amount Amount: number (double)
- class: classification
- department: department
- hours Hours: number (float)
- id Line Id: integer (int64)
- links Links: nsLink
-
nsLink - location: location
- payrollItem: payrollItem
- refName Reference Name: string
paycheckJournal-employeetaxCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: paycheckJournal-employeetaxElement
-
paycheckJournal-employeetaxElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
paycheckJournal-employeetaxElement
This record is available as a beta record.
- amount Amount: number (double)
- class: classification
- department: department
- id Line Id: integer (int64)
- links Links: nsLink
-
nsLink - location: location
- payrollItem: payrollItem
- refName Reference Name: string
paycheckJournalCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: paycheckJournal
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
paycheckJournal - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
paymentItem
This record is available as a beta record.
- account: account
- availableToPartners Available to Adv. Partners: boolean
-
Check this box to make this item available to partners with the Advanced Partner Center role for viewing. These items are also available to partners with roles that are customized for the Advanced Partner Center and include view, create or edit access to item records.
- class: classification
- createdDate Date Created: string (date-time)
- customForm: object
-
- id Internal identifier.: string -10240 , -240
- refName Reference Name: string
- department: department
- description Description: string
-
Enter a description for this item. This description will appear in the Description column of sales forms.
- displayName Display Name/Code: string
-
Enter an optional name of up to 250 characters for this item in addition to the Item Name. If you are integrating with a Yahoo! store, this field is imported from Yahoo!. The display name prints in the Item column of sales forms when Basic printing is used. If this item is a member of a kit, this name appears in the Item column when the Print Items box is checked. If you do not enter a display name, the item name appears on printed forms.
- externalId External ID: string
- id Internal ID: string
- includeChildren Include Children: boolean
-
Check the Include Children box to share the item with all the sub-subsidiaries associated with each subsidiary selected in the Subsidiary field. Note: When sharing items across subsidiaries, all of the options selected on the item record must be compatible across subsidiaries. For example, when entering an inventory item to be shared across subsidiaries, you should select Income and Asset accounts on the item record that are also shared across the same subsidiaries.
- isInactive Inactive: boolean
-
When you check this box, this item will no longer appear on a list unless you check the Show All box at the bottom of the list page.
- issueProduct: issueProduct
- itemId Item Name/Number: string
-
Enter up to 250 characters for the name of this item. This name appears in lists on transactions. If you have the option of entering a display name and do not, the item name prints in the Item column of sales forms when Basic printing is used. If you have the option to enter a vendor name and do not, the item name prints in the Item column of purchase forms. If you have entered a display name, it will print on purchases instead of the item name when Basic printing is used.
- itemType: object
-
- lastModifiedDate Last Modified: string (date-time)
- links Links: nsLink
-
nsLink - location: location
- paymentMethod: paymentMethod
- refName Reference Name: string
- subsidiary: subsidiaryCollection
- undepFunds: object
-
- id Internal identifier.: string T , F
- refName Reference Name: string
paymentItemCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: paymentItem
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
paymentItem - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
paymentMethod
This record is available as a beta record.
- account: account
- bAch: string
- cardBrands: nsResourceCollection
- countries: nsResourceCollection
- creditCard Credit Card: boolean
- externalCheckout External Checkout: boolean
- externalId External ID: string
- id Internal ID: string
- isDebitCard Debit Card: boolean
-
Check this box if the payment method is a type of debit card.
- isEmv EMV: boolean
- isInactive Inactive: boolean
-
Check this box to remove all references to this record from your account. You can reactivate the record at any time.
- isLineLevelDataRequired Requires Line-Level Data: boolean
-
Check this box if this payment method requires sending line-level data in the request NetSuite sends to the payment gateway. Line-level data of a transaction include quantity, total amount, tax rate, unit of measure, type, tax amount, and unit cost of each line item on the transaction.
- isOnline Display in Website: boolean
-
Check this box to allow customers to use this in the web store.
- isTokenized Tokenized: boolean
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - longitemtype: string
- merchantAccounts: nsResourceCollection
- methodType: object
-
- id Internal identifier.: string 1 , 2 , 13 , 3 , 4 , 5 , 6 , 9
- refName Reference Name: string
- name Name: string
-
Enter the name for this record. This name appears in lists that include this record.
- paypal: boolean
- refName Reference Name: string
- tname: string
- undepFunds: object
-
- id Internal identifier.: string
- refName Reference Name: string
- visuals: paymentMethod-visualsCollection
paymentMethod-visualsCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: paymentMethod-visualsElement
-
paymentMethod-visualsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
paymentMethodCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: paymentMethod
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
paymentMethod - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
payrollItem
This record is available as a beta record.
- accountcategory: object
-
- id Internal identifier.: string Expense , Liability , Asset
- refName Reference Name: string
- allowbulkentry Allow Entry from Create Payroll: boolean
-
Check Allow entry from Create Payroll if you want to be able to enter or edit an amount for this payroll item from the Create Payroll page. This option is only available for Earning:Wage and Earning:Addition items.
- applylimit Apply Limit to All Employees: boolean
-
Check this box to apply the indicated limit to all employees. Clear this box to apply the limit only to select employees.
- applyrate Apply Rate to All Employees: boolean
-
Check this box to apply the indicated rate to all employees. Clear this box to apply the rate only to select employees.
- assetaccount: account
- basedOnQuantity Based on Quantity: boolean
-
Check this box if the item is calculated on the basis of a quantity (such as hours or miles) entered for or by the employee.
- defaultRate Default Rate: number (double)
-
Enter a default amount or percentage rate for this payroll item in the Default Rate field. For example, enter 2.00 for two dollars, or 2% for two percent. The rate you enter is automatically inserted for all new employees. If there is no typical rate, leave this field blank. You can enter individual rates on each employee's record.
- deriveRateFromRetirementPlan: nsResource
- derivedratemultiplier Rate Multiplier: number (float)
-
Enter a number, not a percentage. This number can be a decimal fraction. Negative numbers are also supported. The derived rate for the payroll item is the Multiplier times the pay rate of the payroll item selected in the Derived From field.
- deriveratefrompayrollitem: payrollItem
- deriveratefrompayrollitemgroup: nsResource
- deriveratefromtype: object
-
- id Internal identifier.: string , payrollitem , payrollitemgroup , retirementplan
- refName Reference Name: string
- description Description: string
-
Enter a description for this payroll item that will appear on the Summary tab of employee paychecks. This description can be useful if a payroll item name is not meaningful to your employees. Descriptions appear on paychecks only if you check the Show Descriptions on Summary Tab of Paychecks box at Setup > Payroll > Set Up Payroll.
- employeePaid Employee Paid: boolean
-
When this box is clear, the item type is Company Tax. When this box is checked, the item type is Employee tax.
- expenseAccount: account
- externalId External ID: string
- id Internal ID: string
- inactive Inactive: boolean
-
Check this box if you want to make this item inactive. When you check this box, this item no longer appears on your list of payroll items unless you check the Show Inactives box at the bottom of the list page.
- itemType: object
-
- liabilityAccount: account
- limit Limit: number (double)
-
Enter a dollar amount equal to the annual limit for this payroll item. Once the earning, deduction, or contribution reaches this limit, even in the middle of a payroll run, it will no longer be included in payroll calculations. If there is no limit, you can leave this blank.
- limitiswithholding: object
-
- id Internal identifier.: string wage , withholding
- refName Reference Name: string
- limitiswithholdingtype Limit Type: string
- limittype Limit Type: string
-
Choose whether this limit is for wages or withholding amounts.
- links Links: nsLink
-
nsLink - masterpaycode Pay Code: string
-
Select the appropriate pay code in this field.
- name Item Name: string
-
Enter the name of the payroll item.
- refName Reference Name: string
- reportingSection: object
-
- id Internal identifier.: string
- refName Reference Name: string
- showinemployeecenter View in Employee Center: boolean
-
Check this box if you want this Employer Contribution Item Type to be visible to the employee in the Employee Center.
- subsidiary: subsidiary
- usedefaults Use System Defaults: boolean
-
This field indicates whether this payroll item uses the defaults for its item type.
- vendor: vendor
payrollItemCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: payrollItem
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
payrollItem - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
pctCompleteProjectRevenueRule
This record is available as a beta record.
- amountLeftToRecognize Difference: number (double)
- chargeRule: pctCompleteProjectRevenueRule-chargeRuleCollection
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- description Description: string
-
Enter a description for this project revenue rule.
- externalId External ID: string
- id Internal ID: string
- isInactive Inactive: boolean
-
Check this box to inactivate this rule.
- links Links: nsLink
-
nsLink - name Name: string
-
Enter a name for this project revenue rule.
- project: job
- recognizedAmountSoFar Revenue: number (double)
- refName Reference Name: string
- revenueReconciled Revenue Reconciled: boolean
- serviceItem: nsResource
- totalAmountToRecognize Charges: number (double)
-
This is the total amount of charges available for this rule.
pctCompleteProjectRevenueRule-chargeRuleCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: pctCompleteProjectRevenueRule-chargeRuleElement
-
pctCompleteProjectRevenueRule-chargeRuleElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
pctCompleteProjectRevenueRule-chargeRuleElement
This record is available as a beta record.
- billingItem: nsResource
- chargeRule: chargeRule
- description Description: string
- forecastAmount Amount: number (double)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- ruleType: object
-
- id Internal identifier.: string PROJECTPROGRESS , MILESTONE , FIXEDDATE , TIMEBASED , EXPENSEBASED , PURCHASE
- refName Reference Name: string
pctCompleteProjectRevenueRuleCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: pctCompleteProjectRevenueRule
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
pctCompleteProjectRevenueRule - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
periodEndJournal
This record is available as a beta record.
- accountingBook: accountingBook
- approvalStatus: object
-
- id Internal identifier.: string 11 , 1 , 2 , 3
- refName Reference Name: string
- approved Approved: boolean
- class: classification
- createdDate Date Created: string (date-time)
- creditTotal Credit: number (double)
-
This is the total required to balance the lines in the list below.
- currency: currency
- currencyPrecision Currency Precision: string
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- debitTotal Debit: number (double)
-
This is the total required to balance the lines in the list below.
- department: department
- excludeFromGLNumbering Exclude from GL Audit Numbering: boolean
- externalId External ID: string
- id Internal ID: string
- lastModifiedDate Date Last Modified: string (date-time)
- line: periodEndJournal-lineCollection
- links Links: nsLink
-
nsLink - location: location
- mainAccount: account
- memo Memo: string
- nextApprover: employee
- pairedPEJE: periodEndJournal
- pejetype: string
- postingPeriod: accountingPeriod
- prevDate Previous Effective Date: string (date)
- refName Reference Name: string
- sourceSubsidiary: subsidiary
- status: object
-
- id Internal identifier.: string A , R , B , Y
- refName Reference Name: string
- subsidiary: subsidiary
- tranDate Date: string (date)
-
The Date is the last day of the accounting period, with one exception. For the Balance Sheet Closing Reversal, if applicable, the date is the first day of the period following the fiscal year end.
- tranId Entry No.: string
-
This is the document number. It is automatically generated when the record is saved.
periodEndJournal-lineCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: periodEndJournal-lineElement
-
periodEndJournal-lineElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
periodEndJournalCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: periodEndJournal
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
periodEndJournal - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
phoneCall
- accessLevel Private: boolean
-
Check this box to have this call show only in your Phone Calls list. Calls that are not private can be seen by others with access to your account.
- assigned: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- bom: bom
- bomRevision: bomRevision
- company: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- completedDate Date Completed: string (date)
-
Enter the date the subject for this call was concluded. This field can be useful if the call required a follow-up or call back or was not completed on the call date for another reason.
- contact: contact
- createdDate Date Created: string (date-time)
- customForm: object
-
- id Internal identifier.: string -10150 , -150
- refName Reference Name: string
- endTime End time: string
-
Enter the end time for placing this call on the organizer's calendar. You must check the Reserve Time box to set a time in this field.
- externalId External ID: string
- id Internal ID: string
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - message Comments: string
-
Enter notes on the context and decisions made in this phone call. You can enter up to 999 characters.
- mfgRouting: manufacturingRouting
- owner: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- phone Phone: string
-
Enter the phone number used for this call. Phone numbers can be entered in the following formats: 999-999-9999, 1-999-999-9999, (999) 999-9999, 1(999) 999-9999 or 999-999-9999 ext 9999.
- priority: object
-
- id Internal identifier.: string HIGH , MEDIUM , LOW
- refName Reference Name: string
- refName Reference Name: string
- relatedItem: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- reminderMinutes: object
-
- id Internal identifier.: string 0 , 5 , 10 , 15 , 30
- refName Reference Name: string
- reminderType: object
-
- id Internal identifier.: string POPUP , EMAIL
- refName Reference Name: string
- sendEmail Send email: boolean
- startDate Start Date: string (date)
-
Enter the date of this call. Click the calendar icon to choose the date from the calendar.
- startTime Start Time: string
-
Enter the start time for placing this call on the organizer's calendar. You must check the Reserve Time box to set a time in this field.
- status: object
-
- id Internal identifier.: string SCHEDULED , FAILED , COMPLETE
- refName Reference Name: string
- supportCase: supportCase
- timedEvent Timed Event: boolean
-
Check this box to schedule this call on the calendar of the person organizing the call. Enter the start and end times in the From and To fields. This time is scheduled on the calendar for the phone call date.
- timezone Time Zone: string
- title Title: string
-
Enter the subject of this phone call. You can enter up to 100 characters.
- transaction: nsResource
phoneCallCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: phoneCall
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
phoneCall - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
plannedOrder
This record is available as a beta record.
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- endDate End Date: string (date)
- externalId External ID: string
- firmed Firmed: boolean
- id Internal ID: string
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemType: object
-
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
- quantity Quantity: string
- refName Reference Name: string
- released Released: boolean
- sourceLocation: location
- startDate Start Date: string (date)
- supplyPlanDefinition: supplyPlanDefinition
- transactionCreated: nsResource
- transactionType: object
-
- id Internal identifier.: string WorkOrd , TrnfrOrd , PurchOrd
- refName Reference Name: string
plannedOrderCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: plannedOrder
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
plannedOrder - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
planningItemCategoryCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: planningItemCategory
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
planningItemCategory - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
planningItemGroup
This record is available as a beta record.
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- description Description: string
- externalId External ID: string
- id Internal ID: string
- links Links: nsLink
-
nsLink - name Name: string
- planningItems: planningItemGroup-planningItemsCollection
- refName Reference Name: string
planningItemGroup-planningItemsCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: planningItemGroup-planningItemsElement
-
planningItemGroup-planningItemsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
planningItemGroup-planningItemsElement
This record is available as a beta record.
- id Internal ID: integer (int64)
- item Item: integer (int64)
- itemDescription Description: string
- itemOrCategory: nsResource
- itemType: object
-
- id Internal identifier.: string , ITEM , CATEGORY
- refName Reference Name: string
- links Links: nsLink
-
nsLink - planningItemCategory Planning Item Category: integer (int64)
- refName Reference Name: string
planningItemGroupCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: planningItemGroup
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
planningItemGroup - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
planningRuleGroup
This record is available as a beta record.
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- description Description: string
- externalId External ID: string
- id Internal ID: string
- links Links: nsLink
-
nsLink - name Name: string
- planningRules: planningRuleGroup-planningRulesCollection
- refName Reference Name: string
planningRuleGroup-planningRulesCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: planningRuleGroup-planningRulesElement
-
planningRuleGroup-planningRulesElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
planningRuleGroup-planningRulesElement
This record is available as a beta record.
- action: object
-
- id Internal identifier.: string TRANSFER
- refName Reference Name: string
- id Internal ID: integer (int64)
- item Item: integer (int64)
- itemDescription Description: string
- itemOrCategory: nsResource
- itemType: object
-
- id Internal identifier.: string , ITEM , CATEGORY
- refName Reference Name: string
- leadTime Lead Time (Days): integer (int64)
- links Links: nsLink
-
nsLink - location: location
- planningItemCategory Planning Item Category: integer (int64)
- refName Reference Name: string
- sourceLocation: location
planningRuleGroupCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: planningRuleGroup
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
planningRuleGroup - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
planningView
This record is available as a beta record.
- action: nsResourceCollection
- demand: nsResourceCollection
- exception: nsResourceCollection
- externalId External ID: string
- id Internal ID: string
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- links Links: nsLink
-
nsLink - name Name: string
- planningItemCategory: planningItemCategory
- refName Reference Name: string
- relativeEndDays Relative End Date (Days): integer (int64)
- savedSearch: nsResource
- supply: nsResourceCollection
- supplyReplenishmentType: object
-
- id Internal identifier.: string MPS , MRP
- refName Reference Name: string
planningViewCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: planningView
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
planningView - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
priceBook
- currency: currency
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- externalId External ID: string
- id Internal ID: string
- links Links: nsLink
-
nsLink - name Name: string
-
Enter a name to identify the subscription. If you leave this field blank, NetSuite automatically generates a subscription name upon saving.
- priceInterval: priceBook-priceIntervalCollection
- refName Reference Name: string
- subscriptionPlan: subscriptionPlan
priceBook-priceIntervalCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: priceBook-priceIntervalElement
-
priceBook-priceIntervalElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
priceBook-priceIntervalElement
- chargeType: object
-
- id Internal identifier.: string 1 , 2 , 3 , 4
- refName Reference Name: string
- discount Discount: number (double)
- frequency: object
-
- id Internal ID: integer (int64)
- isRequired Required: boolean
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- lineNumber Line Number: integer (int64)
- links Links: nsLink
-
nsLink - multiplierLine Included Quantity Multiplier: string
- overageDiscount Overage Discount: number (double)
- overageFrequency: object
-
- overagePricePlan: pricePlan
- overageRepeatEvery Overage Repeat Every: integer (int64)
- pricePlan: pricePlan
- prorateBy: object
-
- id Internal identifier.: string MONTH , DAY
- refName Reference Name: string
- refName Reference Name: string
- repeatEvery Repeat Every: integer (int64)
- startOffsetUnit: object
-
- id Internal identifier.: string MONTH , YEAR , WEEK
- refName Reference Name: string
- startOffsetValue Start On: integer (int64)
- subscriptionPlanLineNumber: integer (int64)
priceBookCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: priceBook
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
priceBook - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
priceLevel
This record is available as a beta record.
- discountPct Markup/Discount %: number (double)
-
If you like, enter a positive or negative percentage to mark up or discount prices for this price level. Prices for this level are calculated by applying the positive or negative percentage to the Base Price level. If you want to update all items using this price level, you must also check the Update Existing Prices box. After you click Save, your prices automatically update. Note: Any value you enter is rounded to the nearest 0.01%
- externalId External ID: string
- id Internal ID: string
- isInactive Inactive: boolean
-
Check this box to remove all references to this record from your account. You can reactivate the record at any time.
- isOnline Online Price Level: boolean
-
Check this box to allow customers to use this in the web store.
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - longitemtype: string
- name Price Level: string
-
Enter the name for this record. This name appears in lists that include this record.
- refName Reference Name: string
- tname: string
- updateExistingPrices Update Existing Prices: boolean
-
Check this box to update all items using this price level with what you entered in the Markup/Discount % field.
- updateExistingTaxExclusivePrices Update Existing Tax Exclusive Prices: boolean
- updateExistingTaxInclusivePrices Update Existing Tax Inclusive Prices: boolean
priceLevelCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: priceLevel
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
priceLevel - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
pricePlan
- currency: currency
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- externalId External ID: string
- id Internal ID: string
- links Links: nsLink
-
nsLink - pricePlanType: object
-
- id Internal identifier.: string 1 , 2 , 3 , 4
- refName Reference Name: string
- priceTiers: pricePlan-priceTiersCollection
- refName Reference Name: string
pricePlan-priceTiersCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: pricePlan-priceTiersElement
-
pricePlan-priceTiersElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
pricePlan-priceTiersElement
- fromVal From Quantity: integer (int64)
- internalId Internal ID: integer (int64)
- lineId Line Id: integer (int64)
- links Links: nsLink
-
nsLink - maxAmount Maximum Amount: number (double)
- minAmount Minimum Amount: number (double)
- priceTier Tiers: string
- pricingOption: nsResource
- refName Reference Name: string
- value Value: number (double)
pricePlanCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: pricePlan
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
pricePlan - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
pricingGroup
This record is available as a beta record.
- externalId External ID: string
- id Internal ID: string
- isInactive Inactive: boolean
-
Check this box to remove all references to this record from your account. You can reactivate the record at any time.
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - longitemtype: string
- name Pricing Group: string
-
Enter the name for this record. This name appears in lists that include this record.
- refName Reference Name: string
- tname: string
pricingGroupCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: pricingGroup
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
pricingGroup - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
projectExpenseType
This record is available as a beta record.
- account: account
- description Description: string
-
Enter a description of this other list item.
- externalId External ID: string
- id Internal ID: string
- isInactive Inactive: boolean
-
Check this box to remove all references to this record from your account. You can reactivate the record at any time.
- links Links: nsLink
-
nsLink - name Name: string
-
Enter the name for this record. This name appears in lists that include this record.
- refName Reference Name: string
- translation: projectExpenseType-translationCollection
projectExpenseType-translationCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: projectExpenseType-translationElement
-
projectExpenseType-translationElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
projectExpenseType-translationElement
This record is available as a beta record.
- description Description: string
- language Language: string
- links Links: nsLink
-
nsLink - locale: object
-
- id Internal identifier.: string it_CH , en_TC , af_ZA , es_EA , es_EC , pt_BR , en_CY , fr_LU , nl_AN , es_UY , en_TT , es_ES , pt_ST , en_DM , en_TZ , es_ES_EURO , fr_ML , de_DE_onLQA , es_VE , nl_BE , da_DK , pt_AO , to_TO , en_UG , am_ET , ss_SZ , nl_BQ , ar , pt_AW , ko_KR , en_US , fr_BE_EURO , ko_KP , si_AQ , fr_MG , el_GR , be_BY , en_AU , he_IL , en_AW , es_SV , en_BB , ar_YE , es_CO , es_CL , en_BM , es_CR , pa_IN , en_SC , en_BS , sm_WS , it_IT_EURO , fr_KM , es_CU , en_SB , en_SG , en_BW , en_SH , en_BZ , en_SL , az_AZ , fi_FI , en_SS , sr_YU , en_CD , en_CA , ka_GE , lv_LV , uk_UA , es_DO , ur_PK , ar_IQ , fr_LU_EURO , pt_PT , fr_FR_EURO , en_PH , th_TH , bn_BD , si_LK , en_PG , hu_HU , ar_SA , ar_SD , ru_KZ , ar_BH , nl_BE_EURO , ro_MD , en_QA , ru_KG , es_AR , ta_IN , sr_RS , aa_ER , en , de_DE_EURO , zh_MO , en_AE , ar_SY , es_BO , en_AI , no_NO , en_AG , nl_SR , fr_VU , en_MW , gu_AQ , ar_TN , nl_SX , hi_IN , en_NA , mn_MN , en_NG , fr_FR , ms_MY , nl_CW , uz_UZ , ar_DJ , sr_CS , de_AT_EURO , en_NZ , es_PE , es_PA , fa_IR , ar_DZ , fr_GN , lb_LU , xx_US , pt_CV , sh_RS , ht_HT , fr_WF , es_AR_onLQA , es_PR , ar_EG , es_PY , fr_GA , en_KW , de_AT , ro_RO , en_KY , fr_FR_onLQA , fr_DJ , ca_ES_EURO , cs_CZ , en_LC , pl_AQ , fr_TD , fr_TG , es_MX , sv_AX , sk_SK , en_LR , en_LS , ar_OM , dz_BT , te_IN , de_LU_EURO , sq_AL , sv_SE , sn_ZW , es_NI , en_IE_EURO , my_MM , en_MF , en_MU , it_IT , pl_PL , fr_BE , fr_BF , tr_TR , fr_BI , fr_BJ , id_ID , fr_RW , en_ZM , km_KH , ja_JP , de_DE , fr_BL , tg_TJ , ar_QA , de_CH , zh_HK , pt_PT_EURO , en_JO , en_JM , fr_CA , nl_NL_EURO , fr_CF , fr_CG , fr_CD , pa_AQ , fr_CH , xx_US_wthId , fr_CI , pt_GW , vi_VN , ru_MD , fr_CM , fr_SC , en_KE , ne_NP , bs_BA , sl_SI , en_KN , fr_SN , ar_AE , en_GY , tl_PH , ca_ES , es_IC , lo_LA , kn_IN , so_SO , fr_PF , ar_JO , nl_NL , is_IS , fi_FI_EURO , pt_MZ , sk_SK_EURO , sl_SI_EURO , en_IE , ms_BN , hr_HR , ar_KW , de_LU , lt_LT , en_IN , ps_AF , en_ZA , en_VC , ru_RU , sh_YU , ar_LB , mr_IN , dv_MV , fj_FJ , zh_TW , tk_TM , ar_LY , en_VU , fr_NE , en_FK , es_GT , fr_NC , es_GQ , fa_AF , bg_BG , hy_AM , en_CY_EURO , mk_MK , ar_MA , en_GD , en_GB , es_HN , gu_IN , en_GH , et_EE , en_GI , zh_CN , en_GM , ar_MR
- refName Reference Name: string
- name Name: string
- refName Reference Name: string
projectExpenseTypeCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: projectExpenseType
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
projectExpenseType - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
projectIcChargeRequest
This record is available as a beta record.
- amount Amount: number (double)
- chargetrigger: object
-
- id Internal identifier.: string ProjectCompletion , ExactDate , TaskCompletion
- refName Reference Name: string
- createdby: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- createddate Created: string (date-time)
- currency: currency
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- externalId External ID: string
- fromsubsidiary: subsidiary
- id Internal ID: string
- lastmodifiedby: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- lastmodifieddate Last Modified: string (date-time)
- links Links: nsLink
-
nsLink - project: job
- projecttask: projectTask
- refName Reference Name: string
- tosubsidiary: subsidiary
- triggerdate Date: string (date)
projectIcChargeRequestCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: projectIcChargeRequest
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
projectIcChargeRequest - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
projectTask
This record is available as a beta record.
- actualWork Actual Work: string
-
Indicates the actual time entered against the task.
- allocatedWork Allocated Work: string
-
Allocated work for a project task is the total number of hours from all resource allocations for this task.
- assignee: projectTask-assigneeCollection
- bbudget: projectTask-bbudgetCollection
- bbudgetshowcalculatedlines Show Calculated Lines: boolean
-
Check this box to show calculated lines for each category.
- bbudgetusecalculatedvalues Use Calculated Values for all Labor Billing Budgets: boolean
-
Check this box to use calculated values for all labor billing budgets. You will no longer be able to enter budget amounts manually.
- calculatedwork Calculated Work: number (float)
-
Total work calculated by NetSuite based on the planned and actual time entered by assigned resources. This field cannot be manually edited.
- calculatedworkbaseline Calculated Work Baseline: number (float)
- cbudget: projectTask-cbudgetCollection
- cbudgetshowcalculatedlines Show Calculated Lines: boolean
-
Check this box to show calculated lines for each category.
- cbudgetusecalculatedvalues Use Calculated Values for all Labor Cost Budgets: boolean
-
Check this box to use calculated budgets for all labor cost categories. You will no longer be able to enter budgets manually.
- constraintType: object
-
- id Internal identifier.: string
- refName Reference Name: string
- contact: contact
- customForm: object
-
- id Internal identifier.: string -10170
- refName Reference Name: string
- duration Duration: string
- endDate End Date: string (date-time)
-
Indicates the estimated date when work for this task will be completed. NetSuite derives this date from the estimated work and other task dependencies. This date can change over the life of the project if the amount of work, resources assigned, or task dependencies change. When the task status is Completed, the end date is the date of the last time entry entered against the task.
- endDateBaseline End Date Baseline: string (date-time)
-
The date in the End Date field when the baseline was set.
- estimatedhoursatcompletion Estimated Hours At Completion: string
- estimatedhourstocomplete Estimated Hours To Complete: string
- estimatedwork Estimated Work: number (float)
-
Estimated Work for a project task is the total of all completed and planned work for this task. NetSuite calculates this field by summing the estimated work entered for the resources. If you enter a value in this field, then NetSuite distributes the amount equally to all resources assigned to this task. If you also use Resource Allocations and the Allow Allocated Resources to Enter Time to All Tasks preference is enabled for this project, the estimated work field is updated to add any time tracked against tasks by allocated resources. When task status is marked Completed, this number is set to equal Actual Work.
- estimatedworkbaseline Estimated Work Baseline: number (float)
-
The value in the Estimated Work field when the baseline was set.
- eventId Project Task ID: integer (int64)
- externalId External ID: string
- finishByDate Finish No Later Than: string (date)
-
Select the date this task must be finished by. This constraint takes precedence over task relationships and start dates are adjusted according to the fixed end date of a task with a Finish No Later Than constraint.
- id Internal ID: string
- insertBefore: projectTask
- isMilestone Milestone: boolean
- isOnCriticalPath: boolean
- isSummaryTask Summary Task: boolean
- lateEnd: string (date)
- lateStart: string (date)
- links Links: nsLink
-
nsLink - message Comments: string
-
Enter any comments for the task.
- msprojoutlinenum MS Project Outline Number: string
- msprojpreds MS Project Predecessors: string
- msprojresources MS Project Resource Names: string
- msprojschedwork MS Project Scheduled Work: string
- msprojserviceitem: nsResource
- msprojuid MS Project UID: string
- nonBillableTask Non-billable: boolean
-
Check this box to designate this task as non-billable. When time is entered against this task, it is automatically marked as non-billable and cannot be changed to billable.
- owner: employee
- parent: projectTask
- percentCompleteByRsrcAlloc Percent Complete by Allocated Work: number (double)
-
Percent Complete by Allocated Work is the progress of the project task based on the allocated resources. This field can be useful in showing when project tasks require more effort than was originally planned.
- percentTimeComplete Percent Complete: number (double)
-
Shows the percent of planned project task time that has been completed. Percent Complete is calculated as follows: [Actual Work / Estimated Work] Percent Complete is 100% when the task status is Completed and Estimated Work is set to Actual Work.
- plannedwork Planned Work: string
-
Total planned work entered for the assigned resources. Time tracked against this task outside of the planned work is not added to this total.
- plannedworkbaseline Planned Work Baseline: string
- plannedworktotal Planned Work Total: string
- predecessor: projectTask-predecessorCollection
- priority: object
-
- id Internal identifier.: string HIGH , MEDIUM , LOW
- refName Reference Name: string
- project: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- refName Reference Name: string
- remainingWork Remaining Work: string
-
Remaining Work is calculated as: [Estimated Work - Actual Work] Before work starts on a task, Remainng Work is the same as Estimated Work. When a task is marked Completed, Estimated Work is set to equal Actual Work and Remaining Work is 0.
- slackMinutes: number (float)
- startDateBaseline Start Date Baseline: string (date-time)
-
The date in the State Date field when the baseline was set.
- startDateTime Start Date: string (date-time)
- status: object
-
- id Internal identifier.: string NOTSTART , PROGRESS , COMPLETE
- refName Reference Name: string
- title Name: string
-
Enter a name for the project task.
- workassignment: projectTask-workassignmentCollection
projectTask-assigneeCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: projectTask-assigneeElement
-
projectTask-assigneeElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
projectTask-assigneeElement
This record is available as a beta record.
- billingClass: billingClass
- calculatedWork Calculated Work: number (float)
- cost Cost: number (double)
- createworkassignment Create Work Assignment: boolean
- estimatedWork Estimated Work: number (float)
- id Internal ID: integer (int64)
- links Links: nsLink
-
nsLink - plannedWork Planned Work: number (float)
- price Price: number (double)
- refName Reference Name: string
- resource: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- resourceGroup: nsResource
- serviceItem: nsResource
- unitCost Unit Cost: number (double)
- unitPrice Unit Price: number (double)
- units Units: number (double)
- workassignmentcount Work Assignments Count: integer (int64)
projectTask-bbudgetCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: projectTask-bbudgetElement
-
projectTask-bbudgetElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
projectTask-cbudgetCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: projectTask-cbudgetElement
-
projectTask-cbudgetElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
projectTask-predecessorCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: projectTask-predecessorElement
-
projectTask-predecessorElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
projectTask-predecessorElement
This record is available as a beta record.
- endDate End Date: string (date-time)
- lagdays Lag Time: number (float)
- links Links: nsLink
-
nsLink - predecessor: projectTask
- refName Reference Name: string
- startDate Start Date: string (date-time)
- type: object
-
- id Internal identifier.: string FS , SS , FF , SF
- refName Reference Name: string
projectTask-workassignmentCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: projectTask-workassignmentElement
-
projectTask-workassignmentElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
projectTask-workassignmentElement
This record is available as a beta record.
- assignee: nsResource
- billingclass: billingClass
- createddate Created Date: string (date-time)
- deadline Deadline: string (date)
- enddate End Date: string (date)
- externalid External ID: string
- id Internal ID: integer (int64)
- isinactive Inactive: boolean
- lastmodifieddate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - plannedhours Planned Hours: string
- refName Reference Name: string
- reqline: boolean
- serviceitem: nsResource
- startdate Start Date: string (date)
- status: object
-
- id Internal identifier.: string UNASSIGNED , COMPLETED , ACCEPTED , CANCELED , STARTED , PENDING
- refName Reference Name: string
- title Title: string
projectTaskCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: projectTask
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
projectTask - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
projectTemplate
This record is available as a beta record.
- allowAllResourcesForTasks Display All Resources for Project Task Assignment: boolean
-
Check this box to allow any employees or vendor designated as a project resource on the entity record to be assigned to a project task. Clear the box if you want to restrict project task assignment to resources you add to the Resources subtab.
- allowExpenses Allow Expenses: boolean
-
Check this box to allow expenses to be entered for projects created from this template. If the Limit Time Entry to Assignees field is also checked, then only resources listed on the Resource subtab will be able to see the projects in the Customer/Project select list for Expense Reporting.
- allowTaskTimeForRsrcAlloc Allow Allocated Resources to Enter Time to All Tasks: boolean
-
Check this box to allow resources allocated to projects created from this template to enter time against project tasks regardless of being assigned to the task.
- allowTime Allow Time Entry: boolean
-
Check this box to enable time to be entered for projects created from this template. If the Limit Time Entry to Assignees field is checked, the project appears only in the Customer/Project dropdown for resources listed on the Resource tab of the created projects.
- applyProjectExpenseTypeToAll Apply to all time entries: boolean
-
Check this box to apply the selected project expense type to all time entries for this project template. This preference overrides any other project expense type for time transactions recorded for this project.
- bBudgetShowCalculatedLines Show Calculated Lines: boolean
-
Check this box to show calculated budgets for each category.
- bBudgetUseCalculatedValues Use Calculated Values for all Billing Budgets: boolean
-
Check this box to use calculated values for billing budget categories. You will no longer be able to manually enter amounts.
- billingRateCard: billingRateCard
- billingSchedule: billingSchedule
- cBudgetLaborBudgetFromAlloc Calculate Labor Budgets from Resource Allocations: boolean
-
Check this box to automatically calculate labor budgets from resource allocations. You will no longer be able to enter budget amounts manually.
- cBudgetShowCalculatedLines Show Calculated Lines: boolean
-
Check this box to show calculated amounts for all categories.
- cBudgetUseCalculatedValues Use Calculated Values for all Cost Budgets: boolean
-
Check this box to automatically calculate labor budgets. You will no longer be able to enter budget amounts manually.
- calculatedWork Calculated Work: string
- createChargeRule Create Charge Rule: boolean
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- entityId Name: string
-
Enter a name for this project template.
- estimatedCost Estimated Cost: number (double)
- estimatedCostJc Estimated Cost: number (double)
-
The estimated cost for completing the project is displayed here. This cost is calculated from the labor cost of project tasks.
- estimatedGrossProfit Estimated Gross Profit: number (double)
-
Estimated Gross Profit is calculated as follows: For Time and Materials pojects: [Estimated Labor Revenue - Estimated Labor Cost] For Fixed Bid projects: [Project Price - Estimated Labor cost]
- estimatedGrossProfitPercent Estimated Gross Profit Percent: number (double)
-
Shows the expected profit percentage, calculated as: For Time and Materials projects: [Estimated Gross Profit / Estimated Labor Revenue For Fixed Bid projects: [Estimated Gross Profit / Project Price
- estimatedLaborCost Estimated Labor Cost: number (double)
-
The estimated cost for completing the project is displayed here. This cost is calculated from the labor cost of project tasks.
- estimatedLaborRevenue Estimated Labor Revenue: number (double)
-
The estimated revenue for this project is displayed here. The estimate is calculated from the labor price of project tasks.
- estimatedRevenue Estimated Revenue: number (double)
- estimatedRevenueJc Estimated Revenue: number (double)
-
The estimated revenue for this project is displayed here. The estimate is calculated from the labor price of project tasks.
- estimatedTimeOverride Estimated Work: string
-
Estimated Work is the sum of the estimated work for all project tasks included in this template. Estimated Work also includes the Current Time Budget amounts for all CRM tasks if the Include CRM Tasks in Project Totals check box is selected for this project template.
- externalId External ID: string
- forecastChargeRunOnDemand Forecast Charge Run on Demand: boolean
- id Internal ID: string
- includeCrmTasksInTotals Include CRM Task In Project Totals: boolean
-
Check this box to allow CRM tasks to be included in costs, planned time, and actual time for projects created from this template.
- isExemptTime Classify Time as Exempt: boolean
-
Exempt time is excluded when calculating utilization. It is not included in the numerator or denominator of the utilization formula.
- isInactive Inactive: boolean
-
If you check this box, then the project template no longer appears on the list of project templates. You cannot edit or make any changes to a project template marked inactive. Check the Show Inactives box at the bottom of the List page to view inactive project templates.
- isProductiveTime Classify Time as Productive: boolean
-
Productive time is time worked on a project but not included when calculating revenue for the project. Productive time is not billed to the customer. Training and pre-sales support are examples of productive time.
- isUtilizedTime Classify Time as Utilized: boolean
-
Utilized time directly contributes to the revenue for a project.
- jobBillingType: object
-
- id Internal identifier.: string FBM , STD , TM , FBI , CB
- refName Reference Name: string
- jobItem: nsResource
- jobPrice Project Price: number (double)
-
Enter the price billed to the customer on transactions. Project Price is also used to calculate the gross profit margin for the project.
- jobResources: projectTemplate-jobResourcesCollection
- limitTimeToAssignees Limit Time and Expenses To Resources: boolean
-
Select this box to allow only resources listed on the Resources subtab for the project to enter time and expenses for projects created from this template. Only resources listed on the Resource tab will be able to see the project in Project select lists for time and expenses. Note: Regardless of whether this box is marked, in the Vendor Center, projects created from this template will only show if the vendor is listed as a resource of the project.
- links Links: nsLink
-
nsLink - materializeTime Create Planned Time Entries: boolean
-
Check this box to generate time entries for planned work on project tasks for projects created from this template. Resources assigned to projects will be able to see their planned time in Time Tracking or Timesheets. If you use Project Budgets, planned time entries are required to generate calculated costs.
- plannedWork Planned Work: string
- projectExpenseType: projectExpenseType
- projectFormTemplate: object
-
- id Internal identifier.: string -10003 , -3 , -10006
- refName Reference Name: string
- projectManager: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- refName Reference Name: string
- scheduledenddate End Date: string (date)
- schedulingMethod: object
-
- id Internal identifier.: string BACKWARD , FORWARD
- refName Reference Name: string
- sourceServiceItemFromRateCard Source Service Item to Task Assignments from Rate Card: boolean
- startDate Start Date: string (date)
-
Enter the estimated date work will start on the project. You can change this date when a project is created from this template. NetSuite schedules all project tasks without predecessors to start on this date.
- subsidiary: subsidiary
- useAllocatedTimeForForecast Use Allocated Time for Forecast: boolean
-
Check this box to use allocated time for project forecast reports.
projectTemplate-jobResourcesCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: projectTemplate-jobResourcesElement
-
projectTemplate-jobResourcesElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
projectTemplate-jobResourcesElement
This record is available as a beta record.
- defaultCost: number (double)
- jobResource: genericResource
- links Links: nsLink
-
nsLink - overridenCost Cost Override: number (double)
- refName Reference Name: string
- role: nsResourceCollection
projectTemplateCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: projectTemplate
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
projectTemplate - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
promotionCode
This record is available as a beta record.
- applyDiscountTo: object
-
- id Internal identifier.: string FIRSTSALE , ALLSALES
- refName Reference Name: string
- applyDiscountToType: object
-
- id Internal identifier.: string CHEAPESTDISCITEM , MOSTEXPENSIVEDISCITEM , EACHDISCITEM
- refName Reference Name: string
- audience: object
-
- id Internal identifier.: string EVERYONE , SPECIFICCUSTOMERS
- refName Reference Name: string
- campaigns: promotionCode-campaignsCollection
- canBeAutoApplied Can be Automatically Applied: boolean
-
Check this box to automatically apply this promotion to eligible transactions. Note that promotions that do not provide the best offer available to the customer will not be automatically applied.
- cannotBeCombined Exclusive Promotion: boolean
-
Check this box if you do not want this promotion to be combined with other promotions.
- code Coupon Code: string
-
The coupon code that is entered on a sales transaction to apply the promotion. Coupon codes can be multiple-use or single-use. Multiple-use codes can be used any number of times by any number of customers. Each single-use code can only be used in one transaction by a single customer.
- codePattern Code Pattern: string
-
You enter code patterns using the following components in any order you choose: * [A.#] – This adds a number of random letters in the code. * [N.#] – This adds a number of random numbers in the code. * [AN.#] – This adds a number of random alphanumeric characters to the code. * Hard-coded alphanumeric characters. Do not enclose these in square brackets. * Dashes (-) Note: The following letters and numbers cannot be used in coupon codes: 1, 0, I, L, O. For example, the code ABC-[AN.3]-[A.3]-[N.3] would generate codes like: * ABC-J3N-FLN-647 * ABC-45F-KPM-958 * ABC-5MP-PQA-874 When creating your code pattern, make sure that the pattern you give has enough variables to provide the number of unique codes you need for your promotion.
- combinationType: object
-
- id Internal identifier.: string COMBINABLE , GLOBALEXCLUSIVE , ITEMLINEEXCLUSIVE , ORDERTYPEEXCLUSIVE , SHIPPINGTYPEEXCLUSIVE
- refName Reference Name: string
- couponCodeFile Import File: string
-
If you are entering single-use coupon codes, do one of the following: * Select a CSV file to import. * Enter a code pattern and the number of codes you want to generate. For more information on single-use coupons, view the topic Single-Use Coupons in the Help Center.
- currency: promotionCode-currencyCollection
- customForm: object
-
- id Internal identifier.: string -10500
- refName Reference Name: string
- customerCategory: customerCategoryCollection
- customerGroup: nsResource
- customerGroupPreference: object
-
- id Internal identifier.: string USECACHED , RUNEACHTIME
- refName Reference Name: string
- customers: customerCollection
- description Description: string
-
Enter a description of this promotion.
- discount: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- discountType: object
-
- id Internal identifier.: string F , T
- refName Reference Name: string
- discountedItems: promotionCode-discountedItemsCollection
- discountedItemsSavedSearch: nsResource
- displayLineDiscounts Display Line Discounts: boolean
-
Check this box if you want to show the promotion discount as line items in transactions. The discount will appear as a line beneath qualifying items on the transaction. You must check this box and select a percentage discount in order to show strikeout pricing on Web store orders. A flat rate promotion applies to the total order. If you clear this box, the promotion discount will be shown in the transaction total. Note: If you use line discount promotions, when you apply the promotion to a transaction, you must click Calculate to create the discount line before saving the transaction.
- endDate End Date: string (date)
-
Enter the date this promotion can no longer be applied to transactions.
- excludeItems: boolean
-
Check this box to have this promotion code apply to all items except those you add below. If you do not check this box, the code can only be used for the items you add below.
- externalId External ID: string
- fixedPrice Fixed Price: number (double)
-
Enter the price of the item when this promotion is applied to an eligible transaction. This amount is fixed and will not change.
- freeShipMethod: shipItem
- id Internal ID: string
- implementation: object
-
- id Internal identifier.: string default , CUSTOMSCRIPT_ADVPROMO_BUYX_GETY , CUSTOMSCRIPT_ADVPROMO_ORDER_SPECIFIC , CUSTOMSCRIPT_ADVPROMO_ITEM_SPECIFIC
- refName Reference Name: string
- isInactive Inactive: boolean
-
Check this box to deactivate this promotion. Inactive promotions cannot be applied to customers or transactions.
- isPublic Available to all Customers: boolean
-
Check this box to be able to select this promotion on transactions for any customer. If you do not check this box, only customers associated with the partners you select below are able to use this promotion.
- itemQuantifier Item Quantity: integer (int64)
-
In the Item Quantity field, enter how many units of each selected item the customer has to buy to get the discount provided by this promotion. For example, enter 2 in this field to create a promotion that provides discount on every third unit, such as a "Buy 2 Get 1 Free", or "Buy 3 for the price of 2" promotion. Check the Repeat Discount Incrementally box to repeat the discount on the transaction every time the customer adds the number of items specified in the Item Quantity field.
- items: promotionCode-itemsCollection
- itemssavedsearch: nsResource
- lastUploadDate Last Upload Date: string (date)
- lastUploadFile Import File: string
- lastUploadStatus Last Upload Status: string
- links Links: nsLink
-
nsLink - location: locationCollection
- minimumOrderAmount: number (double)
-
Enter the amount that the customer must spend before the promotion code becomes valid. If you use the Multiple Currencies feature, you can set a different minimum order amount for each currency in which you do business.
- minimumOrderAmountCheck Minimum Order Amount: boolean
-
Select this option to require the customer to spend a minimum amount before they are eligible for this promotion's discount. Enter the amount in the Minimum Order Amount field.
- name Name: string
-
Enter the name for this promotion. Note: This is the name used for internal and reporting use only. The coupon code you want customers to use on sales transactions is entered in the Coupon Code field on the Codes subtab.
- numberToGenerate Codes to Generate: integer (int64)
-
Enter the number of coupon codes you want to generate with your code pattern.
- partnerCnt: integer (int64)
- partners: promotionCode-partnersCollection
- promotionCodeInstances: promotionCode-promotionCodeInstancesCollection
- promotionType: object
-
- id Internal identifier.: string STANDARD , ADVANCED , ITEM , ORDER , SHIPPING , FIXEDPRICE , FREEGIFT
- refName Reference Name: string
- rate Rate: number (double)
-
Enter the discount rate for this promotion. Select % if this rate is a percentage. Select flat if this rate is a flat discount.
- refName Reference Name: string
- repeatDiscount Repeat discount incrementally: boolean
- salesChannels: object
-
- id Internal identifier.: string ALL , SPECIFICLOCATIONS , SPECIFICWEBSITES
- refName Reference Name: string
- specificitemscheck: boolean
-
Select this option to require the customer to buy a specific item to be eligible for this promotion's discount. Select the items the customer must buy: * From Items List: select the item or items the customer must buy to make the transaction eligible for this promotion from the Item list. * From Saved Search: select the item or items the customer must buy to make the transaction eligible for this promotion from the From Saved Search list. For more information regarding creating Saved Searches, see the help topic Using Saved Searches.
- startDate Start Date: string (date)
-
Enter the first date this promotion can be applied to a transaction.
- useCachedCustomerGroup Use Cached Customer Group: boolean
- useMaterializedSavedSearch Use Cached Item Saved Search: boolean
-
Choose how this promotion manages saved searches. Select Use cached saved search to retrieve results faster whenever this promotion is applied to a transaction. Note that the cache is still updated periodically when this option is selected. Select Run saved search each time the promotion is applied in case your saved search is linked to a frequently changing inventory, for example a new item could be added to the inventory less than every 4 hours. For more information, see the help topic Saved Search Performance.
- useType: object
-
- id Internal identifier.: string MULTIPLEUSES , SINGLEUSE
- refName Reference Name: string
- website: webSiteCollection
- whatTheCustomerNeedsToBuy: object
-
- id Internal identifier.: string ANYTHING , MINIMUMORDERAMOUNTORSPECIFICITEMS
- refName Reference Name: string
promotionCode-campaignsCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: promotionCode-campaignsElement
-
promotionCode-campaignsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
promotionCode-campaignsElement
This record is available as a beta record.
- campaign: nsResource
- campaignEvent: nsResource
- campaignEventName Event Name: string
- campaignId ID: number (double)
- category Category: string
- dateSent Date Sent: string (date-time)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- status Status: string
promotionCode-currencyCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: promotionCode-currencyElement
-
promotionCode-currencyElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
promotionCode-discountedItemsCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: promotionCode-discountedItemsElement
-
promotionCode-discountedItemsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
promotionCode-discountedItemsElement
This record is available as a beta record.
- discountedItem: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- links Links: nsLink
-
nsLink - refName Reference Name: string
promotionCode-itemsCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: promotionCode-itemsElement
-
promotionCode-itemsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
promotionCode-itemsElement
This record is available as a beta record.
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- links Links: nsLink
-
nsLink - refName Reference Name: string
promotionCode-partnersCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: promotionCode-partnersElement
-
promotionCode-partnersElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
promotionCode-promotionCodeInstancesCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: promotionCode-promotionCodeInstancesElement
-
promotionCode-promotionCodeInstancesElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
promotionCodeCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: promotionCode
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
promotionCode - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
purchaseContract
This record is available as a beta record.
- accountingBookDetail: purchaseContract-accountingBookDetailCollection
- approvalStatus: object
-
- id Internal identifier.: string 11 , 1 , 2 , 3
- refName Reference Name: string
- billedAmount Billed Amount: number (double)
- billingInstructions Billing Instructions: string
- carrier Carrier: string
- class: classification
- createdDate Date Created: string (date-time)
- createdFrom: nsResource
- currency: currency
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- department: department
- discount: purchaseContract-discountCollection
- discountAmount Discount Amount: number (double)
- discountDate Discount Date: string (date)
- dueDate Due Date: string (date)
- effectivityBasedOn: object
-
- id Internal identifier.: string ORDERDATE , RECEIPTDATE
- refName Reference Name: string
- email Email: string
- employee: employee
- endDate End Date: string (date)
- entity: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- exchangeRate Exchange Rate: number (double)
- externalId External ID: string
- id Internal ID: string
- incoTerm: nsResource
- item: purchaseContract-itemCollection
- lastModifiedDate Date Last Modified: string (date-time)
- links Links: nsLink
-
nsLink - location: location
- maximumAmount Maximum Amount: number (double)
- memo Memo: string
- message Vendor Message: string
- minimumAmount Minimum Amount: number (double)
- nextApprover: employee
- nexus: nexus
- orderStatus: object
-
- id Internal identifier.: string A , B , R , H
- refName Reference Name: string
- originator Originator: string
- otherRefNum PO/Check Number: string
- packingListInstructions Packing List Instructions: string
- prevDate Previous Effective Date: string (date)
- productLabelingInstructions Product Labeling Instructions: string
- purchaseOrderInstructions Purchase Order Instructions: string
- purchasedAmount Purchased Amount: number (double)
- receivedAmount Received Amount: number (double)
- refName Reference Name: string
- source: object
-
- startDate Start Date: string (date)
- status: object
-
- id Internal identifier.: string A , B , R , H
- refName Reference Name: string
- storeOrder: string
- subsidiary: subsidiary
- terms: term
- toBeEmailed To Be Emailed: boolean
- toBeFaxed To Be Faxed: boolean
- toBePrinted To Be Printed: boolean
- tranDate Date: string (date)
- tranId Transaction Number: string
- updateItemVendor: boolean
- webSite: string
purchaseContract-accountingBookDetailCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: purchaseContract-accountingBookDetailElement
-
purchaseContract-accountingBookDetailElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
purchaseContract-accountingBookDetailElement
This record is available as a beta record.
- accountingBook: accountingBook
- exchangeRate Exchange Rate: number (double)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- revRecOnRevCommitment Rev Rec on Rev Commit.: boolean
- subsidiary: subsidiary
- tranIsVsoeBundle Transaction Is VSOE Bundle: boolean
purchaseContract-discountCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: purchaseContract-discountElement
-
purchaseContract-discountElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
purchaseContract-item-itemPricing
This record is available as a beta record.
- baserate: number (double)
- calculatequantitydiscounts: object
-
- id Internal identifier.: string OVERALL , LINE , OVERALLPO
- refName Reference Name: string
- discount: purchaseContract-item-itemPricing-discountCollection
- externalId External ID: string
- inputusing: object
-
- id Internal identifier.: string RATE , PERCENT
- refName Reference Name: string
- lineid: integer (int64)
- links Links: nsLink
-
nsLink - priceusing: object
-
- id Internal identifier.: string MARGINALRATE , RATE , LOTRATE
- refName Reference Name: string
- pricingtiers: integer (int64)
- refName Reference Name: string
- transactionid: integer (int64)
- trantype: string
- vendor: integer (int64)
- vendoremailed: boolean
purchaseContract-item-itemPricing-discountCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: purchaseContract-item-itemPricing-discountElement
-
purchaseContract-item-itemPricing-discountElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
purchaseContract-itemCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: purchaseContract-itemElement
-
purchaseContract-itemElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
purchaseContract-itemElement
This record is available as a beta record.
- amount Amount: number (double)
- billVarianceStatus: object
-
- id Internal identifier.: string NOVARIANCES , JOURNALNOTPOSTED , JOURNALPOSTED
- refName Reference Name: string
- class: classification
- createdFrom: nsResource
- department: department
- description Description: string
- initOqpBucket Initial OQP Bucket: string
- isClosed Closed: boolean
- isOpen Is Opened: boolean
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemPricing: purchaseContract-item-itemPricing
- itemPricingSet: string
- itemSubtype: object
-
- id Internal identifier.: string Sale , Purchase , Resale
- refName Reference Name: string
- itemType: object
-
- licenseCode License Code: string
- line Transaction Line: integer (int64)
- linked Linked: boolean
- links Links: nsLink
-
nsLink - location: location
- marginal Marginal: boolean
- matrixType Matrix Type: string
- minQty Minimum Quantity: number (float)
- options Options: string
- oqpBucket Oqp Bucket: string
- printItems Print Items: boolean
- quantity Quantity: number (float)
- rate Rate: number (double)
- rateIncludingTax Rate: number (double)
- rateSchedule Rate Schedule: string
- refName Reference Name: string
- subsidiary: subsidiary
- units Units: string
- vendorName Vendor Name: string
purchaseContractCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: purchaseContract
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
purchaseContract - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
purchaseOrder
- accountingBookDetail: purchaseOrder-accountingBookDetailCollection
- appliedRules: purchaseOrder-appliedRulesCollection
- approvalStatus: object
-
- id Internal identifier.: string 11 , 1 , 2 , 3
- refName Reference Name: string
- availableVendorCredit Available Vendor Credit: number (double)
-
If you have customized the purchase order to display the Available Vendor Credit field, changing the subsidiary changes the available credit limit value to reflect the currency of the selected subsidiary.
- balance Balance: number (double)
- billAddr1 Billing Address Line 1: string
- billAddr2 Billing Address Line 2: string
- billAddr3 Billing Address Line 3: string
- billAddress Bill To: string
-
By default, NetSuite inserts the vendor mailing address from the vendor record in the Vendor Select field, : * Select New to enter a new address to use for this transaction and save to the associated vendor record. * Select Custom to enter a new address to use for this transaction only. It is not saved with the associated vendor record. * Click the Edit icon to modify an existing vendor address.
- billAddressList: nsResource
- billAddressee Billing Addressee: string
- billAttention Billing Attention: string
- billCity Billing Address City: string
- billCountry: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- billOverride Override: string
- billPhone Billing Phone: string
- billState Billing Address State: string
- billZip Billing Address Zip Code: string
- billingAddress: purchaseOrder-billingAddress
- billingAddress_text Billing Address: string
- class: classification
- createdDate Date Created: string (date-time)
- createdFrom: nsResource
- currency: currency
- customForm: object
-
- id Internal identifier.: string -9922 , -9902
- refName Reference Name: string
- department: department
- discountAmount Discount Amount: number (double)
- discountDate Discount Date: string (date)
- dueDate Due Date: string (date)
-
Enter the date by which the items to be ordered are needed.
- email Email: string
- employee: employee
- endDate End Date: string (date)
- entity: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- entityTaxRegNum Vendor Tax Reg. Number: string
-
Select the vendor's tax registration number associated with this purchase order.
- exchangeRate Exchange Rate: number (double)
-
The currency's exchange rate is shown in this field. You can edit the exchange rate for this transaction only, or you can update the currency record with the exchange rate you enter here.
- excludefromsupplyplanning Exclude from Supply Planning: boolean
- expense: purchaseOrder-expenseCollection
- externalId External ID: string
- firmed Firmed: boolean
- fob FOB: string
-
Enter the location where you technically acquire ownership. For example, if you own goods as soon as they ship and pay the shipping costs from your vendor s location to your own, you might enter Shipping point.
- id Internal ID: string
- incoTerm: nsResource
- intercoStatus: object
-
- id Internal identifier.: string 1 , 2 , 3
- refName Reference Name: string
- intercoTransaction: nsResource
- isCrossSubTransaction Cross-Subsidiary Transaction: boolean
- item: purchaseOrder-itemCollection
- lastModifiedDate Date Last Modified: string (date-time)
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
-
If you wish, enter a memo to describe this order. It will appear on reports such as the 2-line Purchase Orders register.
- message Vendor Message: string
-
If you wish, type a message that will appear on the Purchase Order form.
- nextApprover: employee
- nexus: nexus
- orderStatus: object
-
- id Internal identifier.: string P , A , B , C , D , E , F , G , H , Y
- refName Reference Name: string
- originator Originator: string
- otherRefNum PO/Check Number: string
-
NetSuite inserts your account number for this vendor as entered at Lists > Relationships > Vendors on the Financial subtab for this vendor's record.
- prevDate Previous Effective Date: string (date)
- purchaseContract: purchaseContract
- refName Reference Name: string
- shipAddress Ship To: string
-
When you select a customer in the Ship To field in the header of this transaction, the customer's default shipping address autofills this field. If the Ship To field in the header of this transaction is blank, your company shipping address autofills this field. You can view and edit your company shipping address at Setup > Company Information. To change the shipping address that autofills: * Select another address in the Ship To Select field. * Select New in the Ship To Select field to enter a new billing address.
- shipAddressList: nsResource
- shipDate Ship Date: string (date)
-
Enter the date you expect the items to be shipped.
- shipIsResidential Shipping address is residential: boolean
- shipMethod: shipItem
- shipOverride Override: boolean
- shipTo: customer
- shippingAddress: purchaseOrder-shippingAddress
- shippingAddress_text Shipping Address: string
- source: object
-
- startDate Start Date: string (date)
- status: object
-
- id Internal identifier.: string P , A , B , C , D , E , F , G , H
- refName Reference Name: string
- storeOrder: string
- subsidiary: subsidiary
- subsidiaryTaxRegNum Subsidiary Tax Reg. Number: string
-
This field shows the tax registration number of the transaction nexus. NetSuite automatically populates this field based on the nexus lookup logic. You can override the transaction nexus and tax registration number that NetSuite automatically selects by checking the Nexus Override box. When you select a different tax registration number in the dropdown list, the corresponding nexus is automatically selected in the Nexus field.
- subtotal Subtotal: number (double)
- supervisorApproval Supervisor Approval: boolean
-
If you have permission to approve this purchase order, check the Supervisor Approval box.
- suppressUserEventsAndEmails: string
- taxDetails: purchaseOrder-taxDetailsCollection
- taxDetailsOverride Tax Details Override: boolean
-
Check this box to override the tax information on the Tax Details subtab of the transaction. Only roles with at least the Edit level of the Tax Details Tab permission can override the tax details.
- taxPointDate Tax Point Date: string (date)
-
Tax point date is a legal requirement in many countries. It is the date of transaction that determines the taxability. It may be different from the transaction date that determines the GL impact. Specific rules then consider the reporting of transactions based on tax point date and other factors.
- taxPointDateOverride Tax Point Date Override: boolean
-
Check this box to override the tax point date.
- taxRegOverride Tax Registration Override: boolean
-
Check this box to override the values in the Nexus and Subsidiary Tax Reg. Number fields. Only roles with at least the Edit level of the Tax Details Tab permission can override the values that NetSuite automatically selects in these fields.
- taxTotal Tax: number (double)
-
NetSuite multiplies the tax rate by the taxable total of line items and enters it here.
- terms: term
- toBeEmailed To Be Emailed: boolean
-
Check this box if you want to e-mail this purchase order. Then enter the e-mail address in the space to the right of the check box. You can enter multiple e-mail addresses by separating them with semicolons. It is important to separate the addresses with only semicolons, and do not include any spaces.
- toBeFaxed To Be Faxed: boolean
-
Check this box if you want to fax this purchase order. Enter the fax number in the space to the right of the check box if it doesn't already appear. To fax NetSuite forms, an administrator must first set up fax service at Setup > Company > Printing, Fax and Email Preferences.
- toBePrinted To Be Printed: boolean
-
Check this box if you wish to save this in a queue of purchase orders to print. Otherwise, you can click Print below to submit and print this purchase order at once.
- total Total: number (double)
-
NetSuite computes the total of line items and then enters it here.
- totalAfterTaxes Total After Taxes: number (double)
- trackingNumbers Tracking Numbers: string
-
Enter the shipment tracking number from the shipping company. If a tracking number is entered in the exact format used by UPS or FedEx and the transaction is saved, the tracking number will show on the transaction as a link to the UPS or FedEx website. You can click the link to check the status of the shipment.
- tranDate Date: string (date)
-
NetSuite inserts today's date for the posting date of this purchase order. You can type or pick another date. What you enter here determines the date range in which this transaction appears on the Purchase Orders Register. You can select or enter custom date ranges on registers.
- tranId PO #: string
-
NetSuite increases the largest purchase order number by one. If you wish, you can type another number. The next PO number will revert to the standard pattern. Note: The maximum number of characters you can enter in this field is 45.
- unbilledOrders Unbilled Orders: number (double)
- updateDropshipOrderQty: string
- webSite: string
purchaseOrder-accountingBookDetailCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: purchaseOrder-accountingBookDetailElement
-
purchaseOrder-accountingBookDetailElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
purchaseOrder-accountingBookDetailElement
- accountingBook: accountingBook
- exchangeRate Exchange Rate: number (double)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- revRecOnRevCommitment Rev Rec on Rev Commit.: boolean
- subsidiary: subsidiary
- tranIsVsoeBundle Transaction Is VSOE Bundle: boolean
purchaseOrder-appliedRulesCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: purchaseOrder-appliedRulesElement
-
purchaseOrder-appliedRulesElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
purchaseOrder-billingAddress
- addr1 Address 1: string
-
Enter the address the way it should appear on forms. For employees, customers, partners, and vendors, what you enter here autofills on forms if this address is marked default for Shipping or Billing. Enter up to 50 characters. This field is required for the Online Bill Pay feature.
- addr2 Address 2: string
-
Enter an optional second address line the way it should appear on forms. For employees, customers, partners, and vendors, what you enter here autofills on forms if this address is marked default for Shipping or Billing. Enter up to 50 characters.
- addr3 Address 3: string
- addrPhone Phone: string
-
Enter the phone number.
- addrText Address: string
-
The values entered in the other address fields are displayed here.
- addressee Addressee: string
-
Enter the name of the entity that should appear on the shipping label here. This name appears on the shipping label below what you enter in the Attention field.
- attention Attention: string
-
Enter the name of the person to whom a shipment is addressed, as it should appear on shipping labels. This field is required for UPS Integration.
- city City: string
-
Enter the city the way it should appear on all forms except checks.
- country: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- externalId External ID: string
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - override Override: boolean
-
Check this box to disable the free-form address text field. When this field is disabled, text entered in the other address fields does not display in the Address text field. Clear this box to allow text entered in the address component fields to appear in the free-form address text field.
- refName Reference Name: string
- state State/Province: string
-
Enter your company's state or province the way it should appear on all forms except checks.
- zip Zip: string
-
Enter the postal code the way it should appear on all forms except checks.
purchaseOrder-expenseCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: purchaseOrder-expenseElement
-
purchaseOrder-expenseElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
purchaseOrder-expenseElement
- account: account
- amount Amount: number (double)
- category: expenseCategory
- class: classification
- createdFrom: blanketPurchaseOrder
- customer: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- department: department
- isBillable Billable: boolean
- isClosed Closed: boolean
- line Line: integer (int64)
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
- orderLine Order Line: string
- projecttask: projectTask
- refName Reference Name: string
- taxAmount Tax Amount: number (double)
- taxDetailsReference Tax Details Reference: string
purchaseOrder-item-inventoryDetail
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- externalId External ID: string
- inventoryassignment: purchaseOrder-item-inventoryDetail-inventoryassignmentCollection
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemDescription Description: string
-
A more complete Description of the item.
- links Links: nsLink
-
nsLink - location: location
- quantity Quantity: number (float)
-
In the Quantity to Build field, enter the number of assembly items you want to build. You cannot enter a quantity that exceeds the amount displayed in the Buildable Quantity field.
- refName Reference Name: string
- toLocation: location
- unit Units: string
-
If the assembly uses Units of Measure, the base units are displayed in the Units field.
purchaseOrder-item-inventoryDetail-inventoryassignmentCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: purchaseOrder-item-inventoryDetail-inventoryassignmentElement
-
purchaseOrder-item-inventoryDetail-inventoryassignmentElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
purchaseOrder-item-inventoryDetail-inventoryassignmentElement
- binNumber: bin
- expirationDate Expiration Date: string (date)
- internalId Internal ID: integer (int64)
- inventoryDetail Inventory Detail: integer (int64)
- inventoryStatus: inventoryStatus
- issueInventoryNumber: inventoryNumber
- links Links: nsLink
-
nsLink - packCarton Pack Carton: string
- pickCarton Pick Carton: string
- quantity Quantity: number (float)
- quantityAvailable Unpicked Bin Qty: number (float)
- receiptInventoryNumber Serial/Lot Number: string
- refName Reference Name: string
- secondaryQuantity Secondary Quantity: number (float)
- toBinNumber: bin
- toInventoryStatus: inventoryStatus
purchaseOrder-itemCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: purchaseOrder-itemElement
-
purchaseOrder-itemElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
purchaseOrder-itemElement
- amount Amount: number (double)
- assembly: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- assemblyUnits Assembly Units: string
- billOfMaterials: bom
- billOfMaterialsRevision: bomRevision
- billVarianceStatus: object
-
- id Internal identifier.: string NOVARIANCES , JOURNALNOTPOSTED , JOURNALPOSTED
- refName Reference Name: string
- class: classification
- createOutsourcedWo Create WO: boolean
- createdFrom: blanketPurchaseOrder
- createdOutsourcedWoKey Create outsourced WO key: string
- customer: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- department: department
- description Description: string
- excludeFromPredictiveRisk Exclude From Predictive Risk: boolean
- initOqpBucket Initial OQP Bucket: string
- inventoryDetail: purchaseOrder-item-inventoryDetail
- isBillable Billable: boolean
- isCatchWeightItem: boolean
- isClosed Closed: boolean
- isOpen Is Opened: boolean
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemSubtype: object
-
- id Internal identifier.: string Sale , Purchase , Resale
- refName Reference Name: string
- itemType: object
-
- job: job
- landedCostCategory: costCategory
- leadTime Lead Time: integer (int64)
- licenseCode License Code: string
- line Transaction Line: integer (int64)
- linked Linked: boolean
- linkedOrder: purchaseRequisitionCollection
- links Links: nsLink
-
nsLink - location: location
- marginal Marginal: boolean
- matchBillToReceipt Match Bill To Receipt: boolean
- matrixType Matrix Type: string
- minQty Minimum Quantity: number (float)
- options Options: string
- oqpBucket Oqp Bucket: string
- orderDoc: nsResource
- orderLine Order Line: integer (int64)
- primaryToSecondaryUnitConversionRate: number (float)
- printItems Print Items: boolean
- productionEndDate Production End Date: string (date)
- productionStartDate Production Start Date: string (date)
- projecttask: projectTask
- purchaseContract: purchaseContract
- quantity Quantity: number (float)
- quantityAllocated Quantity Allocated: number (float)
- quantityAvailable Available: number (float)
- quantityBilled Billed: number (float)
- quantityCommitted Committed: number (float)
- quantityDemandAllocated Allocated Demand: number (float)
- quantityFulfilled <NULL>: number (float)
- quantityOnHand On Hand: number (float)
- quantityOnShipments Quantity On Shipments: number (float)
- quantityPacked Quantity Packed: number (float)
- quantityReceived <NULL>: number (float)
- rate Rate: number (double)
- rateIncludingTax Rate: number (double)
- rateSchedule Rate Schedule: string
- refName Reference Name: string
- secondaryQuantity Secondary Quantity: number (float)
- secondaryUnitConversionRate: number (float)
- secondaryUnits Secondary Units: string
- secondaryUnitsList: string
- subsidiary: subsidiary
- targetLocation: location
- targetSubsidiary: subsidiary
- taxAmount Tax Amount: number (double)
- taxDetailsReference Tax Details Reference: string
- units Units: string
- vendorName Vendor Name: string
purchaseOrder-shippingAddress
- addr1 Address 1: string
-
Enter the address the way it should appear on forms. For employees, customers, partners, and vendors, what you enter here autofills on forms if this address is marked default for Shipping or Billing. Enter up to 50 characters. This field is required for the Online Bill Pay feature.
- addr2 Address 2: string
-
Enter an optional second address line the way it should appear on forms. For employees, customers, partners, and vendors, what you enter here autofills on forms if this address is marked default for Shipping or Billing. Enter up to 50 characters.
- addr3 Address 3: string
- addrPhone Phone: string
-
Enter the phone number.
- addrText Address: string
-
The values entered in the other address fields are displayed here.
- addressee Addressee: string
-
Enter the name of the entity that should appear on the shipping label here. This name appears on the shipping label below what you enter in the Attention field.
- attention Attention: string
-
Enter the name of the person to whom a shipment is addressed, as it should appear on shipping labels. This field is required for UPS Integration.
- city City: string
-
Enter the city the way it should appear on all forms except checks.
- country: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- externalId External ID: string
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - override Override: boolean
-
Check this box to disable the free-form address text field. When this field is disabled, text entered in the other address fields does not display in the Address text field. Clear this box to allow text entered in the address component fields to appear in the free-form address text field.
- refName Reference Name: string
- state State/Province: string
-
Enter your company's state or province the way it should appear on all forms except checks.
- zip Zip: string
-
Enter the postal code the way it should appear on all forms except checks.
purchaseOrder-taxDetailsCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: purchaseOrder-taxDetailsElement
-
purchaseOrder-taxDetailsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
purchaseOrder-taxDetailsElement
- calcDetail Details: string
- lineName Name: string
- lineType Line type: string
- links Links: nsLink
-
nsLink - netAmount Net Amount: number (double)
- refName Reference Name: string
- taxAmount Tax Amount: number (double)
- taxBasis Tax Basis: number (double)
- taxCode: salesTaxItem
- taxDetailsReference: object
-
- id Internal identifier.: string
- refName Reference Name: string
- taxRate Tax Rate: number (double)
- taxType Tax Type: string
purchaseOrderCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: purchaseOrder
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
purchaseOrder - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
purchaseRequisition
This record is available as a beta record.
- accountingBookDetail: purchaseRequisition-accountingBookDetailCollection
- approvalStatus: object
-
- id Internal identifier.: string 11 , 1 , 2 , 3
- refName Reference Name: string
- class: classification
- companyId Company Id: string
- createdDate Date Created: string (date-time)
- createdFrom: nsResource
- currency: currency
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- department: department
- discountAmount Discount Amount: number (double)
- discountDate Discount Date: string (date)
- dueDate Due Date: string (date)
-
In the Receive By field, enter the date you need to receive the requested items.
- endDate End Date: string (date)
- entity: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- estimatedTotal Estimated Total: number (double)
-
As you add items and expenses to the requisition, this field displays the estimated total.
- exchangeRate Exchange Rate: number (double)
- expense: purchaseRequisition-expenseCollection
- externalId External ID: string
- fob FOB: string
- id Internal ID: string
- item: purchaseRequisition-itemCollection
- lastModifiedDate Date Last Modified: string (date-time)
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
-
In the Memo field, enter a memo to identify this purchase order. You can use the Search Transactions feature, to search for specific words and phrases in this field.
- message Vendor Message: string
- nextApprover: employee
- originator Originator: string
- otherRefNum PO/Check Number: string
- prevDate Previous Effective Date: string (date)
- refName Reference Name: string
- shipDate Ship Date: string (date)
- source: object
-
- startDate Start Date: string (date)
- status: object
-
- id Internal identifier.: string A , B , R , C , D , E , F , G , H
- refName Reference Name: string
- storeOrder: string
- subsidiary: subsidiary
- subtotal Subtotal: number (double)
- terms: term
- total Total: number (double)
-
After a purchase order has been created, the requisition displays the actual total.
- trackingNumbers Tracking Numbers: string
- tranDate Date: string (date)
-
Enter a date for this requisition. The current date appears by default.
- tranId Transaction Number: string
-
In the Req # field, NetSuite increases the largest requisition number by one. If you wish, you can enter another number. The next requisition number will revert to the standard pattern. Note: The maximum number of characters you can enter in this field is 45.</p?
- webSite: string
purchaseRequisition-accountingBookDetailCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: purchaseRequisition-accountingBookDetailElement
-
purchaseRequisition-accountingBookDetailElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
purchaseRequisition-accountingBookDetailElement
This record is available as a beta record.
- accountingBook: accountingBook
- exchangeRate Exchange Rate: number (double)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- revRecOnRevCommitment Rev Rec on Rev Commit.: boolean
- subsidiary: subsidiary
- tranIsVsoeBundle Transaction Is VSOE Bundle: boolean
purchaseRequisition-expenseCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: purchaseRequisition-expenseElement
-
purchaseRequisition-expenseElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
purchaseRequisition-expenseElement
This record is available as a beta record.
- account: account
- amount Amount: number (double)
- category: expenseCategory
- class: classification
- customer: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- department: department
- estimatedAmount Estimated Amount: number (double)
- isBillable Billable: boolean
- isClosed Closed: boolean
- line Line: integer (int64)
- linkedOrder: purchaseOrderCollection
- linkedOrderStatus Linked Order Status: string
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
- poVendor: vendor
- projecttask: projectTask
- refName Reference Name: string
purchaseRequisition-item-inventoryDetail
This record is available as a beta record.
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- externalId External ID: string
- inventoryassignment: purchaseRequisition-item-inventoryDetail-inventoryassignmentCollection
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemDescription Description: string
-
A more complete Description of the item.
- links Links: nsLink
-
nsLink - location: location
- quantity Quantity: number (float)
-
In the Quantity to Build field, enter the number of assembly items you want to build. You cannot enter a quantity that exceeds the amount displayed in the Buildable Quantity field.
- refName Reference Name: string
- toLocation: location
- unit Units: string
-
If the assembly uses Units of Measure, the base units are displayed in the Units field.
purchaseRequisition-item-inventoryDetail-inventoryassignmentCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: purchaseRequisition-item-inventoryDetail-inventoryassignmentElement
-
purchaseRequisition-item-inventoryDetail-inventoryassignmentElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
purchaseRequisition-item-inventoryDetail-inventoryassignmentElement
This record is available as a beta record.
- binNumber: bin
- expirationDate Expiration Date: string (date)
- internalId Internal ID: integer (int64)
- inventoryDetail Inventory Detail: integer (int64)
- inventoryStatus: inventoryStatus
- issueInventoryNumber: inventoryNumber
- links Links: nsLink
-
nsLink - packCarton Pack Carton: string
- pickCarton Pick Carton: string
- quantity Quantity: number (float)
- quantityAvailable Unpicked Bin Qty: number (float)
- receiptInventoryNumber Serial/Lot Number: string
- refName Reference Name: string
- secondaryQuantity Secondary Quantity: number (float)
- toBinNumber: bin
- toInventoryStatus: inventoryStatus
purchaseRequisition-itemCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: purchaseRequisition-itemElement
-
purchaseRequisition-itemElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
purchaseRequisition-itemElement
This record is available as a beta record.
- amount Amount: number (double)
- billVarianceStatus: object
-
- id Internal identifier.: string NOVARIANCES , JOURNALNOTPOSTED , JOURNALPOSTED
- refName Reference Name: string
- class: classification
- createPo: object
-
- id Internal identifier.: string CostRtrn , EndrTeg , SpecOrd , AuthDep , InTrnPay , POrdBlnk , ResvShip , Capture , GLAdj , OppClose , LandCost , CountAdj , OrdReval , IntcoAdj , CpFxVar , OrdAlloc , FxAsset , GACAdjst , WaveShip , RfqCtrct , POrdPrep , OwnRcpt , Transfrm , DepRfnd , BillVar , OrdBuild , FftRqFt , DepAppl , Payment , Refund , ColTeg , Reimb , OrdDgrss , KitShip , OrdAuth , WipBuild , CtrctOrd , OrdClose , RevRec , OrdRvCom , PickPack , TOrdCost , SysJrnl , Commissn , COGS , SrcContr , OsrcMfg , EstInvc , RfqVend , OrdDep , WOReval , CostRec , PurchOwn , OppEst , POrdReq , OrdBill , ExpRec , NetAsset , PrepAppl , OrdFftRq , BillRcpt , OrdArrng , PurchRet , CostDef , ShipRcpt , SaleRet , DiscTeg , RcptBill , CostDefR , DropShip , WaveOrd , PayTeg
- refName Reference Name: string
- createdPo: purchaseOrder
- customer: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- department: department
- description Description: string
- estimatedAmount Estimated Amount: number (double)
- estimatedRate Estimated Rate: number (double)
- initOqpBucket Initial OQP Bucket: string
- inventoryDetail: purchaseRequisition-item-inventoryDetail
- isBillable Billable: boolean
- isClosed Closed: boolean
- isOpen Is Opened: boolean
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemSubtype: object
-
- id Internal identifier.: string Sale , Purchase , Resale
- refName Reference Name: string
- itemType: object
-
- job: job
- licenseCode License Code: string
- line Transaction Line: integer (int64)
- linked Linked: boolean
- linkedOrder: purchaseOrderCollection
- linkedOrderStatus Linked Order Status: string
- links Links: nsLink
-
nsLink - location: location
- marginal Marginal: boolean
- matrixType Matrix Type: string
- minQty Minimum Quantity: number (float)
- options Options: string
- oqpBucket Oqp Bucket: string
- poRate PO Rate: number (double)
- poVendor: vendor
- printItems Print Items: boolean
- projecttask: projectTask
- quantity Quantity: number (float)
- quantityAllocated Quantity Allocated: number (float)
- quantityAvailable Available: number (float)
- quantityCommitted Committed: number (float)
- quantityDemandAllocated Allocated Demand: number (float)
- quantityFulfilled <NULL>: number (float)
- quantityOnHand On Hand: number (float)
- quantityPacked Quantity Packed: number (float)
- quantityReceived <NULL>: number (float)
- rate Rate: number (double)
- rateIncludingTax Rate: number (double)
- rateSchedule Rate Schedule: string
- refName Reference Name: string
- subsidiary: subsidiary
- units Units: string
- vendorList: string
- vendorName Vendor Name: string
purchaseRequisitionCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: purchaseRequisition
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
purchaseRequisition - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
receiveInboundShipment
This record is available as a beta record.
- externalId External ID: string
- id Inbound Shipment: string
- inboundShipmentNumber Inbound Shipment: string
-
This field is pre-populated with the Shipment Number the transfer relates to.
- incoterm: nsResource
- links Links: nsLink
-
nsLink - postingperiod: accountingPeriod
- receiveItems: receiveInboundShipment-receiveItemsCollection
- receivinglocation: location
- refName Reference Name: string
- trandate Date: string (date)
-
NetSuite inserts today's date for the posting date of this purchase order. You can type or pick another date. What you enter here determines the date range in which this transaction appears on the Purchase Orders Register. You can select or enter custom date ranges on registers.
- vendor: vendor
receiveInboundShipment-receiveItemsCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: receiveInboundShipment-receiveItemsElement
-
receiveInboundShipment-receiveItemsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
receiveInboundShipment-receiveItemsElement
This record is available as a beta record.
- amount Amount: number (double)
- currency: currency
- currencyPrecision Currency Precision: integer (int64)
- description Description: string
- exchangeRate Exchange Rate: number (double)
- id ID: integer (int64)
- incoterm: nsResource
- inventoryDetail: integer (int64)
- inventoryDetailSet: string
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemType Item Type: string
- links Links: nsLink
-
nsLink - origLine Item Source: integer (int64)
- ownershipTransfer: nsResource
- ownershipTransferLineId Line Id: integer (int64)
- poRate PO Rate: number (double)
- purchaseOrder: nsResource
- quantity Quantity: number (float)
- quantityReceived Quantity Received: number (float)
- quantityRemaining Quantity Remaining: number (float)
- quantityToBeReceived Quantity to be Received: number (float)
- rate Rate: number (double)
- receiveItem Receive: boolean
- receivingLocation: location
- refName Reference Name: string
- uniqueKey Unique Key: string
- unit Unit: string
- unitId Unit of Measure: string
- unitRate Conversion Rate {1}: number (float)
- vendor Vendor: string
receiveInboundShipmentCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: receiveInboundShipment
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
receiveInboundShipment - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
resourceAllocation
This record is available as a beta record.
- allocationAmount Allocate: number (float)
-
Enter the number of hours you want this resource allocated. Or, select Percent of Time in the dropdown and then enter the percentage you want this resource allocated over the selected time period. For example, a resource that typically works 8 hours a day for a 5 day work week is allocated 50% for two weeks would work on the project 4 hours per day for a total of 40 hours.
- allocationResource: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- allocationType: object
-
- id Internal identifier.: string
- refName Reference Name: string
- allocationUnit: object
-
- id Internal identifier.: string H , P
- refName Reference Name: string
- approvalStatus: object
-
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- endDate End Date: string (date)
-
Select the date you want this allocation to end.
- externalId External ID: string
- id Internal ID: string
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - nextApprover: employee
- notes Notes: string
-
Enter any additional information about this allocation.
- numberHours Number of Hours: number (float)
-
This field displays the number of hours requested in this allocation. If the allocation is requested using Percent of Time, NetSuite calculates the number of hours based on the requested percentage, selected dates, and the resource's work calendar.
- percentOfTime Percentage of Time: number (float)
-
This field displays the percentage of time requested by this allocation. If the allocation is requested using Number of Hours, NetSuite calculates the percentage based on the requested hours, selected dates, and the resource's work calendar.
- project: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- projectTask: projectTask
- refName Reference Name: string
- requestedBy: employee
- startDate Start Date: string (date)
-
Select the date you want this allocation to begin.
- userNotes: resourceAllocation-userNotesCollection
resourceAllocation-userNotesCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: resourceAllocation-userNotesElement
-
resourceAllocation-userNotesElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
resourceAllocationCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: resourceAllocation
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
resourceAllocation - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
returnAuthorization
This record is available as a beta record.
- accountingBookDetail: returnAuthorization-accountingBookDetailCollection
- altSalesTotal Alt. Sales Total: number (double)
-
The alternate sales amount total is shown here.
- appliedRules: returnAuthorization-appliedRulesCollection
- billAddr1 Billing Address Line 1: string
- billAddr2 Billing Address Line 2: string
- billAddr3 Billing Address Line 3: string
- billAddress Bill To: string
-
The default billing address autofills this field from the customer's record at Lists > Relationships > Customers. To enter a different address: * Select another address in the Bill To Select field. * Select New in the Bill To Select field to enter a new billing address.
- billAddressList: nsResource
- billAddressee Billing Addressee: string
- billAttention Billing Attention: string
- billCity Billing Address City: string
- billCountry: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- billOverride Override: string
- billPhone Billing Phone: string
- billState Billing Address State: string
- billZip Billing Address Zip Code: string
- billingAddress: returnAuthorization-billingAddress
- billingAddress_text Billing Address: string
- cardSwipe Card Swipe: string
- cardholderAuthentication: cardholderAuthentication
- checkNumber Check #: string
- class: classification
- contribPct Contribution Percentage: string
- createdDate Date Created: string (date-time)
- createdFrom: nsResource
- currency: currency
- customForm: object
-
- id Internal identifier.: string -9915 , -9916
- refName Reference Name: string
- customerPaymentAuthorization: customerPaymentAuthorization
- debitKsn Debit KSN: string
- debitPinBlock Debit Pin Block: string
- deferredRevenue Deferred Revenue: number (double)
-
Deferred Revenue: amount of revenue deferred on this transaction
- department: department
- drAccount: account
- dynamicDescriptor Soft Descriptor: string
- email Email: string
- entity: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- entityTaxRegNum Customer Tax Reg. Number: string
- estGrossProfit Est. Gross Profit: number (double)
-
Estimated Gross Profit: Read-only field that equals the revenue amount minus the Est. Cost. At the transaction level, it equals the gross profit of all lines, factoring transaction-level discounts and markups.
- estGrossProfitPercent Est. Gross Profit Percent: number (double)
-
Estimated Gross Profit Margin, as a percentage: Read-only field that equals the Est. Gross Profit divided by revenue, expressed as a percentage. At the transaction level, it equals the gross profit percent of all lines, factoring transaction-level discounts and markups.
- exchangeRate Exchange Rate: number (double)
-
The currency's exchange rate is shown in this field. You can edit the exchange rate for this transaction only, or you can update the currency record with the exchange rate you enter here.
- excludeCommission Exclude Commissions: boolean
-
Check this option to exclude this transaction and its subordinate transactions from inclusion in all commission calculations.
- externalId External ID: string
- fxAccount: account
- handlingMode: object
-
- id Internal identifier.: string SAVE_ONLY
- refName Reference Name: string
- id Internal ID: string
- inputReferenceCode Input P/N Ref.: string
- integrationId: string
- intercoStatus: object
-
- id Internal identifier.: string 1 , 2 , 3
- refName Reference Name: string
- intercoTransaction: nsResource
- isCrossSubTransaction Allow Cross-Subsidiary Customer Return: boolean
-
Clear the Allow Cross-Subsidiary Returns box to allow returns to be received only from locations directly associated with the transaction subsidiary. Check the Allow Cross-Subsidiary Returns box box to allow receipt of returns to locations listed on GIR records associated with the transaction subsidiary. This box is checked with all locations included by default. The Inventory Location column and Inventory Subsidiary column show when the Allow Cross-Subsidiary Fulfillment feature is enabled. For each line item, use the To Location field to select the receiving location. This field shows these locations: * Locations directly associated with the transaction subsidiary * Locations listed on the Customer Return subtab of related GIR records
- item: returnAuthorization-itemCollection
- job: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- lastModifiedDate Date Last Modified: string (date-time)
- leadSource: nsResource
- links Links: nsLink
-
nsLink - location: location
- memo Reason for Return: string
-
If you wish, enter a memo to describe this return authorization. What you enter in this field will appear on reports.
- message Customer Message: string
-
Select a customer message that will appear on the Return Authorization form. To add additional choices to this list, go to Setup > Accounting > Accounting Lists > New > Customer Message.
- messageSel: customerMessage
- needsRevCommitment: boolean
- nexus: nexus
- ordRevCommitted: boolean
- orderStatus: object
-
- id Internal identifier.: string A , B
- refName Reference Name: string
- originator Originator: string
- otherRefNum PO/Check Number: string
-
For your customers' convenience, you can enter their purchase order number here.
- outputAuthCode Auth. Code: string
- outputReferenceCode P/N Ref.: string
- partner: partner
- partners: returnAuthorization-partnersCollection
- paymentCardCsc CSC: string
- paymentDeviceId Payment Device ID: string
- paymentInstrumentLimit Payment Instrument Limit: number (double)
- paymentOption: nsResource
- paymentProcessingProfile: nsResource
- prevDate Previous Effective Date: string (date)
- prevPartner Previous Partner: integer (int64)
- prevRep Previous Representative: integer (int64)
- recognizedRevenue Recognized Revenue: number (double)
-
Recognized Revenue: cumulative amount of revenue recognized for this transaction
- refName Reference Name: string
- revCommitStatus Revenue Commitment Status: string
-
This field provides information about Revenue Commitment(s) in the case of a Sales Order or Revenue Commitment Reversal(s) in the case of a Return Authorization. If you uncheck the Rev Rec on Rev Commit. Field, the Rev. Commit. Status field displays information about the related Invoice(s) or Credit Memo(s). The possible values for this field and definitions are as follows: 1. Pending Commitment - No related revenue transactions have been created. 2. Partially Committed - Some related revenue transactions have been created. 3. Committed - All related revenue transactions have been created.
- revCommitStatusDescr Revenue Commitment Status: string
- revRecOnRevCommitment Rev Rec on Rev Commit.: boolean
-
Check this check box to create a Revenue Commitment or Revenue Commitment Reversal. * On a Sales Order, the Revenue Commitment replaces an invoice * On a Return Authorization, the Revenue Commitment Reversal replaces a credit memo. NetSuite creates all applicable Revenue Recognition schedules the Revenue Commitment or Revenue Commitment Reversal.
- revenueStatus Revenue Status: string
-
The possible values for this field are: 1. Pending: indicates that no recognition has occurred. All revenue is still deferred. 2. In Progress: indicates that some recognition has occurred. 3. Completed: indicates that all recognition has occurred. No deferred revenue remains.
- revenueStatusDescr Revenue Status: string
- salesEffectiveDate Sales Effective Date: string (date)
-
You can change the sales effective date for this transaction. The sales effective date determines which commission plan and historical sales team this transaction applies to. If this return is created from a sales order, the sales effective date from the order shown in the Created From field is set by default for this return authorization.
- salesRep: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- salesTeam: returnAuthorization-salesTeamCollection
- shipAddress Ship To: string
-
The default shipping address autofills this field from the customer's record at Lists > Customers. To enter a different address: * Select another address in the Ship To Select field. * Select New in the Ship To Select field to enter a new billing address.
- shipAddressList: nsResource
- shipIsResidential Shipping address is residential: boolean
- shipOverride Override: boolean
- shippingAddress: returnAuthorization-shippingAddress
- shippingAddress_text Shipping Address: string
- source: object
-
- status: object
-
- id Internal identifier.: string A , B , C , D , E , F , G , H
- refName Reference Name: string
- storeOrder: string
- subsidiary: subsidiary
- subsidiaryTaxRegNum Subsidiary Tax Reg. Number: string
-
This field shows the tax registration number of the transaction nexus. NetSuite automatically populates this field based on the nexus lookup logic. You can override the transaction nexus and tax registration number that NetSuite automatically selects by checking the Nexus Override box. When you select a different tax registration number in the dropdown list, the corresponding nexus is automatically selected in the Nexus field.
- subtotal Subtotal: number (double)
-
This field shows the total of the items on this return authorization. This is the total before any discount, shipping cost, handling cost or tax is added to the order.
- taxDetails: returnAuthorization-taxDetailsCollection
- taxDetailsOverride Tax Details Override: boolean
-
Check this box to override the tax information on the Tax Details subtab of the transaction. Only roles with at least the Edit level of the Tax Details Tab permission can override the tax details.
- taxPointDate Tax Point Date: string (date)
- taxPointDateOverride Tax Point Date Override: boolean
- taxRegOverride Tax Registration Override: boolean
-
Check this box to override the values in the Nexus and Subsidiary Tax Reg. Number fields. Only roles with at least the Edit level of the Tax Details Tab permission can override the values that NetSuite automatically selects in these fields.
- taxTotal Tax: number (double)
-
NetSuite multiplies the tax rate by the taxable total of line items and enters it here.
- toBeEmailed To Be Emailed: boolean
-
Check this box if you want to e-mail this return authorization. Then enter the e-mail address in the space to the right of the check box. You can enter multiple e-mail addresses by separating them with a semicolon. It is important to separate the addresses with only a semicolon, and do not include any spaces.
- toBeFaxed To Be Faxed: boolean
-
Check this box if you want to fax this transaction. Enter the fax number in the space to the right of the check box if it doesn't already appear. To fax NetSuite forms, an administrator must first set up fax service at Setup > Company > Printing, Fax and Email Preferences.
- toBePrinted To Be Printed: boolean
-
Check this box if you want to save this in a queue of return authorization you can later chose to print. Otherwise, you can click Print below to submit and print this return authorization at once.
- total Total: number (double)
-
NetSuite computes the total of line items and tax and then enters it here.
- totalAfterTaxes Total After Taxes: number (double)
- totalCostEstimate Est. Cost: number (double)
-
Estimated Cost: Estimated cost of the specific number of items; estimated rate x quantity = estimated cost.
- tranDate Date: string (date)
-
The current date autofills this field. Enter or select another date if needed.
- tranId Transaction Number: string
-
NetSuite increases the largest return authorization number by one. If you wish, you can type another number. The next return number will revert to the standard pattern. You can enter a maximum of 45 characters in this field.
- tranIsVsoeBundle Transaction Is VSOE Bundle: boolean
-
Check this box to include all items added to this transaction as a VSOE bundle.
- transactionToRefund: nsResource
- vsoeAutoCalc Auto Calculate VSOE Allocation: boolean
-
The VSOE allocation amount can be calculated automatically by checking the Auto Calculate VSOE Allocation box. Allocation is the process to determine the VSOE price for items. The total VSOE amount allocated is the revenue amount to be recognized for the bundle.
- webSite: string
- weekendpreference: string
returnAuthorization-accountingBookDetailCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: returnAuthorization-accountingBookDetailElement
-
returnAuthorization-accountingBookDetailElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
returnAuthorization-accountingBookDetailElement
This record is available as a beta record.
- accountingBook: accountingBook
- exchangeRate Exchange Rate: number (double)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- revRecOnRevCommitment Rev Rec on Rev Commit.: boolean
- subsidiary: subsidiary
- tranIsVsoeBundle Transaction Is VSOE Bundle: boolean
returnAuthorization-appliedRulesCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: returnAuthorization-appliedRulesElement
-
returnAuthorization-appliedRulesElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
returnAuthorization-billingAddress
This record is available as a beta record.
- addr1 Address 1: string
-
Enter the address the way it should appear on forms. For employees, customers, partners, and vendors, what you enter here autofills on forms if this address is marked default for Shipping or Billing. Enter up to 50 characters. This field is required for the Online Bill Pay feature.
- addr2 Address 2: string
-
Enter an optional second address line the way it should appear on forms. For employees, customers, partners, and vendors, what you enter here autofills on forms if this address is marked default for Shipping or Billing. Enter up to 50 characters.
- addr3 Address 3: string
- addrPhone Phone: string
-
Enter the phone number.
- addrText Address: string
-
The values entered in the other address fields are displayed here.
- addressee Addressee: string
-
Enter the name of the entity that should appear on the shipping label here. This name appears on the shipping label below what you enter in the Attention field.
- attention Attention: string
-
Enter the name of the person to whom a shipment is addressed, as it should appear on shipping labels. This field is required for UPS Integration.
- city City: string
-
Enter the city the way it should appear on all forms except checks.
- country: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- externalId External ID: string
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - override Override: boolean
-
Check this box to disable the free-form address text field. When this field is disabled, text entered in the other address fields does not display in the Address text field. Clear this box to allow text entered in the address component fields to appear in the free-form address text field.
- refName Reference Name: string
- state State/Province: string
-
Enter your company's state or province the way it should appear on all forms except checks.
- zip Zip: string
-
Enter the postal code the way it should appear on all forms except checks.
returnAuthorization-item-inventoryDetail
This record is available as a beta record.
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- externalId External ID: string
- inventoryassignment: returnAuthorization-item-inventoryDetail-inventoryassignmentCollection
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemDescription Description: string
-
A more complete Description of the item.
- links Links: nsLink
-
nsLink - location: location
- quantity Quantity: number (float)
-
In the Quantity to Build field, enter the number of assembly items you want to build. You cannot enter a quantity that exceeds the amount displayed in the Buildable Quantity field.
- refName Reference Name: string
- toLocation: location
- unit Units: string
-
If the assembly uses Units of Measure, the base units are displayed in the Units field.
returnAuthorization-item-inventoryDetail-inventoryassignmentCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: returnAuthorization-item-inventoryDetail-inventoryassignmentElement
-
returnAuthorization-item-inventoryDetail-inventoryassignmentElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
returnAuthorization-item-inventoryDetail-inventoryassignmentElement
This record is available as a beta record.
- binNumber: bin
- expirationDate Expiration Date: string (date)
- internalId Internal ID: integer (int64)
- inventoryDetail Inventory Detail: integer (int64)
- inventoryStatus: inventoryStatus
- issueInventoryNumber: inventoryNumber
- links Links: nsLink
-
nsLink - packCarton Pack Carton: string
- pickCarton Pick Carton: string
- quantity Quantity: number (float)
- quantityAvailable Unpicked Bin Qty: number (float)
- receiptInventoryNumber Serial/Lot Number: string
- refName Reference Name: string
- secondaryQuantity Secondary Quantity: number (float)
- toBinNumber: bin
- toInventoryStatus: inventoryStatus
returnAuthorization-itemCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: returnAuthorization-itemElement
-
returnAuthorization-itemElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
returnAuthorization-itemElement
This record is available as a beta record.
- altSalesAmt Alt. Sales Amount: number (double)
- amount Amount: number (double)
- billVarianceStatus: object
-
- id Internal identifier.: string NOVARIANCES , JOURNALNOTPOSTED , JOURNALPOSTED
- refName Reference Name: string
- catchUpPeriod: accountingPeriod
- class: classification
- costEstimate Est. Cost: number (double)
- costEstimateRate Est. Rate: number (double)
- costEstimateType: object
-
- id Internal identifier.: string PREFVENDORRATE , AVGCOST , PURCHORDERRATE , LASTPURCHPRICE , MEMBERDEFINED , CUSTOM , ITEMDEFINED , PURCHPRICE
- refName Reference Name: string
- deferRevRec Deferred Revenue: boolean
- department: department
- description Description: string
- doNotCreateRevenueElement Do Not Create Revenue Element: boolean
- estGrossProfit Est. Gross Profit: number (double)
- estGrossProfitPercent Est. Gross Profit Percent: number (double)
- giftCertFrom From: string
- giftCertMessage Gift Message: string
- giftCertNumber Code: string
- giftCertRecipientEmail Recipient Email: string
- giftCertRecipientName Recipient Name: string
- initOqpBucket Initial OQP Bucket: string
- inventoryDetail: returnAuthorization-item-inventoryDetail
- inventorylocation: location
- inventorysubsidiary: subsidiary
- isClosed Closed: boolean
- isDropShipment Drop Shipment: boolean
- isOpen Is Opened: boolean
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemSubtype: object
-
- id Internal identifier.: string Sale , Purchase , Resale
- refName Reference Name: string
- itemType: object
-
- job: job
- licenseCode License Code: string
- line Transaction Line: integer (int64)
- linked Linked: boolean
- links Links: nsLink
-
nsLink - location: location
- marginal Marginal: boolean
- matrixType Matrix Type: string
- minQty Minimum Quantity: number (float)
- options Options: string
- oqpBucket Oqp Bucket: string
- orderDoc: nsResource
- orderLine Order Line: integer (int64)
- price: priceLevel
- printItems Print Items: boolean
- processedByRevCommit Processed by Rev Commit: boolean
- quantity Quantity: number (float)
- quantityAllocated Quantity Allocated: number (float)
- quantityAvailable Available: number (float)
- quantityBilled Refunded: number (float)
- quantityCommitted Committed: number (float)
- quantityDemandAllocated Allocated Demand: number (float)
- quantityFulfilled <NULL>: number (float)
- quantityOnHand On Hand: number (float)
- quantityPacked Quantity Packed: number (float)
- quantityReceived <NULL>: number (float)
- rate Rate: number (double)
- rateIncludingTax Rate: number (double)
- rateSchedule Rate Schedule: string
- refName Reference Name: string
- revRecEndDate Rev. Rec. End Date: string (date)
- revRecSchedule: revRecSchedule
- revRecStartDate Rev. Rec. Start Date: string (date)
- revrec_recurrencetype Rev Rec Recurrence Type: string
- subsidiary: subsidiary
- taxAmount Tax Amount: number (double)
- taxDetailsReference Tax Details Reference: string
- units Units: string
- vsoeAllocation Allocation Amount: number (double)
- vsoeAmount Calculated Amount: number (double)
- vsoeDeferral: object
-
- id Internal identifier.: string DEFERALLUNTIL , DEFERUNTIL
- refName Reference Name: string
- vsoeDelivered Delivered: boolean
- vsoeIsEstimate Estimate: boolean
- vsoePermitDiscount: object
-
- id Internal identifier.: string IFDELIVERED , NEVER
- refName Reference Name: string
- vsoePrice Allocation Price: number (double)
- vsoeSOPGroup: object
-
- id Internal identifier.: string EXCLUDE , NORMAL , SOFTWARE
- refName Reference Name: string
returnAuthorization-partnersCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: returnAuthorization-partnersElement
-
returnAuthorization-partnersElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
returnAuthorization-partnersElement
This record is available as a beta record.
- contribution Contribution %: number (double)
- isPrimary Primary: boolean
- links Links: nsLink
-
nsLink - partner: partner
- partnerRole: partnerCategory
- refName Reference Name: string
returnAuthorization-salesTeamCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: returnAuthorization-salesTeamElement
-
returnAuthorization-salesTeamElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
returnAuthorization-shippingAddress
This record is available as a beta record.
- addr1 Address 1: string
-
Enter the address the way it should appear on forms. For employees, customers, partners, and vendors, what you enter here autofills on forms if this address is marked default for Shipping or Billing. Enter up to 50 characters. This field is required for the Online Bill Pay feature.
- addr2 Address 2: string
-
Enter an optional second address line the way it should appear on forms. For employees, customers, partners, and vendors, what you enter here autofills on forms if this address is marked default for Shipping or Billing. Enter up to 50 characters.
- addr3 Address 3: string
- addrPhone Phone: string
-
Enter the phone number.
- addrText Address: string
-
The values entered in the other address fields are displayed here.
- addressee Addressee: string
-
Enter the name of the entity that should appear on the shipping label here. This name appears on the shipping label below what you enter in the Attention field.
- attention Attention: string
-
Enter the name of the person to whom a shipment is addressed, as it should appear on shipping labels. This field is required for UPS Integration.
- city City: string
-
Enter the city the way it should appear on all forms except checks.
- country: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- externalId External ID: string
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - override Override: boolean
-
Check this box to disable the free-form address text field. When this field is disabled, text entered in the other address fields does not display in the Address text field. Clear this box to allow text entered in the address component fields to appear in the free-form address text field.
- refName Reference Name: string
- state State/Province: string
-
Enter your company's state or province the way it should appear on all forms except checks.
- zip Zip: string
-
Enter the postal code the way it should appear on all forms except checks.
returnAuthorization-taxDetailsCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: returnAuthorization-taxDetailsElement
-
returnAuthorization-taxDetailsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
returnAuthorization-taxDetailsElement
This record is available as a beta record.
- calcDetail Details: string
- lineName Name: string
- lineType Line type: string
- links Links: nsLink
-
nsLink - netAmount Net Amount: number (double)
- refName Reference Name: string
- taxAmount Tax Amount: number (double)
- taxBasis Tax Basis: number (double)
- taxCode: salesTaxItem
- taxDetailsReference: object
-
- id Internal identifier.: string
- refName Reference Name: string
- taxRate Tax Rate: number (double)
- taxType Tax Type: string
returnAuthorizationCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: returnAuthorization
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
returnAuthorization - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
revRecSchedule
This record is available as a beta record.
- accountingBook: accountingBook
- amortizationPeriod Recognition Period: integer (int64)
-
This field sets the number of periods over which the schedule will amortize. For example, if you enter 12, then the schedule runs for 12 periods starting from the Rev Rec Start Date. If both the Rev Rec Start Date and Rev Rec End Date are entered, then those dates override the recognition period set on the template. Note: If either the Rev Rec Start Date or Rev Rec End Date field is empty, NetSuite populates either date based on the recognition period.
- amortizationType: object
-
- id Internal identifier.: string STANDARD , VARIABLE
- refName Reference Name: string
- baseCurrencyPrecision: integer (int64)
- endDate End Date: string (date)
-
The end date entered for this schedule appears here.
- externalId External ID: string
- forecastTemplate: revRecTemplate
- id Internal ID: string
- initialAmount Initial Amount: number (double)
-
Enter a percentage or amount to be recognized in the first recognition period. The remaining amount is then recognized according to the set amortization method.
- isAmortization: boolean
- isEliminate Eliminate: boolean
-
If this box is checked, the source transaction for the amortization schedule is an intercompany transaction. This field is read-only.
- isInactive Inactive: boolean
-
Check this box if you no longer want to use this template or schedule.
- isRecognized Is Recognized: boolean
- isSchedule: boolean
- job: job
- links Links: nsLink
-
nsLink - name Name: string
-
Enter a name for this template or schedule.
- parentSched: revRecTemplate
- periodOffset Period Offset: integer (int64)
-
Specify the number of periods to postpone the start of recognition for the entire schedule. For example, if your amortization terms are based on 30-day periods, enter a 2 in this field to wait 60 days before you begin recognizing revenue. This can be useful for services you sell that have a probationary or trial period. Setting a period offset does not change the number of periods in the schedule.
- recogIntervalSrc: object
-
- id Internal identifier.: string RECEIPTDATE , USERDEFINED , BETWEENBILLS , BETWEENBILLSRRDATE , SOREVRECDATES
- refName Reference Name: string
- recurrence: revRecSchedule-recurrenceCollection
- recurrenceType: object
-
- id Internal identifier.: string DATESPRORATE , EVENPERIODSPRORATE , CUSTOM , DATESINTOPERIODS , EVENPRORATEPERIOD
- refName Reference Name: string
- refName Reference Name: string
- remainingDeferredBalance Remaining Deferred Balance: number (double)
-
This field shows the amount on the schedule which has not yet been recognized.
- revRecNumber: string
- revRecOffset Start Offset: integer (int64)
-
Specify the number of periods to postpone the start of the recognition for a schedule. Setting a period offset changes the number of periods in the schedule because it postpones the beginning, but does not change the final period of the schedule.
- scheduleNumber Number: string
-
This number is automatically generated when you use Auto-Generated Numbering. If the Name field for the schedule is blank, the auto-generated number is used.
- sourceTran: nsResource
- startDate Start Date: string (date)
-
This shows the date revenue recogntion begins for this schedule. The starting period is specified by the recognition start date on invoices. If no recognition start date is specified, the posting date of the invoice is the recognition start date.
- status: object
-
- id Internal identifier.: string NOTSTARTED , INPROGRESS , COMPLETED , ONHOLD
- refName Reference Name: string
- target: string
- totalAmortized Total Recognized: number (double)
-
This field shows the amount on the schedule which has already been recognized to date.
- totalAmount Amount (Schedule Total): number (double)
-
This field displays the total amount to recognize for the schedule, including amounts already recognized. If you enabled the Allow Users to Modify Revenue Recognition Schedule preference, this field can be edited. When you change this amount, the amount of each line of the schedule updates in proportion to the amount change. Only amounts that have not yet been recognized can be changed. The total amount of the schedule must always equal the sales amount or VSOE allocation amount of the related line item.
- tranLineId: string
- tranType: string
revRecSchedule-recurrenceCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: revRecSchedule-recurrenceElement
-
revRecSchedule-recurrenceElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
revRecSchedule-recurrenceElement
This record is available as a beta record.
- defRevAccount: account
- incomeAccount: account
- isRecognized Is Recognized: boolean
- jDate Date Executed: string (date)
- journal Journal: string
- journalDoc: string
- links Links: nsLink
-
nsLink - pctAmortInPeriod % Amortized In Period: number (double)
- pctTotalAmortization % Total Amortized: number (double)
- periodOffset Period Offset: integer (int64)
- postingPeriod: accountingPeriod
- recAmount Amount: number (double)
- recurDate Date: string (date)
- refName Reference Name: string
- totalAmortizedMach Total Recognized: number (double)
revRecScheduleCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: revRecSchedule
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
revRecSchedule - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
revRecTemplate
This record is available as a beta record.
- amortizationPeriod Recognition Period: integer (int64)
-
This field sets the number of periods over which the schedule will amortize. For example, if you enter 12, then the schedule runs for 12 periods starting from the Rev Rec Start Date. If both the Rev Rec Start Date and Rev Rec End Date are entered, then those dates override the recognition period set on the template. Note: If either the Rev Rec Start Date or Rev Rec End Date field is empty, NetSuite populates either date based on the recognition period.
- amortizationType: object
-
- id Internal identifier.: string STANDARD , VARIABLE
- refName Reference Name: string
- externalId External ID: string
- id Internal ID: string
- initialAmount Initial Amount: number (double)
-
Enter a percentage or amount to be recognized in the first recognition period. The remaining amount is then recognized according to the set amortization method.
- isAmortization: boolean
- isInactive Inactive: boolean
-
Check this box if you no longer want to use this template or schedule.
- isPublic Public: boolean
-
This field indicates whether this revenue recognition template is available to other users.
- isSchedule: boolean
- job: job
- links Links: nsLink
-
nsLink - name Name: string
-
Enter a name for this template or schedule.
- periodOffset Period Offset: integer (int64)
-
Specify the number of periods to postpone the start of recognition for the entire schedule. For example, if your amortization terms are based on 30-day periods, enter a 2 in this field to wait 60 days before you begin recognizing revenue. This can be useful for services you sell that have a probationary or trial period. Setting a period offset does not change the number of periods in the schedule.
- recogIntervalSrc: object
-
- id Internal identifier.: string RECEIPTDATE , USERDEFINED , BETWEENBILLS , BETWEENBILLSRRDATE , SOREVRECDATES
- refName Reference Name: string
- recurrence: revRecTemplate-recurrenceCollection
- recurrenceType: object
-
- id Internal identifier.: string DATESPRORATE , EVENPERIODSPRORATE , CUSTOM , DATESINTOPERIODS , EVENPRORATEPERIOD
- refName Reference Name: string
- refName Reference Name: string
- revRecNumber: string
- revRecOffset Start Offset: integer (int64)
-
Specify the number of periods to postpone the start of the recognition for a schedule. Setting a period offset changes the number of periods in the schedule because it postpones the beginning, but does not change the final period of the schedule.
- target: string
- totalAmount Amount: number (double)
-
This field displays the total amount to recognize for the schedule, including amounts already recognized. If you enabled the Allow Users to Modify Revenue Recognition Schedule preference, this field can be edited. When you change this amount, the amount of each line of the schedule updates in proportion to the amount change. Only amounts that have not yet been recognized can be changed. The total amount of the schedule must always equal the sales amount or VSOE allocation amount of the related line item.
revRecTemplate-recurrenceCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: revRecTemplate-recurrenceElement
-
revRecTemplate-recurrenceElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
revRecTemplateCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: revRecTemplate
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
revRecTemplate - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
revenueArrangement
This record is available as a beta record.
- accountingBook: accountingBook
- approvalStatus: object
-
- id Internal identifier.: string 11 , 1 , 2 , 3
- refName Reference Name: string
- arrangementMessage: revenueArrangement-arrangementMessageCollection
- class: classification
- compliant Compliant: boolean
-
This box is checked when revenue allocation is successful or not required. It is clear when the system-executed revenue allocation has failed. You can clear the box to enable reallocation. The Transaction is Allocation Bundle must be checked.
- contRevHandlingTriggered Contingent Revenue Handling Triggered: boolean
- contingentForBook: boolean
- contractCostAccrualDate Contract Cost Accrual Date: string (date)
-
The default is the revenue arrangement date. If you change this date after a deferred cost journal entry has been created, the current journal entry is reversed and a new journal entry is created.
- contractCostAmount Contract Acquisition Cost Amount (Base Currency): number (double)
-
Enter the total direct contract acquisition cost for the revenue arrangement, exclusive of item-specific costs. This cost is allocated among the revenue elements. Item-specific costs for item resale and item labor are included in the revenue elements. For details, see Using Advanced Cost Amortization.
- contractDeferredExpenseAcct: account
- contractExpenseAcct: account
- contractExpenseSourceAcct: account
- contractcostamountexists: string
- contractexpenseplancreated: string
- createdDate Date Created: string (date-time)
- createdfrommergedarrangements Created From Merged Arrangements: boolean
-
This box is checked when the revenue arrangement is the result of a merge. Individual revenue element records include a Last Merged from Arrangement field with a link to the previous revenue arrangement that included them.
- currency: currency
- currencyPrecision Currency Precision: integer (int64)
- currentchangeorderarrangement: string
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- deferredCostJournalEntry: journalEntryCollection
- department: department
- entity: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- externalId External ID: string
- id Internal ID: string
- lastModifiedDate Date Last Modified: string (date-time)
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
-
Enter notes for this arrangement here. This field is included in the default list view for revenue arrangements.
- mergedintonewarrangements Merged Into New Arrangements: boolean
-
This box is checked when some or all of the revenue elements from the revenue arrangement have been merged into another revenue arrangement. The Revenue Arrangement Version subtab of the Revenue Elements subtab includes links to Revenue Arrangement Version pages.
- nextApprover: employee
- oldchangeorderarrangement: string
- prevDate Previous Effective Date: string (date)
- refName Reference Name: string
- revenueElement: revenueArrangement-revenueElementCollection
- revenueplanstatus: object
-
- id Internal identifier.: string COMPLETED , ONHOLD , NOTSTARTED , PLANFAILED , INPROGRESS
- refName Reference Name: string
- subsidiary: subsidiary
- totalAllocationAmount Total Carve-out: number (double)
-
This read-only field is the total revenue that has been moved between elements from the discounted sales amount to the revenue amount. It is always a positive number.
- totalRevenueAmount Total Revenue Amount: number (double)
-
This read-only field is the sum of the Revenue Amount fields of the revenue elements.
- totalSellingAmount Transaction Total: number (double)
-
This read-only field is the sum of the Discounted Sales Amount fields of the revenue elements.
- tranDate Date: string (date)
-
The date is automatically set when the revenue arrangement is created. You can type or select a new date. If revenue plans use this date for their start date and if recognition has not yet begun, the plan start date is also updated.
- tranId Number: string
-
This number is generated automatically. You can change the number if the Allow Override box is checked for Revenue Arrangement in the Document Number subtab of the Set Up Auto-Generated Numbers page.
- tranIsVsoeBundle Transaction Is VSOE Bundle: boolean
-
Check this box to indicate that revenue is allocated between the revenue elements.
revenueArrangement-arrangementMessageCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: revenueArrangement-arrangementMessageElement
-
revenueArrangement-arrangementMessageElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
revenueArrangement-arrangementMessageElement
This record is available as a beta record.
- isCompliant Is Compliant: boolean
- links Links: nsLink
-
nsLink - message Description: string
- messageDate Date: string (date-time)
- messageProcess Process: string
- messageType Type: string
- migrationId: integer (int64)
- migrationLog Migration Log: integer (int64)
- migrationUrl: string
- refName Reference Name: string
- revenueElement: nsResource
revenueArrangement-revenueElementCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: revenueArrangement-revenueElementElement
-
revenueArrangement-revenueElementElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
revenueArrangement-revenueElementElement
This record is available as a beta record.
- accountingBook Accounting Book: string
- allocatedcontractcostamount Allocated Contract Acquisition Cost Amount (Base Currency): number (double)
- allocationAmount Revenue Amount: number (double)
- allocationType: object
-
- id Internal identifier.: string EXCLUDE , NORMAL , SOFTWARE
- refName Reference Name: string
- alternateQuantity Alternate Quantity: number (float)
- alternateUnits Alternate Unit: string
- alternateUnitsType: unitsType
- amortizStartDate Amortization Start Date: string (date)
- amortizationEndDate Amortization End Date: string (date)
- amortizationSched: amortizationSchedule
- amortizationTemplate: amortizationTemplate
- amount Sales Amount: number (double)
- baseAmount Sales Amount: number (double)
- calculatedAmount Calculated Fair Value Amount: number (double)
- carveOverride Override System Carve: boolean
- carveinamount System Carve In: number (double)
- carveinratio Carve-In %: number (double)
- carveoutamount System Carve Out: number (double)
- carveoutratio Carve-Out %: number (double)
- class: classification
- contingentRevenueHandling Eligible For Contingent Revenue Handling: boolean
- contractExpenseAcct: account
- contractExpenseOffsetAcct: account
- contractcostallocationpct Contract Acquisition Cost Allocation Ratio Override: number (double)
- costAmortizationAmount Cost Amortization Amount: number (double)
- createRevenuePlansOn: nsResource
- currency: currency
- currencyPrecision Currency Precision: integer (int64)
- customer: customer
- deferContractExpenseAcct: account
- deferralAccount: account
- delivered Delivered: boolean
- department: department
- discountedAmount Discounted Sales Amount: number (double)
- effectiveEndDate Effective End Date: string (date)
- effectiveStartDate Effective Start Date: string (date)
- elementDate Source Date: string (date)
- exchangeRate Exchange Rate: number (double)
- expensemigrateadjaccount: account
- fairValue Base Fair Value: number (double)
- fairValueOverride Fair Value Override: boolean
- forecastEndDate Forecast End Date: string (date)
- forecastStartDate Forecast Start Date: string (date)
- hasRecognizedRevenuePlan Create Revenue Plans On: boolean
- indentlevel <NULL>: integer (int64)
- isBOMItemType Is Kit Item Type: boolean
- isVsoePrice VSOE: boolean
- item: inventoryItem
- itemisautoexpand: boolean
- itemisresale <NULL>: string
- itemlaborcostamount Item Labor Cost Amount (Base Currency): number (double)
- itemresalecostamount Item Resale Cost Amount (Base Currency): number (double)
- journalEntry: journalEntry
- kitlevel <NULL>: integer (int64)
- labordeferredexpenseacct: account
- laborexpenseacct: account
- laborexpenseplanhasbeencreated <NULL>: string
- lastmergedfromarrangement: revenueArrangement
- line: string
- links Links: nsLink
-
nsLink - location: location
- newStandardMigrateDate Transition to New Standard: string (date)
- originalChangeOrderDiscAmount Original Discounted Sales Amount: number (double)
- originalChangeOrderQuantity Original Quantity: number (float)
- parentBOMElement Parent Kit Element: string
- parentisexcluded <NULL>: string
- permitDiscount Permit Discount: boolean
- planhasbeencreated <NULL>: string
- postingDiscountApplied Posting Discount Applied: boolean
- preChangeOrderAltQuantity <NULL>: number (float)
- preChangeOrderCalcAmount <NULL>: number (double)
- preChangeOrderContractCost <NULL>: number (double)
- preChangeOrderDiscSalesAmount <NULL>: number (double)
- preChangeOrderLaborCost <NULL>: number (double)
- preChangeOrderQuantity <NULL>: number (float)
- preChangeOrderResaleCost <NULL>: number (double)
- preChangeOrderResidDiscAmount <NULL>: number (double)
- preChangeOrderRevenueAmount <NULL>: number (double)
- preChangeOrderRevenueElement <NULL>: integer (int64)
- preChangeOrderSalesAmount <NULL>: number (double)
- quantity Quantity: number (float)
- recognitionAccount: account
- refName Reference Name: string
- referenceId Reference ID: string
- resaledeferredexpenseaccount <NULL>: string
- resaleexpenseaccount <NULL>: string
- residualDiscSalesAmount Residual Discounted Sales Amount: number (double)
- returnOfElement: nsResource
- revRecEndDate End Date: string (date)
- revRecEndDateSource Revenue Recognition End Date Source: string
- revRecForecastRule: nsResource
- revRecStartDate Start Date: string (date)
- revenueAllocationGroup: nsResource
- revenueAllocationRatio Revenue Allocation Ratio: number (double)
- revenueElement: nsResource
- revenuePlan Revenue Recognition Plan: string
- revenueRecognitionRule: nsResource
- revenuemigrateadjaccount: account
- revenueplanstatus: object
-
- id Internal identifier.: string COMPLETED , ONHOLD , NOTSTARTED , PLANFAILED , INPROGRESS
- refName Reference Name: string
- revreclassfxaccount: account
- source Source: string
- sourceId: integer (int64)
- sourceType: string
- subscriptionLine Subscription Line: string
- subsidiary Subsidiary: string
- termInDays Term In Days: integer (int64)
- termInMonths Term In Months: integer (int64)
- treatmentOverride Exclude from Treatment Lookup: boolean
- unbilledreceivablegroup Unbilled Receivable Group: string
- units Units: string
revenueArrangementCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: revenueArrangement
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
revenueArrangement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
revenueCommitment
This record is available as a beta record.
- accountingBook: accountingBook
- accountingBookDetail: revenueCommitment-accountingBookDetailCollection
- billAddr1 Billing Address Line 1: string
- billAddr2 Billing Address Line 2: string
- billAddr3 Billing Address Line 3: string
- billAddress Bill To: string
- billAddressList: nsResource
- billAddressee Billing Addressee: string
- billAttention Billing Attention: string
- billCity Billing Address City: string
- billCountry: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- billOverride Override: string
- billPhone Billing Phone: string
- billState Billing Address State: string
- billZip Billing Address Zip Code: string
- billingAddress: revenueCommitment-billingAddress
- billingAddress_text Billing Address: string
- class: classification
- contribPct Contribution Percentage: string
- createdDate Date Created: string (date-time)
- createdFrom: nsResource
- currency: currency
- customForm: object
-
- id Internal identifier.: string -9940
- refName Reference Name: string
- deferredRevenue Deferred Revenue: number (double)
- department: department
- discountAmount Discount Amount: number (double)
- discountDate Discount Date: string (date)
- dueDate Due Date: string (date)
- endDate End Date: string (date)
-
The date revenue recognition for this revenue commitment is complete. The date is derived from the sales order.
- entity: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- exchangeRate Exchange Rate: number (double)
-
The rate used to convert the transaction currency to the subsidiary's base currency.
- excludeCommission Exclude Commissions: boolean
- excludeFromGLNumbering Exclude from GL Audit Numbering: boolean
- externalId External ID: string
- fob FOB: string
- id Internal ID: string
- item: revenueCommitment-itemCollection
- job: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- lastModifiedDate Date Last Modified: string (date-time)
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
- nexus: nexus
- oppcreatedfrom: string
- oppcreatedfromtitle: string
- opportunity: opportunity
- originator Originator: string
- otherRefNum PO/Check Number: string
-
The value for this field is derived from the sales order.
- partner: partner
- partners: revenueCommitment-partnersCollection
- postingPeriod: accountingPeriod
- prevDate Previous Effective Date: string (date)
- prevPartner Previous Partner: integer (int64)
- prevRep Previous Representative: integer (int64)
- previousOpportunity Previous Opportunity: string
- recognizedRevenue Recognized Revenue: number (double)
-
The cumulative dollar amount of the revenue recognized with either invoices or revenue commitments.
- refName Reference Name: string
- revCommitStatus Revenue Commitment Status: string
- revCommitStatusDescr Revenue Commitment Status: string
- revRecOnRevCommitment Rev Rec on Rev Commit.: boolean
- revenueStatus Revenue Status: string
-
This field can display the following values: * Pending - No revenue recognition has occurred. All revenue remains deferred. * In Progress - Some revenue recognition has occurred. * Completed - All revenue recognition has occurred, leaving no deferred revenue.
- revenueStatusDescr Revenue Status: string
- salesEffectiveDate Sales Effective Date: string (date)
- salesRep: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- salesTeam: revenueCommitment-salesTeamCollection
- shipAddress Ship To: string
- shipAddressList: nsResource
- shipIsResidential Shipping address is residential: boolean
- shipOverride Override: boolean
- shippingAddress: revenueCommitment-shippingAddress
- shippingAddress_text Shipping Address: string
- source: object
-
- startDate Start Date: string (date)
-
The date revenue recognition begins for this revenue commitment. The date is derived from the sales order.
- storeOrder: string
- subsidiary: subsidiary
- subtotal Subtotal: number (double)
- taxTotal Tax: number (double)
- terms: term
- total Total: number (double)
- trackingNumbers Tracking Numbers: string
- tranDate Date: string (date)
- tranId Transaction Number: string
-
If you use auto-generated numbers for revenue commitments, this field is populated automatically when you save. Otherwise, you can enter a number for this revenue commitment here.
- tranIsVsoeBundle Transaction Is VSOE Bundle: boolean
-
Check this box if the items on the transaction are related and bundled together for revenue recognition purposes.
- vsoeAutoCalc Auto Calculate VSOE Allocation: boolean
-
Check this box to calculate the allocation amount for items automatically. Auto-calculated allocation requires the EITF 08-01 Revenue Recognition SuiteApp.
- webSite: string
revenueCommitment-accountingBookDetailCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: revenueCommitment-accountingBookDetailElement
-
revenueCommitment-accountingBookDetailElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
revenueCommitment-accountingBookDetailElement
This record is available as a beta record.
- accountingBook: accountingBook
- exchangeRate Exchange Rate: number (double)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- revRecOnRevCommitment Rev Rec on Rev Commit.: boolean
- subsidiary: subsidiary
- tranIsVsoeBundle Transaction Is VSOE Bundle: boolean
revenueCommitment-billingAddress
This record is available as a beta record.
- addr1 Address 1: string
-
Enter the address the way it should appear on forms. For employees, customers, partners, and vendors, what you enter here autofills on forms if this address is marked default for Shipping or Billing. Enter up to 50 characters. This field is required for the Online Bill Pay feature.
- addr2 Address 2: string
-
Enter an optional second address line the way it should appear on forms. For employees, customers, partners, and vendors, what you enter here autofills on forms if this address is marked default for Shipping or Billing. Enter up to 50 characters.
- addr3 Address 3: string
- addrPhone Phone: string
-
Enter the phone number.
- addrText Address: string
-
The values entered in the other address fields are displayed here.
- addressee Addressee: string
-
Enter the name of the entity that should appear on the shipping label here. This name appears on the shipping label below what you enter in the Attention field.
- attention Attention: string
-
Enter the name of the person to whom a shipment is addressed, as it should appear on shipping labels. This field is required for UPS Integration.
- city City: string
-
Enter the city the way it should appear on all forms except checks.
- country: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- externalId External ID: string
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - override Override: boolean
-
Check this box to disable the free-form address text field. When this field is disabled, text entered in the other address fields does not display in the Address text field. Clear this box to allow text entered in the address component fields to appear in the free-form address text field.
- refName Reference Name: string
- state State/Province: string
-
Enter your company's state or province the way it should appear on all forms except checks.
- zip Zip: string
-
Enter the postal code the way it should appear on all forms except checks.
revenueCommitment-item-inventoryDetail
This record is available as a beta record.
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- externalId External ID: string
- inventoryassignment: revenueCommitment-item-inventoryDetail-inventoryassignmentCollection
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemDescription Description: string
-
A more complete Description of the item.
- links Links: nsLink
-
nsLink - location: location
- quantity Quantity: number (float)
-
In the Quantity to Build field, enter the number of assembly items you want to build. You cannot enter a quantity that exceeds the amount displayed in the Buildable Quantity field.
- refName Reference Name: string
- toLocation: location
- unit Units: string
-
If the assembly uses Units of Measure, the base units are displayed in the Units field.
revenueCommitment-item-inventoryDetail-inventoryassignmentCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: revenueCommitment-item-inventoryDetail-inventoryassignmentElement
-
revenueCommitment-item-inventoryDetail-inventoryassignmentElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
revenueCommitment-item-inventoryDetail-inventoryassignmentElement
This record is available as a beta record.
- binNumber: bin
- expirationDate Expiration Date: string (date)
- internalId Internal ID: integer (int64)
- inventoryDetail Inventory Detail: integer (int64)
- inventoryStatus: inventoryStatus
- issueInventoryNumber: inventoryNumber
- links Links: nsLink
-
nsLink - packCarton Pack Carton: string
- pickCarton Pick Carton: string
- quantity Quantity: number (float)
- quantityAvailable Unpicked Bin Qty: number (float)
- receiptInventoryNumber Serial/Lot Number: string
- refName Reference Name: string
- secondaryQuantity Secondary Quantity: number (float)
- toBinNumber: bin
- toInventoryStatus: inventoryStatus
revenueCommitment-itemCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: revenueCommitment-itemElement
-
revenueCommitment-itemElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
revenueCommitment-itemElement
This record is available as a beta record.
- amount Amount: number (double)
- billVarianceStatus: object
-
- id Internal identifier.: string NOVARIANCES , JOURNALNOTPOSTED , JOURNALPOSTED
- refName Reference Name: string
- catchUpPeriod: accountingPeriod
- class: classification
- deferRevRec Deferred Revenue: boolean
- department: department
- description Description: string
- giftCertFrom From: string
- giftCertMessage Gift Message: string
- giftCertNumber Code: string
- giftCertRecipientEmail Recipient Email: string
- giftCertRecipientName Recipient Name: string
- initOqpBucket Initial OQP Bucket: string
- inventoryDetail: revenueCommitment-item-inventoryDetail
- isClosed Closed: boolean
- isOpen Is Opened: boolean
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemSubtype: object
-
- id Internal identifier.: string Sale , Purchase , Resale
- refName Reference Name: string
- itemType: object
-
- job: job
- licenseCode License Code: string
- line Transaction Line: integer (int64)
- linked Linked: boolean
- links Links: nsLink
-
nsLink - location: location
- marginal Marginal: boolean
- matrixType Matrix Type: string
- minQty Minimum Quantity: number (float)
- options Options: string
- oqpBucket Oqp Bucket: string
- orderDoc: nsResource
- orderLine Order Line: integer (int64)
- price: priceLevel
- printItems Print Items: boolean
- processedByRevCommit Processed by Rev Commit: boolean
- quantity Quantity: number (float)
- quantityAllocated Quantity Allocated: number (float)
- quantityAvailable Available: number (float)
- quantityCommitted Committed: number (float)
- quantityDemandAllocated Allocated Demand: number (float)
- quantityOnHand On Hand: number (float)
- rate Rate: number (double)
- rateIncludingTax Rate: number (double)
- rateSchedule Rate Schedule: string
- refName Reference Name: string
- revRecEndDate Rev. Rec. End Date: string (date)
- revRecSchedule: revRecSchedule
- revRecStartDate Rev. Rec. Start Date: string (date)
- revrec_recurrencetype Rev Rec Recurrence Type: string
- subsidiary: subsidiary
- units Units: string
- vsoeAllocation Allocation Amount: number (double)
- vsoeAmount Calculated Amount: number (double)
- vsoeDeferral: object
-
- id Internal identifier.: string DEFERALLUNTIL , DEFERUNTIL
- refName Reference Name: string
- vsoeDelivered Delivered: boolean
- vsoeIsEstimate Estimate: boolean
- vsoePermitDiscount: object
-
- id Internal identifier.: string IFDELIVERED , NEVER
- refName Reference Name: string
- vsoePrice Allocation Price: number (double)
- vsoeSOPGroup: object
-
- id Internal identifier.: string EXCLUDE , NORMAL , SOFTWARE
- refName Reference Name: string
revenueCommitment-partnersCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: revenueCommitment-partnersElement
-
revenueCommitment-partnersElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
revenueCommitment-partnersElement
This record is available as a beta record.
- contribution Contribution %: number (double)
- isPrimary Primary: boolean
- links Links: nsLink
-
nsLink - partner: partner
- partnerRole: partnerCategory
- refName Reference Name: string
revenueCommitment-salesTeamCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: revenueCommitment-salesTeamElement
-
revenueCommitment-salesTeamElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
revenueCommitment-shippingAddress
This record is available as a beta record.
- addr1 Address 1: string
-
Enter the address the way it should appear on forms. For employees, customers, partners, and vendors, what you enter here autofills on forms if this address is marked default for Shipping or Billing. Enter up to 50 characters. This field is required for the Online Bill Pay feature.
- addr2 Address 2: string
-
Enter an optional second address line the way it should appear on forms. For employees, customers, partners, and vendors, what you enter here autofills on forms if this address is marked default for Shipping or Billing. Enter up to 50 characters.
- addr3 Address 3: string
- addrPhone Phone: string
-
Enter the phone number.
- addrText Address: string
-
The values entered in the other address fields are displayed here.
- addressee Addressee: string
-
Enter the name of the entity that should appear on the shipping label here. This name appears on the shipping label below what you enter in the Attention field.
- attention Attention: string
-
Enter the name of the person to whom a shipment is addressed, as it should appear on shipping labels. This field is required for UPS Integration.
- city City: string
-
Enter the city the way it should appear on all forms except checks.
- country: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- externalId External ID: string
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - override Override: boolean
-
Check this box to disable the free-form address text field. When this field is disabled, text entered in the other address fields does not display in the Address text field. Clear this box to allow text entered in the address component fields to appear in the free-form address text field.
- refName Reference Name: string
- state State/Province: string
-
Enter your company's state or province the way it should appear on all forms except checks.
- zip Zip: string
-
Enter the postal code the way it should appear on all forms except checks.
revenueCommitmentCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: revenueCommitment
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
revenueCommitment - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
revenueCommitmentReversal
This record is available as a beta record.
- accountingBook: accountingBook
- accountingBookDetail: revenueCommitmentReversal-accountingBookDetailCollection
- billAddr1 Billing Address Line 1: string
- billAddr2 Billing Address Line 2: string
- billAddr3 Billing Address Line 3: string
- billAddress Bill To: string
- billAddressList: nsResource
- billAddressee Billing Addressee: string
- billAttention Billing Attention: string
- billCity Billing Address City: string
- billCountry: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- billOverride Override: string
- billPhone Billing Phone: string
- billState Billing Address State: string
- billZip Billing Address Zip Code: string
- billingAddress: revenueCommitmentReversal-billingAddress
- billingAddress_text Billing Address: string
- class: classification
- contribPct Contribution Percentage: string
- createdDate Date Created: string (date-time)
- createdFrom: nsResource
- currency: currency
- customForm: object
-
- id Internal identifier.: string -9941
- refName Reference Name: string
- deferredRevenue Deferred Revenue: number (double)
- department: department
- discountAmount Discount Amount: number (double)
- discountDate Discount Date: string (date)
- dueDate Due Date: string (date)
- endDate End Date: string (date)
- entity: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- exchangeRate Exchange Rate: number (double)
- excludeCommission Exclude Commissions: boolean
- excludeFromGLNumbering Exclude from GL Audit Numbering: boolean
- externalId External ID: string
- fob FOB: string
- id Internal ID: string
- item: revenueCommitmentReversal-itemCollection
- job: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- lastModifiedDate Date Last Modified: string (date-time)
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
- nexus: nexus
- originator Originator: string
- otherRefNum PO/Check Number: string
- partner: partner
- partners: revenueCommitmentReversal-partnersCollection
- postingPeriod: accountingPeriod
- prevDate Previous Effective Date: string (date)
- prevPartner Previous Partner: integer (int64)
- prevRep Previous Representative: integer (int64)
- recognizedRevenue Recognized Revenue: number (double)
- refName Reference Name: string
- revCommitStatus Revenue Commitment Status: string
- revCommitStatusDescr Revenue Commitment Status: string
- revRecOnRevCommitment Rev Rec on Rev Commit.: boolean
- revenueStatus Revenue Status: string
- revenueStatusDescr Revenue Status: string
- salesEffectiveDate Sales Effective Date: string (date)
- salesRep: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- salesTeam: revenueCommitmentReversal-salesTeamCollection
- shipAddress Ship To: string
- shipAddressList: nsResource
- shipIsResidential Shipping address is residential: boolean
- shipOverride Override: boolean
- shippingAddress: revenueCommitmentReversal-shippingAddress
- shippingAddress_text Shipping Address: string
- source: object
-
- startDate Start Date: string (date)
- storeOrder: string
- subsidiary: subsidiary
- subtotal Subtotal: number (double)
- taxTotal Tax: number (double)
- terms: term
- total Total: number (double)
- trackingNumbers Tracking Numbers: string
- tranDate Date: string (date)
- tranId Transaction Number: string
- tranIsVsoeBundle Transaction Is VSOE Bundle: boolean
- vsoeAutoCalc Auto Calculate VSOE Allocation: boolean
- webSite: string
revenueCommitmentReversal-accountingBookDetailCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: revenueCommitmentReversal-accountingBookDetailElement
-
revenueCommitmentReversal-accountingBookDetailElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
revenueCommitmentReversal-accountingBookDetailElement
This record is available as a beta record.
- accountingBook: accountingBook
- exchangeRate Exchange Rate: number (double)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- revRecOnRevCommitment Rev Rec on Rev Commit.: boolean
- subsidiary: subsidiary
- tranIsVsoeBundle Transaction Is VSOE Bundle: boolean
revenueCommitmentReversal-billingAddress
This record is available as a beta record.
- addr1 Address 1: string
-
Enter the address the way it should appear on forms. For employees, customers, partners, and vendors, what you enter here autofills on forms if this address is marked default for Shipping or Billing. Enter up to 50 characters. This field is required for the Online Bill Pay feature.
- addr2 Address 2: string
-
Enter an optional second address line the way it should appear on forms. For employees, customers, partners, and vendors, what you enter here autofills on forms if this address is marked default for Shipping or Billing. Enter up to 50 characters.
- addr3 Address 3: string
- addrPhone Phone: string
-
Enter the phone number.
- addrText Address: string
-
The values entered in the other address fields are displayed here.
- addressee Addressee: string
-
Enter the name of the entity that should appear on the shipping label here. This name appears on the shipping label below what you enter in the Attention field.
- attention Attention: string
-
Enter the name of the person to whom a shipment is addressed, as it should appear on shipping labels. This field is required for UPS Integration.
- city City: string
-
Enter the city the way it should appear on all forms except checks.
- country: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- externalId External ID: string
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - override Override: boolean
-
Check this box to disable the free-form address text field. When this field is disabled, text entered in the other address fields does not display in the Address text field. Clear this box to allow text entered in the address component fields to appear in the free-form address text field.
- refName Reference Name: string
- state State/Province: string
-
Enter your company's state or province the way it should appear on all forms except checks.
- zip Zip: string
-
Enter the postal code the way it should appear on all forms except checks.
revenueCommitmentReversal-item-inventoryDetail
This record is available as a beta record.
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- externalId External ID: string
- inventoryassignment: revenueCommitmentReversal-item-inventoryDetail-inventoryassignmentCollection
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemDescription Description: string
-
A more complete Description of the item.
- links Links: nsLink
-
nsLink - location: location
- quantity Quantity: number (float)
-
In the Quantity to Build field, enter the number of assembly items you want to build. You cannot enter a quantity that exceeds the amount displayed in the Buildable Quantity field.
- refName Reference Name: string
- toLocation: location
- unit Units: string
-
If the assembly uses Units of Measure, the base units are displayed in the Units field.
revenueCommitmentReversal-item-inventoryDetail-inventoryassignmentCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: revenueCommitmentReversal-item-inventoryDetail-inventoryassignmentElement
-
revenueCommitmentReversal-item-inventoryDetail-inventoryassignmentElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
revenueCommitmentReversal-item-inventoryDetail-inventoryassignmentElement
This record is available as a beta record.
- binNumber: bin
- expirationDate Expiration Date: string (date)
- internalId Internal ID: integer (int64)
- inventoryDetail Inventory Detail: integer (int64)
- inventoryStatus: inventoryStatus
- issueInventoryNumber: inventoryNumber
- links Links: nsLink
-
nsLink - packCarton Pack Carton: string
- pickCarton Pick Carton: string
- quantity Quantity: number (float)
- quantityAvailable Unpicked Bin Qty: number (float)
- receiptInventoryNumber Serial/Lot Number: string
- refName Reference Name: string
- secondaryQuantity Secondary Quantity: number (float)
- toBinNumber: bin
- toInventoryStatus: inventoryStatus
revenueCommitmentReversal-itemCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: revenueCommitmentReversal-itemElement
-
revenueCommitmentReversal-itemElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
revenueCommitmentReversal-itemElement
This record is available as a beta record.
- amount Amount: number (double)
- billVarianceStatus: object
-
- id Internal identifier.: string NOVARIANCES , JOURNALNOTPOSTED , JOURNALPOSTED
- refName Reference Name: string
- catchUpPeriod: accountingPeriod
- class: classification
- deferRevRec Deferred Revenue: boolean
- department: department
- description Description: string
- giftCertFrom From: string
- giftCertMessage Gift Message: string
- giftCertNumber Code: string
- giftCertRecipientEmail Recipient Email: string
- giftCertRecipientName Recipient Name: string
- initOqpBucket Initial OQP Bucket: string
- inventoryDetail: revenueCommitmentReversal-item-inventoryDetail
- isClosed Closed: boolean
- isOpen Is Opened: boolean
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemSubtype: object
-
- id Internal identifier.: string Sale , Purchase , Resale
- refName Reference Name: string
- itemType: object
-
- licenseCode License Code: string
- line Transaction Line: integer (int64)
- linked Linked: boolean
- links Links: nsLink
-
nsLink - location: location
- marginal Marginal: boolean
- matrixType Matrix Type: string
- minQty Minimum Quantity: number (float)
- options Options: string
- oqpBucket Oqp Bucket: string
- orderDoc: nsResource
- orderLine Order Line: integer (int64)
- price: priceLevel
- printItems Print Items: boolean
- processedByRevCommit Processed by Rev Commit: boolean
- quantity Quantity: number (float)
- quantityAllocated Quantity Allocated: number (float)
- quantityAvailable Available: number (float)
- quantityCommitted Committed: number (float)
- quantityDemandAllocated Allocated Demand: number (float)
- quantityOnHand On Hand: number (float)
- rate Rate: number (double)
- rateIncludingTax Rate: number (double)
- rateSchedule Rate Schedule: string
- refName Reference Name: string
- revRecEndDate Rev. Rec. End Date: string (date)
- revRecSchedule: revRecSchedule
- revRecStartDate Rev. Rec. Start Date: string (date)
- revrec_recurrencetype Rev Rec Recurrence Type: string
- subsidiary: subsidiary
- units Units: string
- vsoeAllocation Allocation Amount: number (double)
- vsoeAmount Calculated Amount: number (double)
- vsoeDeferral: object
-
- id Internal identifier.: string DEFERALLUNTIL , DEFERUNTIL
- refName Reference Name: string
- vsoeDelivered Delivered: boolean
- vsoeIsEstimate Estimate: boolean
- vsoePermitDiscount: object
-
- id Internal identifier.: string IFDELIVERED , NEVER
- refName Reference Name: string
- vsoePrice Allocation Price: number (double)
- vsoeSOPGroup: object
-
- id Internal identifier.: string EXCLUDE , NORMAL , SOFTWARE
- refName Reference Name: string
revenueCommitmentReversal-partnersCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: revenueCommitmentReversal-partnersElement
-
revenueCommitmentReversal-partnersElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
revenueCommitmentReversal-partnersElement
This record is available as a beta record.
- contribution Contribution %: number (double)
- isPrimary Primary: boolean
- links Links: nsLink
-
nsLink - partner: partner
- partnerRole: partnerCategory
- refName Reference Name: string
revenueCommitmentReversal-salesTeamCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: revenueCommitmentReversal-salesTeamElement
-
revenueCommitmentReversal-salesTeamElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
revenueCommitmentReversal-shippingAddress
This record is available as a beta record.
- addr1 Address 1: string
-
Enter the address the way it should appear on forms. For employees, customers, partners, and vendors, what you enter here autofills on forms if this address is marked default for Shipping or Billing. Enter up to 50 characters. This field is required for the Online Bill Pay feature.
- addr2 Address 2: string
-
Enter an optional second address line the way it should appear on forms. For employees, customers, partners, and vendors, what you enter here autofills on forms if this address is marked default for Shipping or Billing. Enter up to 50 characters.
- addr3 Address 3: string
- addrPhone Phone: string
-
Enter the phone number.
- addrText Address: string
-
The values entered in the other address fields are displayed here.
- addressee Addressee: string
-
Enter the name of the entity that should appear on the shipping label here. This name appears on the shipping label below what you enter in the Attention field.
- attention Attention: string
-
Enter the name of the person to whom a shipment is addressed, as it should appear on shipping labels. This field is required for UPS Integration.
- city City: string
-
Enter the city the way it should appear on all forms except checks.
- country: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- externalId External ID: string
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - override Override: boolean
-
Check this box to disable the free-form address text field. When this field is disabled, text entered in the other address fields does not display in the Address text field. Clear this box to allow text entered in the address component fields to appear in the free-form address text field.
- refName Reference Name: string
- state State/Province: string
-
Enter your company's state or province the way it should appear on all forms except checks.
- zip Zip: string
-
Enter the postal code the way it should appear on all forms except checks.
revenueCommitmentReversalCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: revenueCommitmentReversal
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
revenueCommitmentReversal - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
revenuePlan
This record is available as a beta record.
- accountingBook: accountingBook
- allocatedcontractcostamount Allocated Contract Acquisition Cost Amount (Base Currency): number (double)
-
This is the allocated contract acquisition cost amount from the revenue element.
- amount Amount: number (double)
-
This is the total revenue amount included in this revenue recognition plan.
- amountSource: object
-
- id Internal identifier.: string EVENT_AMOUNT , EVENT_PCT_COMPLETE , TRANSACTION_LINE_AMOUNT , EVENT_PCT_BASED_ON_AMOUNT , EVENT_PCT_BASED_ON_QUANTITY
- refName Reference Name: string
- amountSourceKey: string
- catchupPeriod: accountingPeriod
- comments Comments: string
-
Include brief comments about the revenue plan here.
- createPlansOnType: string (date)
- createdFrom: nsResource
- creationTriggeredBy: object
-
- id Internal identifier.: string
- refName Reference Name: string
- creationTriggeredByDisplay: object
-
- id Internal identifier.: string
- refName Reference Name: string
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- defaultCatchup: string
- endDateChangeImpact: object
-
- id Internal identifier.: string UPDATE_ALL_PERIODS , UPDATE_REMAINING_PERIODS_ONLY
- refName Reference Name: string
- endDateChangeImpactForDisplay: object
-
- id Internal identifier.: string UPDATE_ALL_PERIODS , UPDATE_REMAINING_PERIODS_ONLY
- refName Reference Name: string
- exchangeRate Plan Exchange Rate: number (double)
-
This is the exchange rate between the source currency (the Parent Line Currency) and the base currency (the Revenue Recognition Plan Currency). This exchange rate may not be the same as the exchange rate on the linked revenue element if the revenue element has participated in a merge.
- externalId External ID: string
- holdRevenueRecognition Hold Revenue Recognition: boolean
-
Check this box to place the revenue plan on hold. When you check the box, the status changes to On Hold. When a plan is on hold, revenue recognition journal entries cannot be generated for any period in the plan. Clear the box to resume recognizing revenue. Revenue that was not recognized while the plan was on hold is recognized in the catch up period.
- id Internal ID: string
- initialAmount Initial Amount: number (double)
-
The value of this field is copied from the revenue recognition rule. It is a percentage or fixed amount to be recognized in the first recognition period.
- isEliminate Eliminate: boolean
-
If this box is checked, the source of the revenue element for the plan is an intercompany transaction.
- isPercentComplete: boolean
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemlaborcostamount Item Labor Cost Amount (Base Currency): number (double)
-
This is the item labor cost amount from the revenue element.
- itemresalecostamount Item Resale Cost Amount (Base Currency): number (double)
-
This is the item resale cost amount from the revenue element.
- links Links: nsLink
-
nsLink - parentLineCurrency Parent Line Currency: string
-
This is the currency from the source customer obligation document.
- periodOffset Period Offset: integer (int64)
-
The value of this field is copied from the revenue recognition rule. It is the number of periods that the start of recognition is postponed from the date derived from the rev rec start date source. When there is a period offset, the recognition period has been moved into the future by the number of periods specified.
- planHasStarted: string (date)
- plannedExpense: revenuePlan-plannedExpenseCollection
- plannedRevenue: revenuePlan-plannedRevenueCollection
- plannedRevenueVersion: revenuePlan-plannedRevenueVersionCollection
- recalcAdjustPeriodOffset Recalculation Adjustment Period Offset: integer (int64)
-
You can edit this field only when the Reforecast Method is Manual. Then this field is required, and the value must be positive.
- recognitionMethod: object
-
- id Internal identifier.: string DATESPRORATE , EVENPERIODSPRORATE , CUSTOM , DATESINTOPERIODS , EVENPRORATEPERIOD
- refName Reference Name: string
- recognitionMethodKey: string
- recognitionPeriod Recognition Period: integer (int64)
-
This field has a value only when the Rev Rec End Date Source is Recognition Period. It is the number of periods included in the revenue recognition plan. An initial partial period is included in the period count if applicable.
- recordNumber Number: string
-
Revenue plans are identified by number rather than name. The revenue plan number is configured on the Other subtab of the Set Up Auto-Generated Numbers page.
- refName Reference Name: string
- reforecastMethod: object
-
- id Internal identifier.: string NEXT_PERIOD , REMAINING_PERIODS , LAST_PERIOD , MANUAL
- refName Reference Name: string
- remainingDeferredBalance Remaining Deferred Balance: number (double)
-
This is the value from the Amount field minus the value of the Total Recognized field as of the current date.
- remainingdeferredcostbalance Remaining Deferred Cost Balance: number (double)
-
This is the sum of the three cost amount fields minus the value of the Total Amortized field as of the current date.
- revRecEndDate End Date: string (date)
-
When you change the end date, the plan is adjusted according to the value set in the End Date Change Impact field.
- revRecEndDateSource: object
-
- id Internal identifier.: string RECOGNITION_PERIOD , SOURCE_DATE , EVENT_DATE , ARRANGEMENT_TRANSACTION_DATE , REVENUE_ELEMENT_END_DATE , REV_TERM_IN_DAYS , REV_TERM_IN_MONTHS
- refName Reference Name: string
- revRecStartDate Start Date: string (date)
-
When you change this date, the end date does not change automatically to match the number of months or periods in the revenue recognition rule. Instead, the amounts for the planned periods are adjusted. You can change the start date only if no revenue has been recognized.
- revRecStartDateSource: object
-
- id Internal identifier.: string SOURCE_DATE , EVENT_DATE , REVENUE_ELEMENT_START_DATE , ARRANGEMENT_TRANSACTION_DATE
- refName Reference Name: string
- revenueElement None: string
- revenuePlanCurrency Revenue Plan Currency: string
-
This is the same as the subsidiary base currency. When multi-book accounting is enabled, it is the base currency for the accounting book and subsidiary.
- revenuePlanType: object
-
- id Internal identifier.: string FORECAST , ACTUAL
- refName Reference Name: string
- revenueRecognitionRule: nsResource
- revenueScheduleKey None: string
- startOffset Start Offset: integer (int64)
-
The value of this field is copied from the revenue recognition rule. It is the number of periods that the start of recognition is postponed from the date derived from the rev rec start date source. When there is a start offset, only the start date has been moved into the future. The end date may be the same as that derived from the rev rec end date source. The number of periods was adjusted as needed.
- status: object
-
- id Internal identifier.: string COMPLETED , ONHOLD , NOTSTARTED , PLANFAILED , INPROGRESS
- refName Reference Name: string
- statusForDisplay: object
-
- id Internal identifier.: string COMPLETED , ONHOLD , NOTSTARTED , PLANFAILED , INPROGRESS
- refName Reference Name: string
- termInDays Revenue Term In Days: integer (int64)
-
This field has a value only when the Rev Rec End Date Source is Rev Term in Days. Its value is derived from the revenue recognition rule.
- termInMonths Revenue Term In Months: integer (int64)
-
This field has a value only when the Rev Rec End Date Source is Rev Term in Months. It is the number of months included in the revenue recognition plan. If the start date is in the middle of the month, the end date is also mid-month. As a result, the revenue recognition plan may span more periods than the month count.
- totalRecognized Total Recognized: number (double)
-
This is the total revenue that has been recognized on the revenue plan as of the current date.
- totalamortized Total Amortized: number (double)
-
This is the total deferred cost that has been amortized on the expense amortization plan as of the current date.
revenuePlan-plannedExpenseCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: revenuePlan-plannedExpenseElement
-
revenuePlan-plannedExpenseElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
revenuePlan-plannedExpenseElement
This record is available as a beta record.
- amount Amount: number (double)
- dateExecuted Date Executed: string (date)
- deferredRevenueAccount: account
- exchangeRate Line Exchange Rate: number (double)
- isRecognized Is Amortized: boolean
- journal: nsResource
- links Links: nsLink
-
nsLink - percentRecognizedInPeriod % Amortized in Period: number (double)
- percentTotalRecognized % Total Amortized: number (double)
- periodComments Period Comments: string
- plannedPeriod: accountingPeriod
- plannedRevenue: nsResource
- plannedRevenueType: object
-
- id Internal identifier.: string REV_REC , LABOR_COST , CONTRACT_COST , EXPENSE , ITEM_RESALE_COST
- refName Reference Name: string
- postingPeriod: accountingPeriod
- recognitionAccount: account
- refName Reference Name: string
- totalRecognized Total Amortized: number (double)
revenuePlan-plannedRevenueCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: revenuePlan-plannedRevenueElement
-
revenuePlan-plannedRevenueElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
revenuePlan-plannedRevenueElement
This record is available as a beta record.
- amount Amount: number (double)
- dateExecuted Date Executed: string (date)
- deferredRevenueAccount: account
- exchangeRate Line Exchange Rate: number (double)
- isRecognized Is Recognized: boolean
- journal: nsResource
- links Links: nsLink
-
nsLink - percentRecognizedInPeriod % Recognized in Period: number (double)
- percentTotalRecognized % Total Recognized: number (double)
- periodComments Period Comments: string
- plannedPeriod: accountingPeriod
- plannedRevenue: nsResource
- plannedRevenueType: object
-
- id Internal identifier.: string REV_REC , LABOR_COST , CONTRACT_COST , EXPENSE , ITEM_RESALE_COST
- refName Reference Name: string
- postingPeriod: accountingPeriod
- recognitionAccount: account
- refName Reference Name: string
- totalRecognized Total Recognized: number (double)
revenuePlan-plannedRevenueVersionCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: revenuePlan-plannedRevenueVersionElement
-
revenuePlan-plannedRevenueVersionElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
revenuePlan-plannedRevenueVersionElement
This record is available as a beta record.
- amount Amount: number (double)
- createdBy: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- dateChanged Date Changed: string (date-time)
- deferralAccount: account
- id Internal ID: integer (int64)
- journal: nsResource
- links Links: nsLink
-
nsLink - periodComments Period Comments: string
- plannedPeriod: accountingPeriod
- postingPeriod: accountingPeriod
- recognitionAccount: account
- refName Reference Name: string
- version Version: integer (int64)
revenuePlanCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: revenuePlan
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
revenuePlan - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
salesChannel
This record is available as a beta record.
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- description Description: string
- externalId External ID: string
- id Internal ID: string
- isInactive Inactive: boolean
- links Links: nsLink
-
nsLink - name Name: string
- onlyUseReservationAsSupply Can only use dedicated order reservations as supply: boolean
- orderPriority Order Priority: number (float)
- refName Reference Name: string
salesChannelCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: salesChannel
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
salesChannel - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
salesOrder
- accountingBookDetail: salesOrder-accountingBookDetailCollection
- alaConfiguration: nsResource
- altHandlingCost Handling Cost: number (double)
-
The handling cost automatically calculates depending on the shipping method you select in the Ship Via field. To change the cost of handling, go to Lists > Shipping Items and select the shipping method with the handling cost you want to change.
- altSalesTotal Alt. Sales Total: number (double)
-
The alternate sales amount total is shown here.
- altShippingCost Shipping Cost: number (double)
-
The shipping cost automatically calculates depending on the shipping method you select in the Ship Via field above. To change the cost of a shipping method, go to Lists > Shipping Items and select the shipping method you want to change. If you use UPS Real-Time rates, shipments over 150lbs are broken up into shipments less than or equal to 150lbs for charging.
- amountAuthorized Amount Authorized: number (double)
- amountCovered Amount Covered: number (double)
- amountDeposited Amount Deposited: number (double)
- amountNotCovered Amount Not Covered: number (double)
- amountPendingAuthorization Amount Pending Authorization: number (double)
- amountPendingDeposit Amount Pending Deposit: number (double)
- amountPotentiallyCovered Amount Potentially Covered: number (double)
- amountRequiringCoverage Amount Requiring Coverage: number (double)
- appliedRules: salesOrder-appliedRulesCollection
- billAddr1 Billing Address Line 1: string
- billAddr2 Billing Address Line 2: string
- billAddr3 Billing Address Line 3: string
- billAddress Bill To: string
-
The default billing address autofills this field from the customer's record. To enter a different address: * Select another address in the Bill To Select field. * Select New in the Bill To Select field to enter a new billing address to be used for this transaction and saved with the associated entity record. * Select Custom in the Bill To Select field to enter a new billing address to be used for this transaction only (and not saved with the associated entity record). * Click the Edit icon for the Bill To Select field to modify an existing billing address.
- billAddressList: nsResource
- billAddressee Billing Addressee: string
- billAttention Billing Attention: string
- billCity Billing Address City: string
- billCountry: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- billOverride Override: string
- billPhone Billing Phone: string
- billState Billing Address State: string
- billZip Billing Address Zip Code: string
- billingAddress: salesOrder-billingAddress
- billingAddress_text Billing Address: string
- billingSchedule: billingSchedule
- canBeUnapproved Can Be Unapproved: boolean
- cardSwipe Card Swipe: string
- cardholderAuthentication: cardholderAuthentication
- checkNumber Check #: string
- class: classification
- contribPct Contribution Percentage: string
- createdDate Date Created: string (date-time)
- createdFrom: nsResource
- currency: currency
- customForm: object
-
- id Internal identifier.: string -9914 , -9932 , -9911 , -9912
- refName Reference Name: string
- customerPaymentAuthorization: customerPaymentAuthorization
- debitKsn Debit KSN: string
- debitPinBlock Debit Pin Block: string
- defaultILBAShipAddrVal: string
- defaultILBAShippingAddressKey: string
- defaultILShipMethKey Default Shipping Method Key: integer (int64)
- deferredRevenue Deferred Revenue: number (double)
-
Deferred Revenue: amount of revenue deferred on this transaction
- department: department
- discountAmount Discount Amount: number (double)
- discountDate Discount Date: string (date)
- drAccount: account
- dueDate Due Date: string (date)
- dynamicDescriptor Soft Descriptor: string
- email Email: string
- endDate End Date: string (date)
-
If this order has an end date, enter or pick it here. If a sales order includes a Start Date and End Date, those dates autofill on the invoice or cash sale when the order is billed.
- entity: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- entityTaxRegNum Customer Tax Reg. Number: string
-
Select the customer's tax registration number associated with this sales order.
- estGrossProfit Est. Gross Profit: number (double)
-
Estimated Gross Profit: Read-only field that equals the revenue amount minus the Est. Cost. At the transaction level, it equals the gross profit of all lines, factoring transaction-level discounts and markups.
- estGrossProfitPercent Est. Gross Profit Percent: number (double)
-
Estimated Gross Profit Margin, as a percentage: Read-only field that equals the Est. Gross Profit divided by revenue, expressed as a percentage. At the transaction level, it equals the gross profit percent of all lines, factoring transaction-level discounts and markups.
- estimate Estimate: integer (int64)
- exchangeRate Exchange Rate: number (double)
-
The currency's exchange rate is shown in this field. You can edit the exchange rate for this transaction only, or you can update the currency record with the exchange rate you enter here.
- excludeCommission Exclude Commissions: boolean
-
Check this option to exclude this transaction and its subordinate transactions from inclusion in all commission calculations.
- externalId External ID: string
- fob FOB: string
-
Enter the location where the customers technically acquire ownership. For example, if your customers own goods as soon as they ship and pay the shipping costs from your location to theirs, you might enter Our warehouse.
- forInvoiceGrouping For Invoice Grouping: boolean
- fxAccount: account
- giftCertApplied Gift Certificate: number (double)
- giftCertRedemption: salesOrder-giftCertRedemptionCollection
- groupedTo: nsResource
- handlingCost Handling Cost: number (double)
-
The handling costs displayed in this field are calculated by applying the values pre-defined in the selected Shipping Method. For example you may have a flat rate handling charge for all items sent by US Mail of $1.50. To change handling rates, go to Shipping > Lists > Shipping Items, and select the required shipping method. Click on the Handling Rate subtab.
- handlingMode: object
-
- id Internal identifier.: string MIMIC , PROCESS , SAVE_ONLY
- refName Reference Name: string
- handlingTaxAmount Handling Tax Amount: number (double)
-
This field displays the handling tax amount for this sales order.
- id Internal ID: string
- inputReferenceCode Input P/N Ref.: string
- integrationId: string
- intercoStatus: object
-
- id Internal identifier.: string 1 , 2 , 3
- refName Reference Name: string
- intercoTransaction: nsResource
- isCrossSubTransaction Allow Cross-Subsidiary Fulfillment: boolean
- isDefaultShippingRequest Is Default Shipping Request: boolean
- isMultiShipTo Enable Item Line Shipping: boolean
-
Check this box to enter multiple shipping routes on this order. In the Ship To field, select a shipping address for the customer. The Default Billing address, from the customer record, is automatically displayed in the field. You can add a New address which is saved to the customer record, or enter a Custom address, which only stays on the transaction, and is not saved to the customer record. In the Ship Via field, select the shipping method you want to use for that address.
- item: salesOrder-itemCollection
- job: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- lastModifiedDate Date Last Modified: string (date-time)
- leadSource: nsResource
- linkedTrackingNumbers Linked Tracking Numbers: string
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
-
If you wish, enter a memo to describe this sales order. It will appear on reports such as the 2-line Sales Orders register.
- message Customer Message: string
-
The text of the customer message you select in the Select Message field appears here. You can edit the message or enter a new customer message for only this transaction.
- messageSel: customerMessage
- needsPick Needs Pick: boolean
- needsRevCommitment: boolean
- nextBill Next Bill Date: string (date)
- nexus: nexus
- oneTime One Time: number (double)
- oppcreatedfrom: string
- oppcreatedfromtitle: string
- opportunity: opportunity
- ordRevCommitted: boolean
- orderStatus: object
-
- id Internal identifier.: string A , B
- refName Reference Name: string
- orderType: nsResource
- originator Originator: string
- otherRefNum PO/Check Number: string
-
If your customer is paying by check, enter the number here. If your customer is issuing a purchase order, enter the PO number here.
- outputAuthCode Auth. Code: string
- outputReferenceCode P/N Ref.: string
- overrideShippingCost Override Shipping Cost: number (float)
- partner: partner
- partners: salesOrder-partnersCollection
- paymentCardCsc CSC: string
- paymentDeviceId Payment Device ID: string
- paymentInstrumentLimit Payment Instrument Limit: number (double)
- paymentOperation: object
-
- id Internal identifier.: string SALE , VOID , AUTHORIZATION
- refName Reference Name: string
- paymentOption: nsResource
- paymentProcessingProfile: nsResource
- paymentsDue Payments Due: number (double)
- prevDate Previous Effective Date: string (date)
- prevPartner Previous Partner: integer (int64)
- prevRep Previous Representative: integer (int64)
- previousOpportunity Previous Opportunity: string
- recognizedRevenue Recognized Revenue: number (double)
-
Recognized Revenue: cumulative amount of revenue recognized for this transaction
- recurAnnually Annually: number (double)
- recurMonthly Monthly: number (double)
- recurQuarterly Quarterly: number (double)
- recurWeekly Weekly: number (double)
- refName Reference Name: string
- refreshFromSubscription: string
- requiredDepositAmount Required Deposit Amount: number (double)
- requiredDepositDue Required Deposit Due: number (double)
- requiredDepositPercentage Required Deposit Percentage: number (double)
- revCommitStatus Revenue Commitment Status: string
-
This field provides information about Revenue Commitment(s) in the case of a Sales Order or Revenue Commitment Reversal(s) in the case of a Return Authorization. If you uncheck the Rev Rec on Rev Commit. Field, the Rev. Commit. Status field displays information about the related Invoice(s) or Credit Memo(s). The possible values for this field and definitions are as follows: 1. Pending Commitment - No related revenue transactions have been created. 2. Partially Committed - Some related revenue transactions have been created. 3. Committed - All related revenue transactions have been created.
- revCommitStatusDescr Revenue Commitment Status: string
- revRecOnRevCommitment Rev Rec on Rev Commit.: boolean
-
Check this check box to create a Revenue Commitment or Revenue Commitment Reversal. * On a Sales Order, the Revenue Commitment replaces an invoice * On a Return Authorization, the Revenue Commitment Reversal replaces a credit memo. NetSuite creates all applicable Revenue Recognition schedules the Revenue Commitment or Revenue Commitment Reversal.
- revenueStatus Revenue Status: string
-
The possible values for this field are: 1. Pending: indicates that no recognition has occurred. All revenue is still deferred. 2. In Progress: indicates that some recognition has occurred. 3. Completed: indicates that all recognition has occurred. No deferred revenue remains.
- revenueStatusDescr Revenue Status: string
- salesChannel: salesChannel
- salesEffectiveDate Sales Effective Date: string (date)
-
You can change the sales effective date for this transaction. The sales effective date determines which commission plan and historical sales team this transaction applies to.
- salesRep: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- salesTeam: salesOrder-salesTeamCollection
- saleschannelorderpriority: string
- shipAddress Ship To: string
-
The default shipping address autofills this field from the customer's record. To enter a different address: * Select another address in the Ship To Select field. * Select New in the Ship To Select field to enter a new shipping address to be used for this transaction and saved with the associated entity record. * Select Custom in the Ship To Select field to enter a new shipping address to be used for this transaction only (and not saved with the associated entity record). * Click the Edit icon for the Ship To Select field to edit an existing shipping address.
- shipAddressList: nsResource
- shipComplete Ship Complete: boolean
-
Check this box if you want to ship this order only when complete. This will prevent multiple shipments of part-orders. When fulfilling orders in bulk, you can filter the list to include those orders marked Ship Complete that can be completely fulfilled by selecting Respect Ship Complete in the Filter By field.
- shipDate Ship Date: string (date)
-
Type or pick a shipping date for this order.
- shipGroup: salesOrder-shipGroupCollection
- shipIsResidential Shipping address is residential: boolean
- shipMethod: shipItem
- shipOverride Override: boolean
- shippingAddress: salesOrder-shippingAddress
- shippingAddress_text Shipping Address: string
- shippingCost Shipping Cost: number (double)
-
This field displays the shipping costs associated with the transaction. If you have set up your account to automatically calculate shipping, shipping costs are calculated according to the shipping method selected in the Shipping Method field. To automatically charge for shipping, go to Setup > Accounting > Shipping. Check the Charge for Shipping box. In addition, you need to set up charge details for your shipping items. Go to Lists > Accounting > Shipping Items. UPS Real-Time rates If you use this service and a package is over 150lbs, the package is charged as multiple packages equal to or less than 150lbs.
- shippingCostOverridden Shipping Cost Overridden: boolean
- shippingTaxAmount Shipping Tax Amount: number (double)
-
This field displays the shipping tax amount for this sales order.
- source: object
-
- sourceWebSite: webSite
- startDate Start Date: string (date)
-
If you use the Advanced Billing feature, enter the date for the first invoice to be created. If a sales order includes a Start Date and End Date, those dates autofill on the invoice or cash sale when the order is billed.
- status: object
-
- id Internal identifier.: string A , B , C , D , E , F , G , H
- refName Reference Name: string
- storeOrder: string
- subsidiary: subsidiary
- subsidiaryTaxRegNum Subsidiary Tax Reg. Number: string
-
This field shows the tax registration number of the transaction nexus. NetSuite automatically populates this field based on the nexus lookup logic. You can override the transaction nexus and tax registration number that NetSuite automatically selects by checking the Nexus Override box. When you select a different tax registration number in the dropdown list, the corresponding nexus is automatically selected in the Nexus field.
- subtotal Subtotal: number (double)
-
This field shows the total of the items on this sales order. This is the total before any discounts, shipping cost, handling cost or tax is added to the order.
- suppressUserEventsAndEmails: string
- taxDetails: salesOrder-taxDetailsCollection
- taxDetailsOverride Tax Details Override: boolean
-
Check this box to override the tax information on the Tax Details subtab of the transaction. Only roles with at least the Edit level of the Tax Details Tab permission can override the tax details.
- taxPointDate Tax Point Date: string (date)
-
Tax point date is a legal requirement in many countries. It is the date of transaction that determines the taxability. It may be different from the transaction date that determines the GL impact. Specific rules then consider the reporting of transactions based on tax point date and other factors.
- taxPointDateOverride Tax Point Date Override: boolean
-
Check this box to override the tax point date.
- taxRegOverride Tax Registration Override: boolean
-
Check this box to override the values in the Nexus and Subsidiary Tax Reg. Number fields. Only roles with at least the Edit level of the Tax Details Tab permission can override the values that NetSuite automatically selects in these fields.
- taxTotal Tax: number (double)
-
NetSuite multiplies the tax rate by the taxable total of line items and enters it here.
- terms: term
- thirdPartyAcct 3rd Party Account: string
- toBeEmailed To Be Emailed: boolean
-
Check this box if you want to email this sales order. Then enter the email address in the space to the right of the check box. You can enter multiple email addresses by separating them with a semicolon. It is important to separate the addresses with only a semicolon and do not include any spaces.
- toBeFaxed To Be Faxed: boolean
-
Check this box if you want to fax this transaction. Enter the fax number in the space to the right of the check box if it doesn't already appear. To fax NetSuite forms, an administrator must first set up fax service at Setup > Company > Printing, Fax and Email Preferences.
- toBePrinted To Be Printed: boolean
-
Check this box if you want to save this in a queue of sales orders and picking tickets you can later chose to print. On new individual sales orders, you can click Save and Print to submit and print the sales order at once. On existing individual sales orders, you can click Print to submit and print the sales order at once.
- total Total: number (double)
-
NetSuite computes the total of line items, tax and shipping costs, and then enters it here.
- totalAfterTaxes Total After Taxes: number (double)
- totalCostEstimate Est. Cost: number (double)
-
Estimated Cost: Estimated cost of the specific number of items; estimated rate x quantity = estimated cost.
- tranDate Date: string (date)
-
NetSuite inserts today's date for the posting date of this sales order. You can type or pick another date. What you enter here determines the date range in which this transaction appears on the Sales Order Register. You can select or enter custom date ranges on registers.
- tranId Order #: string
-
NetSuite increases the largest sales order number by one. If you wish, you can type another number. The next order number will revert to the standard pattern. Note: The maximum number of characters you can enter in this field is 45.
- tranIsVsoeBundle Transaction Is VSOE Bundle: boolean
-
Check this box to include all items on this transaction as a VSOE bundle. Note: If Rev Rec Dates Specified on Sales Order is the Revenue Recognition Template term source used to allocate revenue, then NetSuite uses the Start and End Dates from the sales order to calculate the Revenue Recognition Schedule.
- transactionToRefund: nsResource
- updateDropshipOrderQty: string
- vsoeAutoCalc Auto Calculate VSOE Allocation: boolean
-
Check this box to automatically calculate allocation amounts when you save the transaction. Allocation determines the revenue amount for individual transaction lines.
- webSite: string
- webStore Web Store: string
salesOrder-accountingBookDetailCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: salesOrder-accountingBookDetailElement
-
salesOrder-accountingBookDetailElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
salesOrder-accountingBookDetailElement
- accountingBook: accountingBook
- exchangeRate Exchange Rate: number (double)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- revRecOnRevCommitment Rev Rec on Rev Commit.: boolean
- subsidiary: subsidiary
- tranIsVsoeBundle Transaction Is VSOE Bundle: boolean
salesOrder-appliedRulesCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: salesOrder-appliedRulesElement
-
salesOrder-appliedRulesElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
salesOrder-billingAddress
- addr1 Address 1: string
-
Enter the address the way it should appear on forms. For employees, customers, partners, and vendors, what you enter here autofills on forms if this address is marked default for Shipping or Billing. Enter up to 50 characters. This field is required for the Online Bill Pay feature.
- addr2 Address 2: string
-
Enter an optional second address line the way it should appear on forms. For employees, customers, partners, and vendors, what you enter here autofills on forms if this address is marked default for Shipping or Billing. Enter up to 50 characters.
- addr3 Address 3: string
- addrPhone Phone: string
-
Enter the phone number.
- addrText Address: string
-
The values entered in the other address fields are displayed here.
- addressee Addressee: string
-
Enter the name of the entity that should appear on the shipping label here. This name appears on the shipping label below what you enter in the Attention field.
- attention Attention: string
-
Enter the name of the person to whom a shipment is addressed, as it should appear on shipping labels. This field is required for UPS Integration.
- city City: string
-
Enter the city the way it should appear on all forms except checks.
- country: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- externalId External ID: string
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - override Override: boolean
-
Check this box to disable the free-form address text field. When this field is disabled, text entered in the other address fields does not display in the Address text field. Clear this box to allow text entered in the address component fields to appear in the free-form address text field.
- refName Reference Name: string
- state State/Province: string
-
Enter your company's state or province the way it should appear on all forms except checks.
- zip Zip: string
-
Enter the postal code the way it should appear on all forms except checks.
salesOrder-giftCertRedemptionCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: salesOrder-giftCertRedemptionElement
-
salesOrder-giftCertRedemptionElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
salesOrder-giftCertRedemptionElement
- authCode: giftCertificate
- authCodeApplied Amount Applied: number (double)
- links Links: nsLink
-
nsLink - refName Reference Name: string
salesOrder-item-inventoryDetail
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- externalId External ID: string
- id Internal ID: string
- inventoryassignment: salesOrder-item-inventoryDetail-inventoryassignmentCollection
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemDescription Description: string
-
A more complete Description of the item.
- links Links: nsLink
-
nsLink - location: location
- quantity Quantity: number (float)
-
In the Quantity to Build field, enter the number of assembly items you want to build. You cannot enter a quantity that exceeds the amount displayed in the Buildable Quantity field.
- refName Reference Name: string
- toLocation: location
- unit Units: string
-
If the assembly uses Units of Measure, the base units are displayed in the Units field.
salesOrder-item-inventoryDetail-inventoryassignmentCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: salesOrder-item-inventoryDetail-inventoryassignmentElement
-
salesOrder-item-inventoryDetail-inventoryassignmentElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
salesOrder-item-inventoryDetail-inventoryassignmentElement
- binNumber: bin
- expirationDate Expiration Date: string (date)
- internalId Internal ID: integer (int64)
- inventoryDetail Inventory Detail: integer (int64)
- inventoryStatus: inventoryStatus
- issueInventoryNumber: inventoryNumber
- links Links: nsLink
-
nsLink - packCarton Pack Carton: string
- pickCarton Pick Carton: string
- quantity Quantity: number (float)
- quantityAvailable Unpicked Bin Qty: number (float)
- receiptInventoryNumber Serial/Lot Number: string
- refName Reference Name: string
- secondaryQuantity Secondary Quantity: number (float)
- toBinNumber: bin
- toInventoryStatus: inventoryStatus
salesOrder-itemCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: salesOrder-itemElement
-
salesOrder-itemElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
salesOrder-itemElement
- allocationAlert Reallocate Order Item: string
- altSalesAmt Alt. Sales Amount: number (double)
- amount Amount: number (double)
- billingSchedule: billingSchedule
- catchUpPeriod: accountingPeriod
- chargeRule: chargeRule
- chargeType: nsResource
- class: classification
- commitInventory: object
-
- id Internal identifier.: string 1 , 2 , 3
- refName Reference Name: string
- commitmentFirm Commitment Confirmed: boolean
- costEstimate Est. Cost: number (double)
- costEstimateRate Est. Rate: number (double)
- costEstimateType: object
-
- id Internal identifier.: string PREFVENDORRATE , AVGCOST , PURCHORDERRATE , LASTPURCHPRICE , MEMBERDEFINED , CUSTOM , ITEMDEFINED , PURCHPRICE
- refName Reference Name: string
- createPo: object
-
- id Internal identifier.: string CostRtrn , EndrTeg , SpecOrd , AuthDep , InTrnPay , POrdBlnk , ResvShip , Capture , GLAdj , OppClose , LandCost , CountAdj , OrdReval , IntcoAdj , CpFxVar , OrdAlloc , FxAsset , GACAdjst , WaveShip , RfqCtrct , POrdPrep , OwnRcpt , Transfrm , DepRfnd , BillVar , OrdBuild , FftRqFt , DepAppl , Payment , Refund , ColTeg , Reimb , OrdDgrss , KitShip , OrdAuth , WipBuild , CtrctOrd , OrdClose , RevRec , OrdRvCom , PickPack , TOrdCost , SysJrnl , Commissn , COGS , SrcContr , OsrcMfg , EstInvc , RfqVend , OrdDep , WOReval , CostRec , PurchOwn , OppEst , POrdReq , OrdBill , ExpRec , NetAsset , PrepAppl , OrdFftRq , BillRcpt , OrdArrng , PurchRet , CostDef , ShipRcpt , SaleRet , DiscTeg , RcptBill , CostDefR , DropShip , WaveOrd , PayTeg
- refName Reference Name: string
- createWo Create WO: boolean
- createdPo: purchaseOrder
- daysLate Days Late: integer (int64)
- deferRevRec Deferred Revenue: boolean
- department: department
- description Description: string
- doNotCreateRevenueElement Do Not Create Revenue Element: boolean
- estGrossProfit Est. Gross Profit: number (double)
- estGrossProfitPercent Est. Gross Profit Percent: number (double)
- excludeFromPredictiveRisk Exclude From Predictive Risk: boolean
- excludeFromRateRequest Exclude Item from Rate Request: boolean
- expectedShipDate Expected Ship Date: string (date)
- fromJob From Project: boolean
- giftCertFrom From: string
- giftCertMessage Gift Message: string
- giftCertNumber Code: string
- giftCertRecipientEmail Recipient Email: string
- giftCertRecipientName Recipient Name: string
- initOqpBucket Initial OQP Bucket: string
- inventoryDetail: salesOrder-item-inventoryDetail
- inventorylocation: location
- inventorysubsidiary: subsidiary
- isCatchWeightItem: boolean
- isClosed Closed: boolean
- isEstimate Estimate: boolean
- isOpen Is Opened: boolean
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemFulfillmentChoice: object
-
- id Internal identifier.: string 1 , 2
- refName Reference Name: string
- itemSubtype: object
-
- id Internal identifier.: string Sale , Purchase , Resale
- refName Reference Name: string
- itemType: object
-
- job: job
- licenseCode License Code: string
- line Transaction Line: integer (int64)
- linked Linked: boolean
- links Links: nsLink
-
nsLink - location: location
- locationAutoAssigned Location Auto Assigned: boolean
- marginal Marginal: boolean
- matrixType Matrix Type: string
- minQty Minimum Quantity: number (float)
- noAutoAssignLocation Do Not Auto Assign Location: boolean
- options Options: string
- oqpBucket Oqp Bucket: string
- orderAllocationStrategy: nsResource
- orderPriority Order Priority: number (float)
- poRate PO Rate: number (double)
- poVendor: vendor
- price: priceLevel
- priceIntervalFrequency: string
- priceIntervalFrequencyName Subscription Frequency: string
- priceIntervalRepeatEvery Subscription Frequency Repeat Every: string
- primaryToSecondaryUnitConversionRate: number (float)
- printItems Print Items: boolean
- processedByRevCommit Processed by Rev Commit: boolean
- quantity Quantity: number (float)
- quantityAllocated Quantity Allocated: number (float)
- quantityAvailable Available: number (float)
- quantityBackOrdered Back Ordered: number (float)
- quantityBilled Invoiced: number (float)
- quantityCommitted Committed: number (float)
- quantityDemandAllocated Allocated Demand: number (float)
- quantityFulfilled <NULL>: number (float)
- quantityOnHand On Hand: number (float)
- quantityPacked Quantity Packed: number (float)
- quantityReceived <NULL>: number (float)
- rate Rate: number (double)
- rateIncludingTax Rate: number (double)
- rateSchedule Rate Schedule: string
- refName Reference Name: string
- requestedDate Requested Date: string (date)
- requiredDepositAmount Required Deposit Amount: number (double)
- revRecEndDate Rev. Rec. End Date: string (date)
- revRecSchedule: revRecSchedule
- revRecStartDate Rev. Rec. Start Date: string (date)
- revrec_recurrencetype Rev Rec Recurrence Type: string
- secondaryQuantity Secondary Quantity: number (float)
- secondaryUnitConversionRate: number (float)
- secondaryUnits Secondary Units: string
- secondaryUnitsList: string
- shipAddress: nsResource
- shipCarrier: object
-
- id Internal identifier.: string ups , nonups
- refName Reference Name: string
- shipMethod: shipItem
- subscription: subscription
- subscriptionLine: subscriptionLine
- subscriptionLinePeriodAmount Subscription Amount Per Period: number (double)
- subscriptionLineRate Subscription Rate: number (double)
- subscriptionLineType: string
- subsidiary: subsidiary
- taxAmount Tax Amount: number (double)
- taxDetailsReference Tax Details Reference: string
- units Units: string
- vendorList Vendor LIST: string
- vsoeAllocation Allocation Amount: number (double)
- vsoeAmount Calculated Amount: number (double)
- vsoeDeferral: object
-
- id Internal identifier.: string DEFERALLUNTIL , DEFERUNTIL
- refName Reference Name: string
- vsoeDelivered Delivered: boolean
- vsoeIsEstimate Estimate: boolean
- vsoePermitDiscount: object
-
- id Internal identifier.: string IFDELIVERED , NEVER
- refName Reference Name: string
- vsoePrice Allocation Price: number (double)
- vsoeSOPGroup: object
-
- id Internal identifier.: string EXCLUDE , NORMAL , SOFTWARE
- refName Reference Name: string
- woId Work Order ID: string
salesOrder-partnersCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: salesOrder-partnersElement
-
salesOrder-partnersElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
salesOrder-partnersElement
- contribution Contribution %: number (double)
- isPrimary Primary: boolean
- links Links: nsLink
-
nsLink - partner: partner
- partnerRole: partnerCategory
- refName Reference Name: string
salesOrder-salesTeamCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: salesOrder-salesTeamElement
-
salesOrder-salesTeamElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
salesOrder-shipGroupCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: salesOrder-shipGroupElement
-
salesOrder-shipGroupElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
salesOrder-shipGroupElement
- destinationAddress Ship To: string
- handlingRate Handling Rate: number (double)
- id ID: integer (int64)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- shippingMethod Ship Via: string
- shippingRate Shipping Rate: number (double)
- sourceAddress Ship From: string
- uniqueKey Unique Key: integer (int64)
- weight Weight: number (float)
salesOrder-shippingAddress
- addr1 Address 1: string
-
Enter the address the way it should appear on forms. For employees, customers, partners, and vendors, what you enter here autofills on forms if this address is marked default for Shipping or Billing. Enter up to 50 characters. This field is required for the Online Bill Pay feature.
- addr2 Address 2: string
-
Enter an optional second address line the way it should appear on forms. For employees, customers, partners, and vendors, what you enter here autofills on forms if this address is marked default for Shipping or Billing. Enter up to 50 characters.
- addr3 Address 3: string
- addrPhone Phone: string
-
Enter the phone number.
- addrText Address: string
-
The values entered in the other address fields are displayed here.
- addressee Addressee: string
-
Enter the name of the entity that should appear on the shipping label here. This name appears on the shipping label below what you enter in the Attention field.
- attention Attention: string
-
Enter the name of the person to whom a shipment is addressed, as it should appear on shipping labels. This field is required for UPS Integration.
- city City: string
-
Enter the city the way it should appear on all forms except checks.
- country: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- externalId External ID: string
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - override Override: boolean
-
Check this box to disable the free-form address text field. When this field is disabled, text entered in the other address fields does not display in the Address text field. Clear this box to allow text entered in the address component fields to appear in the free-form address text field.
- refName Reference Name: string
- state State/Province: string
-
Enter your company's state or province the way it should appear on all forms except checks.
- zip Zip: string
-
Enter the postal code the way it should appear on all forms except checks.
salesOrder-taxDetailsCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: salesOrder-taxDetailsElement
-
salesOrder-taxDetailsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
salesOrder-taxDetailsElement
- calcDetail Details: string
- lineName Name: string
- lineType Line type: string
- links Links: nsLink
-
nsLink - netAmount Net Amount: number (double)
- refName Reference Name: string
- taxAmount Tax Amount: number (double)
- taxBasis Tax Basis: number (double)
- taxCode: salesTaxItem
- taxDetailsReference: object
-
- id Internal identifier.: string
- refName Reference Name: string
- taxRate Tax Rate: number (double)
- taxType Tax Type: string
salesOrderCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: salesOrder
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
salesOrder - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
salesRole
This record is available as a beta record.
- description Description: string
-
Enter a description of this sales role.
- externalId External ID: string
- id Internal ID: string
- isInactive Inactive: boolean
-
Check this box to make this sales role inactive.
- isSalesRep Sales Rep: boolean
-
Check this box if this role is for sales reps. Employees with sales rep sales roles appear on sales reports and KPIs.
- links Links: nsLink
-
nsLink - name Role: string
-
Enter the name of this sales role.
- refName Reference Name: string
salesRoleCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: salesRole
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
salesRole - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
salesTaxItem
This record is available as a beta record.
- acct1 Purchase Tax Account: string
-
When you select a tax type, the tax control account for the selected tax code type appears here.
- acct2 Sales Tax Account: string
-
When you select a tax type, the tax control account for the selected tax code type appears here.
- available: object
-
- id Internal identifier.: string SALE , BOTH , PURCHASE
- refName Reference Name: string
- city City: string
-
Enter the city where this tax should be applied. This value is used by NetSuite to automatically determine the correct tax when an order is entered or a customer places an order on your website.
- county County: string
-
Enter the county where this tax should be applied. This value is used by NetSuite to automatically determine the correct tax when an order is entered or a customer places an order on your website.
- defaultTaxCode Default Tax Code: integer (int64)
- description Description: string
-
Enter a description for this record.
- displayName Display Name/Code: string
-
You can enter a unique name or number for a tax code in addition to the Tax Name. If you are integrating with a Yahoo store, this field is imported from Yahoo.
- ecCode EC Code: boolean
-
Check this box if this tax code is used in transactions with businesses in the European Community. Transactions with EC tax codes appear on the EC Sales List report.
- effectiveFrom Effective From: string (date)
-
Enter the first date this tax code is effective.
- excludeFromTaxReports Exclude from Tax Report: boolean
-
Check this box if you do not want this tax code reflected in tax reports.
- exempt Exempt: boolean
-
Check this box to indicate that whatever this tax code applies to is exempt from tax.
- export Export: boolean
-
Check this box if this tax code is used for transactions involving the exporting of goods.
- externalId External ID: string
- id Internal ID: string
- importantNote Important: Once the tax code record has been saved, you cannot change the value in the Tax Type field.: string
- includeChildren Include Children: boolean
-
Check this box to apply the tax code to the children of the subsidiary that you selected in the Subsidiaries field. In the Subsidiaries field, colons separate parent subsidiaries (on the left) from their children (on the right).
- isDefault Default Code: boolean
-
Check this box if this code is the default tax group selected on transactions. This tax code is selected if the customer's shipping address does not match another tax group.
- isInactive Inactive: boolean
-
Check this box to inactivate this record. Inactive records do not show on transactions and records for selection in lists.
- itemId Name: string
-
Enter a name for this tax code. You select this name on transactions.
- itemType: string
- links Links: nsLink
-
nsLink - local Local Taxes: boolean
-
Check this box if this tax code is used for local taxes.
- moss OSS: boolean
- mossCountry: object
-
- name Name: string
-
Enter a name for this record.
- nexusCountry Country: string
- parent: salesTaxItem
- purchaseAccount: account
- rate Rate: number (double)
-
Enter the appropriate tax rate as a percentage. Example: 8% This percentage will be calculated when you select this tax item on transactions.
- refName Reference Name: string
- remindAboutBAS: boolean
- reverseCharge Reverse Charge Code: boolean
-
Check this box if reverse charge applies to transactions that have this tax type. Tax types with this property can be used on purchase transactions only.
- saleAccount: account
- service Applies To Service Items: boolean
-
Check this box if this tax code is used for the supply or purchase of services.
- state: nsResource
- subsidiary: subsidiaryCollection
- taxAccount: account
- taxAgency: vendor
- taxType: taxType
- validUntil Valid Until: string (date)
-
Select a date from which this tax code is no longer valid. You can leave this field blank to indicate that there is no end to the validity of the tax code.
- zip Zip Codes: string
-
Enter the zip codes where this tax should be applied. Separate each zip code with a comma. This value is used by NetSuite to automatically determine the correct tax when an order is entered or a customer places an order on your website.
salesTaxItemCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: salesTaxItem
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
salesTaxItem - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
servicePurchaseItem
This record is available as a beta record.
- VSOEDeferral: object
-
- id Internal identifier.: string DEFERALLUNTIL , DEFERUNTIL
- refName Reference Name: string
- VSOEDelivered Default as Delivered: boolean
- VSOEPermitDiscount: object
-
- id Internal identifier.: string IFDELIVERED , NEVER
- refName Reference Name: string
- VSOEPrice Allocation Price: number (double)
- VSOESopGroup: object
-
- id Internal identifier.: string EXCLUDE , NORMAL , SOFTWARE
- refName Reference Name: string
- accountingBookDetail: servicePurchaseItem-accountingBookDetailCollection
- amortizationPeriod Amortization Period: integer (int64)
-
Enter the number of periods over which the purchase amount should be amortized. For example, enter 60 to amortize the amount over 60 periods starting from the amortization start date. Note: The starting period is specified by the amortization start date on bills. If no amortization start date is specified, the posting date of the bill is the amortization start date.
- amortizationTemplate: amortizationTemplate
- availableToPartners Available to Adv. Partners: boolean
-
Check this box to make this item available to partners with the Advanced Partner Center role for viewing. These items are also available to partners with roles that are customized for the Advanced Partner Center and include view, create or edit access to item records.
- baseUnit Primary Base Unit: string
- billExchRateVarianceAcct: account
- billPriceVarianceAcct: account
- billQtyVarianceAcct: account
- class: classification
- consumptionUnit Primary Consumption Unit: string
-
If you use the Multiple Units of Measure feature, select the default unit of measure for inventory.
- cost Purchase Price: number (double)
-
Enter the price you pay for this item. If you do not enter a price, purchase orders for this item show the most recent purchase price by default. If you select a preferred vendor for this item, the price is shown in the currency selected on the vendor's record. If no preferred vendor is selected, the price is shown in your base currency.
- costLabel: string
- createExpensePlansOn: nsResource
- createdDate Date Created: string (date-time)
- currency: currency
- customForm: object
-
- id Internal identifier.: string -210 , -10211 , -10210
- refName Reference Name: string
- deferralAccount: account
- department: department
- description Description: string
- displayName Display Name/Code: string
-
Enter an optional name of up to 250 characters for this item in addition to the Item Name. If you are integrating with a Yahoo! store, this field is imported from Yahoo!. The display name prints in the Item column of sales forms when Basic printing is used. If this item is a member of a kit, this name appears in the Item column when the Print Items box is checked. If you do not enter a display name, the item name appears on printed forms.
- exchangeRate: string
- expenseAccount: account
- expenseAmortizationRule: nsResource
- externalId External ID: string
- generateAccruals Generate Accruals: boolean
-
Check this box to automatically generate and post an accrual to the General Ledger.
- hierarchyVersions: servicePurchaseItem-hierarchyVersionsCollection
- id Internal ID: string
- includeChildren Include Children: boolean
-
Check the Include Children box to share the item with all the sub-subsidiaries associated with each subsidiary selected in the Subsidiary field. Note: When sharing items across subsidiaries, all of the options selected on the item record must be compatible across subsidiaries. For example, when entering an inventory item to be shared across subsidiaries, you should select Income and Asset accounts on the item record that are also shared across the same subsidiaries.
- insertItemAttribute: object
-
- id Internal identifier.: string class , department , itemid , location , issueproduct , vendorname
- refName Reference Name: string
- isFulfillable Can be Fulfilled: boolean
-
Check the Can be Fulfilled/Received box to enable this item to be received and fulfilled during order processing. Clear this box if this item does not require being received and fulfilled. Note: Once this item has been added to transactions, this setting cannot be changed. This field is used when the Advanced Billing and Advanced Shipping features are both enabled.
- isInactive Inactive: boolean
-
When you check this box, this item will no longer appear on a list unless you check the Show All box at the bottom of the list page.
- issueProduct: issueProduct
- itemId Item Name/Number: string
-
Enter up to 250 characters for the name of this item. This name appears in lists on transactions. If you have the option of entering a display name and do not, the item name prints in the Item column of sales forms when Basic printing is used. If you have the option to enter a vendor name and do not, the item name prints in the Item column of purchase forms. If you have entered a display name, it will print on purchases instead of the item name when Basic printing is used.
- itemType: object
-
- itemVendor: servicePurchaseItem-itemVendorCollection
- lastModifiedDate Last Modified: string (date-time)
- links Links: nsLink
-
nsLink - location: location
- manufacturingChargeItem Manufacturing Charge Item: boolean
-
Check the Manufacturing Charge Item box to define charges for the activity. For example, you can define the hourly cost of activities being performed and the expense account charges are logged against.
- matrixItemNameTemplate Matrix Item Name Template: string
-
This field is used to control how the matrix item will be displayed in the Matrix Item Name/Number field. Compose the order in which attributes and matrix options are displayed by selecting from the Insert Item Attribute and Insert Matrix Option dropdown lists. Add custom separator characters to easier distinguish the various options. Example: Item Name: Fabric / Color / Waist / Length [Location]
- matrixItemNameTemplateHelp Matrix Item Name Template: string
- matrixType: object
-
- id Internal identifier.: string , PARENT , CHILD
- refName Reference Name: string
- parent: servicePurchaseItem
- parentOnly Use as Category Only: boolean
- projectExpenseType: projectExpenseType
- purchaseDescription Purchase Description: string
-
Enter up to 999 characters of text for a description of this item to appear on vendor orders. Include the unit of measure in this description.
- purchaseOrderAmount Vendor Bill - Purchase Order Amount Tolerance: number (float)
-
Enter the tolerance limit for the discrepancy between the amount on the vendor bill and purchase order.
- purchaseOrderQuantity Vendor Bill - Purchase Order Quantity Tolerance: number (float)
-
Enter the tolerance limit for the discrepancy between the quantity on the vendor bill and purchase order.
- purchaseOrderQuantityDiff Vendor Bill - Purchase Order Quantity Difference: number (float)
-
Enter the difference limit for the discrepancy between the quantity on the vendor bill and purchase order.
- purchaseUnit Primary Purchase Unit: string
-
Select the unit you use to purchase this item from the vendor.
- receiptAmount Vendor Bill - Item Receipt Amount Tolerance: number (float)
-
Enter the tolerance limit for the discrepancy between the amount on the vendor bill and item receipt.
- receiptQuantity Vendor Bill - Item Receipt Quantity Tolerance: number (float)
-
Enter the tolerance limit for the discrepancy between the quantity on the vendor bill and item receipt.
- receiptQuantityDiff Vendor Bill - Item Receipt Quantity Difference: number (float)
-
Enter the difference limit for the discrepancy between the quantity on the vendor bill and item receipt.
- refName Reference Name: string
- residual Residual: number (double)
-
Enter an amount or percentage to remain in the deferral account and not be amortized. A residual amount generally represents the salvage value of a fixed asset. Note: A residual amount entered on a transaction overrides a residual amount entered on an item record.
- subsidiary: subsidiaryCollection
- subtype: object
-
- id Internal identifier.: string Sale , Purchase , Resale
- refName Reference Name: string
- unitsType: unitsType
- upcCode UPC Code: string
-
Enter a maximum of 999 characters in this field to identify an internal name or number to store the item's UPC Code. You can use the text you enter here when adding the item to transactions, searching, or viewing reports. * When you enter text in this field, the SKU/UPC field on item labels displays this UPC Code and prints in UPC bar code format. * When this field is clear, the SKU/UPC field on item labels displays the Item Name/Number and prints in Code-128 bar code format.
- vendor: vendor
- vendorName Vendor Name/Code: string
-
If your vendor uses a name for this item that is different from the name you use, you can enter up to 60 characters as the vendor's name for this item here. The vendor's name for this item prints in the Item column of purchase forms. If you do not enter a vendor name, the item name prints in the Item column of purchase forms. If you have entered a display name, it will print on purchases instead of the item name.
servicePurchaseItem-accountingBookDetailCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: servicePurchaseItem-accountingBookDetailElement
-
servicePurchaseItem-accountingBookDetailElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
servicePurchaseItem-accountingBookDetailElement
This record is available as a beta record.
- accountingBook: accountingBook
- amortizationTemplate: amortizationTemplate
- createExpensePlansOn: nsResource
- createRevenuePlansOn: nsResource
- links Links: nsLink
-
nsLink - refName Reference Name: string
- revRecForecastRule: nsResource
- revRecSchedule: revRecTemplate
- revenueRecognitionRule: nsResource
- sameAsPrimaryAmortization Same as Primary Book Amortization: boolean
- sameAsPrimaryRevRec Same as Primary Book Rev Rec: boolean
servicePurchaseItem-hierarchyVersionsCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: servicePurchaseItem-hierarchyVersionsElement
-
servicePurchaseItem-hierarchyVersionsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
servicePurchaseItem-hierarchyVersionsElement
This record is available as a beta record.
- endDate Hierarchy Version End Date: string (date)
- hierarchyNode: merchandiseHierarchyNode
- hierarchyVersion: merchandiseHierarchyVersion
- isIncluded Included In Version: boolean
- links Links: nsLink
-
nsLink - refName Reference Name: string
- startDate Hierarchy Version Start Date: string (date)
servicePurchaseItem-itemVendor-itemVendorPrice
This record is available as a beta record.
- externalId External ID: string
- itemvendorpricelines: servicePurchaseItem-itemVendor-itemVendorPrice-itemvendorpricelinesCollection
- links Links: nsLink
-
nsLink - refName Reference Name: string
servicePurchaseItem-itemVendor-itemVendorPrice-itemvendorpricelinesCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: servicePurchaseItem-itemVendor-itemVendorPrice-itemvendorpricelinesElement
-
servicePurchaseItem-itemVendor-itemVendorPrice-itemvendorpricelinesElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
servicePurchaseItem-itemVendorCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: servicePurchaseItem-itemVendorElement
-
servicePurchaseItem-itemVendorElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
servicePurchaseItem-itemVendorElement
This record is available as a beta record.
- itemVendorPrice: servicePurchaseItem-itemVendor-itemVendorPrice
- links Links: nsLink
-
nsLink - predConfidence Predicted Risk Confidence: number (double)
- predictedDays Predicted Days Late/Early: integer (int64)
- preferredVendor Preferred: boolean
- purchasePrice Purchase Price: number (double)
- refName Reference Name: string
- schedule: nsResource
- subsidiary: subsidiary
- vendor: vendor
- vendorCode Code: string
- vendorCurrencyName Currency: string
servicePurchaseItemCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: servicePurchaseItem
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
servicePurchaseItem - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
serviceResaleItem
This record is available as a beta record.
- VSOEDeferral: object
-
- id Internal identifier.: string DEFERALLUNTIL , DEFERUNTIL
- refName Reference Name: string
- VSOEDelivered Default as Delivered: boolean
-
Check this box to automatically set this item to a Delivered status when this item is added to a transaction. Clear this box to leave the delivery status clear by default.
- VSOEPermitDiscount: object
-
- id Internal identifier.: string IFDELIVERED , NEVER
- refName Reference Name: string
- VSOEPrice Allocation Price: number (double)
-
Enter the VSOE Price for this item if it is known. Note: If you need to use more than one VSOE price for an item, you can set the most common price here and then change the price on each order manually.
- VSOESopGroup: object
-
- id Internal identifier.: string EXCLUDE , NORMAL , SOFTWARE
- refName Reference Name: string
- accountingBookDetail: serviceResaleItem-accountingBookDetailCollection
- amortizationPeriod Amortization Period: integer (int64)
-
Enter the number of periods over which the purchase amount should be amortized. For example, enter 60 to amortize the amount over 60 periods starting from the amortization start date. Note: The starting period is specified by the amortization start date on bills. If no amortization start date is specified, the posting date of the bill is the amortization start date.
- amortizationTemplate: amortizationTemplate
- autoExpandKitForRevenuemgmt Auto-Expansion for Revenue Management: boolean
- availableToPartners Available to Adv. Partners: boolean
-
Check this box to make this item available to partners with the Advanced Partner Center role for viewing. These items are also available to partners with roles that are customized for the Advanced Partner Center and include view, create or edit access to item records.
- baseUnit Primary Base Unit: string
- billExchRateVarianceAcct: account
- billPriceVarianceAcct: account
- billQtyVarianceAcct: account
- billingRate: serviceResaleItem-billingRate
- billingSchedule: billingSchedule
- class: classification
- consumptionUnit Primary Consumption Unit: string
-
If you use the Multiple Units of Measure feature, select the default unit of measure for inventory.
- contingentRevenueHandling Eligible For Contingent Revenue Handling: boolean
-
Check this box to indicate that the item is subject to contingent revenue handling. When checked, revenue allocation is affected.
- correlatedItems: serviceResaleItem-correlatedItemsCollection
- cost Purchase Price: number (double)
-
Enter the price you pay for this item. If you do not enter a price, purchase orders for this item show the most recent purchase price by default. If you select a preferred vendor for this item, the price is shown in the currency selected on the vendor's record. If no preferred vendor is selected, the price is shown in your base currency.
- costEstimate Item Defined Cost: number (double)
-
Enter an Item Defined Cost amount.
- costEstimateUnits Est. Cost Unit: string
- costLabel: string
- createExpensePlansOn: nsResource
- createJob Create Project: boolean
-
Check this box to make this item eligible to create a job record when it is sold.
- createRevenuePlansOn: nsResource
- createdDate Date Created: string (date-time)
- currency: currency
- customForm: object
-
- id Internal identifier.: string -210 , -10211 , -10210
- refName Reference Name: string
- deferralAccount: account
- deferredRevenueAccount: account
- department: department
- description Description: string
- directRevenuePosting Direct Revenue Posting: boolean
-
Check this box to disable advanced revenue management for this item. When checked, posting transactions that include this item post directly to the item revenue account. No revenue element or revenue arrangement is created. When you check this box, the Deferred Revenue Account on the Accounting subtab is disabled. When you create sales transactions that include items that have this box checked, all the items in the transaction must have the box checked. You cannot mix items that post directly to revenue with items that post to deferred revenue in the same transaction. This restriction also applies to kit items. All items in a kit must post either to revenue or to deferred revenue. You cannot check or clear the box after the item has been used in a transaction with advanced revenue management. By default, this box is not checked.
- displayName Display Name/Code: string
-
Enter an optional name of up to 250 characters for this item in addition to the Item Name. If you are integrating with a Yahoo! store, this field is imported from Yahoo!. The display name prints in the Item column of sales forms when Basic printing is used. If this item is a member of a kit, this name appears in the Item column when the Print Items box is checked. If you do not enter a display name, the item name appears on printed forms.
- dontShowPrice Don't Show Price: boolean
-
Check this box to hide the price of this item online. This is useful for items you want to advertise but don't want to sell or for items that you track inventory for and want to display but are offered in combination with other items.
- enforceminqtyinternally Enforce Minimum Internally: boolean
-
Check this box to apply the minimum quantity restriction on sales orders generated from NetSuite. When you clear this box, but enter a number in the Minimum Quantity field, the minimum quantity is only applied to web store orders.
- exchangeRate: string
- excludeFromSiteMap Exclude from Sitemap: boolean
-
Check this box to exclude a tab, category or item page from the site map.
- expenseAccount: account
- expenseAmortizationRule: nsResource
- externalId External ID: string
- featuredDescription Featured Description: string
-
If this item is displayed on the home page of your Web site, enter a featured description for this item. This description appears below the item's store display name on the Home page of your store or site. You can enter up to 999 characters including basic HTML code. Enter and format text using the formatting options, or click the HTML Source Code link to enter HTML.
- generateAccruals Generate Accruals: boolean
-
Check this box to automatically generate and post an accrual to the General Ledger.
- hierarchyVersions: serviceResaleItem-hierarchyVersionsCollection
- id Internal ID: string
- includeChildren Include Children: boolean
-
Check the Include Children box to share the item with all the sub-subsidiaries associated with each subsidiary selected in the Subsidiary field. Note: When sharing items across subsidiaries, all of the options selected on the item record must be compatible across subsidiaries. For example, when entering an inventory item to be shared across subsidiaries, you should select Income and Asset accounts on the item record that are also shared across the same subsidiaries.
- incomeAccount: account
- insertItemAttribute: object
-
- id Internal identifier.: string class , department , itemid , location , issueproduct , vendorname
- refName Reference Name: string
- interCoDefRevAccount: account
- intercoExpenseAccount: account
- intercoIncomeAccount: account
- internalId Internal ID: integer (int64)
- isFulfillable Can be Fulfilled: boolean
-
Check the Can be Fulfilled/Received box to enable this item to be received and fulfilled during order processing. Clear this box if this item does not require being received and fulfilled. Note: Once this item has been added to transactions, this setting cannot be changed. This field is used when the Advanced Billing and Advanced Shipping features are both enabled.
- isGCoCompliant Google Checkout Compliant: boolean
- isInactive Inactive: boolean
-
When you check this box, this item will no longer appear on a list unless you check the Show All box at the bottom of the list page.
- isOnline Display in Website: boolean
-
Check this box to make this item available online in your Web site. You cannot sell this item online unless you check this box. If the item is of the Other Charge for Sale or Resale subtype, checking this box does not make it available in the web store catalog. However, it becomes available during web store checkout.
- issueProduct: issueProduct
- itemId Item Name/Number: string
-
Enter up to 250 characters for the name of this item. This name appears in lists on transactions. If you have the option of entering a display name and do not, the item name prints in the Item column of sales forms when Basic printing is used. If you have the option to enter a vendor name and do not, the item name prints in the Item column of purchase forms. If you have entered a display name, it will print on purchases instead of the item name when Basic printing is used.
- itemRevenueCategory: nsResource
- itemTaskTemplates: serviceResaleItem-itemTaskTemplatesCollection
- itemType: object
-
- itemVendor: serviceResaleItem-itemVendorCollection
- lastModifiedDate Last Modified: string (date-time)
- links Links: nsLink
-
nsLink - location: location
- manufacturingChargeItem Manufacturing Charge Item: boolean
-
Check the Manufacturing Charge Item box to define charges for the activity. For example, you can define the hourly cost of activities being performed and the expense account charges are logged against.
- matrixItemNameTemplate Matrix Item Name Template: string
-
This field is used to control how the matrix item will be displayed in the Matrix Item Name/Number field. Compose the order in which attributes and matrix options are displayed by selecting from the Insert Item Attribute and Insert Matrix Option dropdown lists. Add custom separator characters to easier distinguish the various options. Example: Item Name: Fabric / Color / Waist / Length [Location]
- matrixItemNameTemplateHelp Matrix Item Name Template: string
- matrixType: object
-
- id Internal identifier.: string , PARENT , CHILD
- refName Reference Name: string
- maximumquantity Maximum Order Qty: integer (int64)
-
Enter the greatest quantity of this item that customers can purchase. If customers enter an item quantity above the maximum amount, a warning message is displayed. Web store customers are unable to complete checkout unless they enter a quantity equal to or below the maximum quantity. Leave this field empty to allow customers to check out without maximum quantity restrictions. You can edit this warning at Setup > Site Builder/SuiteCommerce Advanced > Customize Text.
- metaTagHtml Meta Tag HTML: string
-
Enter the Meta Tag HTML you want to appear in the < head > section of this item page. Meta tags enable your Web site to be found by search engines.
- minimumquantity Minimum Order Qty: integer (int64)
-
Enter the lowest quantity that customers can purchase. Web store customers receive a warning and cannot check out if they enter an item quantity below this minimum. Leave this field empty to allow customers to check out with no minimum quantity restrictions. You can edit this warning at Setup > Site Builder/SuiteCommerce Advanced > Customize Text.
- noPriceMessage No Price Message: string
-
If you opted to not show a price online, enter the message that should show instead of the price. For example, you might enter "Call for Price."
- offerSupport Offer Support: boolean
-
Check this box to offer support for this particular item. By offering support for items, customers can select on case records which item they are having trouble with.
- onSpecial On Special: boolean
-
If you want to put this item on special, check this box. The item then appears in the Specials category in your store or site.
- outOfStockBehavior: object
-
- id Internal identifier.: string DISABLE , ENABLENMSG , REMOVE , ENABLE , DEFAULT
- refName Reference Name: string
- outOfStockMessage Out Of Stock Message: string
-
You can enter a custom out of stock message for this item. The message here replaces the default out of stock message.
- overallQuantityPricingType: object
-
- id Internal identifier.: string ITEM , PARENT , SCHEDULE
- refName Reference Name: string
- pageTitle Page Title: string
-
Enter the text you want to appear as the page's title for this item. This text appears in the browser tab. Use a descriptive title for the item page, this can help achieve better results with search engine ranking.
- parent: serviceResaleItem
- parentOnly Use as Category Only: boolean
- presentationItem: serviceResaleItem-presentationItemCollection
- price: serviceResaleItem-price
- pricesIncludeTax Prices Include Tax: boolean
-
Check this box to save the base price as the tax inclusive price. Clear this box to save the base price as the tax exclusive price.
- pricingGroup: pricingGroup
- projectExpenseType: projectExpenseType
- projectTemplate: projectTemplate
- purchaseDescription Purchase Description: string
-
Enter up to 999 characters of text for a description of this item to appear on vendor orders. Include the unit of measure in this description.
- purchaseOrderAmount Vendor Bill - Purchase Order Amount Tolerance: number (float)
-
Enter the tolerance limit for the discrepancy between the amount on the vendor bill and purchase order.
- purchaseOrderQuantity Vendor Bill - Purchase Order Quantity Tolerance: number (float)
-
Enter the tolerance limit for the discrepancy between the quantity on the vendor bill and purchase order.
- purchaseOrderQuantityDiff Vendor Bill - Purchase Order Quantity Difference: number (float)
-
Enter the difference limit for the discrepancy between the quantity on the vendor bill and purchase order.
- purchaseUnit Primary Purchase Unit: string
-
Select the unit you use to purchase this item from the vendor.
- quantityPricingSchedule: nsResource
- rate Price: number (double)
-
Enter the rate for this discount or markup. The rate can be either a percentage or dollar amount. A percentage discount must be followed by a % sign. A dollar amount should be entered as a positive number.
- rateIncludingTax Price Including Tax: number (double)
- receiptAmount Vendor Bill - Item Receipt Amount Tolerance: number (float)
-
Enter the tolerance limit for the discrepancy between the amount on the vendor bill and item receipt.
- receiptQuantity Vendor Bill - Item Receipt Quantity Tolerance: number (float)
-
Enter the tolerance limit for the discrepancy between the quantity on the vendor bill and item receipt.
- receiptQuantityDiff Vendor Bill - Item Receipt Quantity Difference: number (float)
-
Enter the difference limit for the discrepancy between the quantity on the vendor bill and item receipt.
- refName Reference Name: string
- residual Residual: number (double)
-
Enter an amount or percentage to remain in the deferral account and not be amortized. A residual amount generally represents the salvage value of a fixed asset. Note: A residual amount entered on a transaction overrides a residual amount entered on an item record.
- revRecForecastRule: nsResource
- revReclassFxAccount: account
- revenueAllocationGroup: nsResource
- revenueRecognitionRule: nsResource
- saleUnit Primary Sale Unit: string
-
Select the unit you use to sell this item to customers on sales transactions.
- salesDescription Sales Description: string
-
Enter a sales description for this item. You can enter letters and numbers. There is a 999 character limit. The sales description displays on transactions such as sales orders, cash sales and invoices. If you use the Web Store feature, the sales description displays immediately under the item's store display name on item list pages in your store or site, if you have not entered a store description for an item. Enter the store description on the Store subtab of the item record. The sales description also displays by default when the item is in the Web store shopping cart.
- searchKeywords Search Keywords: string
-
Enter alternative search keywords that customers might use to find this item using your Web store’s internal search. These can include synonyms, acronyms, alternate languages or misspellings. These keywords are seen as equally important as the item name when searches are conducted.
- siteCategory: serviceResaleItem-siteCategoryCollection
- siteMapPriority: object
-
- storeDescription Store Description: string
-
The store description appears under the item's store display name on item list pages in your store or site. You can enter letters, numbers, and basic HTML code. Note: To make the store description display when an item is in the Web store shopping cart, go to Setup > Web Site > Set Up Web Site. Click the Cart subtab, and check the box next to Store Description.
- storeDetailedDescription Detailed Description: string
-
Enter a detailed description for this item. When your customers click an item's store display name for more information, they see this description. You can enter letters, numbers or basic HTML code. If you are using Internet Explorer, you can also clear the View Source box below to enter and format text using the formatting options above. This eliminates the need for HTML code. If you do not see the View Source box, make sure Rich Text Editing is enabled at Home > Set Preferences > Appearance.
- storeDisplayImage: nsResource
- storeDisplayName Store Display Name: string
-
Enter the name of this item as you want it displayed in your Web site. You can enter up to 250 characters.
- storeDisplayThumbnail: nsResource
- subsidiary: subsidiaryCollection
- subtype: object
-
- id Internal identifier.: string Sale , Purchase , Resale
- refName Reference Name: string
- unitsType: unitsType
- upcCode UPC Code: string
-
Enter a maximum of 999 characters in this field to identify an internal name or number to store the item's UPC Code. You can use the text you enter here when adding the item to transactions, searching, or viewing reports. * When you enter text in this field, the SKU/UPC field on item labels displays this UPC Code and prints in UPC bar code format. * When this field is clear, the SKU/UPC field on item labels displays the Item Name/Number and prints in Code-128 bar code format.
- urlComponent URL Component: string
-
Enter a short, descriptive name for this item to appear as part of its URL in the Web store. Setting a name to show in the URL can result in better ranking from search engines. If you leave this field blank, NetSuite terms and numbers are used as identifiers in the URL. Note: Descriptive URL components are case sensitive. Descriptive URLs must match the case used in the URL Component field of an item record to point to the correct page.
- useMarginalRates Use Marginal Rates: boolean
-
Check this box if you want the quantity discounts in the schedule to be applied to each pricing bracket separately. For example, a schedule offers no discount for the first 100 items sold and a 5% discount if more than 100 are sold. If 150 items are sold, the first 100 are at normal price, and the other fifty items are sold at 5% discount. Leave this box clear if you want the discount to apply to all of the items sold.
- vendor: vendor
- vendorName Vendor Name/Code: string
-
If your vendor uses a name for this item that is different from the name you use, you can enter up to 60 characters as the vendor's name for this item here. The vendor's name for this item prints in the Item column of purchase forms. If you do not enter a vendor name, the item name prints in the Item column of purchase forms. If you have entered a display name, it will print on purchases instead of the item name.
serviceResaleItem-accountingBookDetailCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: serviceResaleItem-accountingBookDetailElement
-
serviceResaleItem-accountingBookDetailElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
serviceResaleItem-accountingBookDetailElement
This record is available as a beta record.
- accountingBook: accountingBook
- amortizationTemplate: amortizationTemplate
- createExpensePlansOn: nsResource
- createRevenuePlansOn: nsResource
- links Links: nsLink
-
nsLink - refName Reference Name: string
- revRecForecastRule: nsResource
- revRecSchedule: revRecTemplate
- revenueRecognitionRule: nsResource
- sameAsPrimaryAmortization Same as Primary Book Amortization: boolean
- sameAsPrimaryRevRec Same as Primary Book Rev Rec: boolean
serviceResaleItem-billingRate
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: serviceResaleItem-billingRateElement
-
serviceResaleItem-billingRateElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
serviceResaleItem-billingRateElement
This record is available as a beta record.
- billingClass: billingClass
- links Links: nsLink
-
nsLink - rate Base Price: number (double)
-
Enter the rate for this discount or markup. The rate can be either a percentage or dollar amount. A percentage discount must be followed by a % sign. A dollar amount should be entered as a positive number.
- refName Reference Name: string
serviceResaleItem-hierarchyVersionsCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: serviceResaleItem-hierarchyVersionsElement
-
serviceResaleItem-hierarchyVersionsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
serviceResaleItem-hierarchyVersionsElement
This record is available as a beta record.
- endDate Hierarchy Version End Date: string (date)
- hierarchyNode: merchandiseHierarchyNode
- hierarchyVersion: merchandiseHierarchyVersion
- isIncluded Included In Version: boolean
- links Links: nsLink
-
nsLink - refName Reference Name: string
- startDate Hierarchy Version Start Date: string (date)
serviceResaleItem-itemTaskTemplatesCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: serviceResaleItem-itemTaskTemplatesElement
-
serviceResaleItem-itemTaskTemplatesElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
serviceResaleItem-itemVendor-itemVendorPrice
This record is available as a beta record.
- externalId External ID: string
- itemvendorpricelines: serviceResaleItem-itemVendor-itemVendorPrice-itemvendorpricelinesCollection
- links Links: nsLink
-
nsLink - refName Reference Name: string
serviceResaleItem-itemVendor-itemVendorPrice-itemvendorpricelinesCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: serviceResaleItem-itemVendor-itemVendorPrice-itemvendorpricelinesElement
-
serviceResaleItem-itemVendor-itemVendorPrice-itemvendorpricelinesElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
serviceResaleItem-itemVendorCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: serviceResaleItem-itemVendorElement
-
serviceResaleItem-itemVendorElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
serviceResaleItem-itemVendorElement
This record is available as a beta record.
- itemVendorPrice: serviceResaleItem-itemVendor-itemVendorPrice
- links Links: nsLink
-
nsLink - predConfidence Predicted Risk Confidence: number (double)
- predictedDays Predicted Days Late/Early: integer (int64)
- preferredVendor Preferred: boolean
- purchasePrice Purchase Price: number (double)
- refName Reference Name: string
- schedule: nsResource
- subsidiary: subsidiary
- vendor: vendor
- vendorCode Code: string
- vendorCurrencyName Currency: string
serviceResaleItem-presentationItemCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: serviceResaleItem-presentationItemElement
-
serviceResaleItem-presentationItemElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
serviceResaleItem-price
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: serviceResaleItem-priceElement
-
serviceResaleItem-priceElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
serviceResaleItem-priceElement
This record is available as a beta record.
- currencyPage: currency
- discountDisplay Default Discount %: number (double)
- isInactive Inactive: boolean
-
When you check this box, this item will no longer appear on a list unless you check the Show All box at the bottom of the list page.
- links Links: nsLink
-
nsLink - price Amount: number (double)
- priceLevel: priceLevel
- priceLevelName Price Level: string
- priceQty Sequence Number: integer (int64)
- quantity: object
-
- value Value: string
- refName Reference Name: string
serviceResaleItem-siteCategoryCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: serviceResaleItem-siteCategoryElement
-
serviceResaleItem-siteCategoryElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
serviceResaleItem-siteCategoryElement
This record is available as a beta record.
- category: nsResource
- links Links: nsLink
-
nsLink - refName Reference Name: string
- webSite: webSite
serviceResaleItemCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: serviceResaleItem
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
serviceResaleItem - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
serviceSaleItem
This record is available as a beta record.
- VSOEDeferral: object
-
- id Internal identifier.: string DEFERALLUNTIL , DEFERUNTIL
- refName Reference Name: string
- VSOEDelivered Default as Delivered: boolean
-
Check this box to automatically set this item to a Delivered status when this item is added to a transaction. Clear this box to leave the delivery status clear by default.
- VSOEPermitDiscount: object
-
- id Internal identifier.: string IFDELIVERED , NEVER
- refName Reference Name: string
- VSOEPrice Allocation Price: number (double)
-
Enter the VSOE Price for this item if it is known. Note: If you need to use more than one VSOE price for an item, you can set the most common price here and then change the price on each order manually.
- VSOESopGroup: object
-
- id Internal identifier.: string EXCLUDE , NORMAL , SOFTWARE
- refName Reference Name: string
- accountingBookDetail: serviceSaleItem-accountingBookDetailCollection
- amortizationPeriod Amortization Period: integer (int64)
- amortizationTemplate: amortizationTemplate
- autoExpandKitForRevenuemgmt Auto-Expansion for Revenue Management: boolean
- availableToPartners Available to Adv. Partners: boolean
-
Check this box to make this item available to partners with the Advanced Partner Center role for viewing. These items are also available to partners with roles that are customized for the Advanced Partner Center and include view, create or edit access to item records.
- baseUnit Primary Base Unit: string
- billExchRateVarianceAcct: account
- billPriceVarianceAcct: account
- billQtyVarianceAcct: account
- billingRate: serviceSaleItem-billingRate
- billingSchedule: billingSchedule
- class: classification
- consumptionUnit Primary Consumption Unit: string
-
If you use the Multiple Units of Measure feature, select the default unit of measure for inventory.
- contingentRevenueHandling Eligible For Contingent Revenue Handling: boolean
-
Check this box to indicate that the item is subject to contingent revenue handling. When checked, revenue allocation is affected.
- correlatedItems: serviceSaleItem-correlatedItemsCollection
- costEstimate Item Defined Cost: number (double)
-
Enter an Item Defined Cost amount.
- costEstimateUnits Est. Cost Unit: string
- createExpensePlansOn: nsResource
- createJob Create Project: boolean
-
Check this box to make this item eligible to create a job record when it is sold.
- createRevenuePlansOn: nsResource
- createdDate Date Created: string (date-time)
- customForm: object
-
- id Internal identifier.: string -210 , -10211 , -10210
- refName Reference Name: string
- deferralAccount: account
- deferredRevenueAccount: account
- department: department
- description Description: string
- directRevenuePosting Direct Revenue Posting: boolean
-
Check this box to disable advanced revenue management for this item. When checked, posting transactions that include this item post directly to the item revenue account. No revenue element or revenue arrangement is created. When you check this box, the Deferred Revenue Account on the Accounting subtab is disabled. When you create sales transactions that include items that have this box checked, all the items in the transaction must have the box checked. You cannot mix items that post directly to revenue with items that post to deferred revenue in the same transaction. This restriction also applies to kit items. All items in a kit must post either to revenue or to deferred revenue. You cannot check or clear the box after the item has been used in a transaction with advanced revenue management. By default, this box is not checked.
- displayName Display Name/Code: string
-
Enter an optional name of up to 250 characters for this item in addition to the Item Name. If you are integrating with a Yahoo! store, this field is imported from Yahoo!. The display name prints in the Item column of sales forms when Basic printing is used. If this item is a member of a kit, this name appears in the Item column when the Print Items box is checked. If you do not enter a display name, the item name appears on printed forms.
- dontShowPrice Don't Show Price: boolean
-
Check this box to hide the price of this item online. This is useful for items you want to advertise but don't want to sell or for items that you track inventory for and want to display but are offered in combination with other items.
- enforceminqtyinternally Enforce Minimum Internally: boolean
-
Check this box to apply the minimum quantity restriction on sales orders generated from NetSuite. When you clear this box, but enter a number in the Minimum Quantity field, the minimum quantity is only applied to web store orders.
- excludeFromSiteMap Exclude from Sitemap: boolean
-
Check this box to exclude a tab, category or item page from the site map.
- expenseAmortizationRule: nsResource
- externalId External ID: string
- featuredDescription Featured Description: string
-
If this item is displayed on the home page of your Web site, enter a featured description for this item. This description appears below the item's store display name on the Home page of your store or site. You can enter up to 999 characters including basic HTML code. Enter and format text using the formatting options, or click the HTML Source Code link to enter HTML.
- hierarchyVersions: serviceSaleItem-hierarchyVersionsCollection
- id Internal ID: string
- includeChildren Include Children: boolean
-
Check the Include Children box to share the item with all the sub-subsidiaries associated with each subsidiary selected in the Subsidiary field. Note: When sharing items across subsidiaries, all of the options selected on the item record must be compatible across subsidiaries. For example, when entering an inventory item to be shared across subsidiaries, you should select Income and Asset accounts on the item record that are also shared across the same subsidiaries.
- incomeAccount: account
- insertItemAttribute: object
-
- id Internal identifier.: string class , department , itemid , location , issueproduct , vendorname
- refName Reference Name: string
- internalId Internal ID: integer (int64)
- isFulfillable Can be Fulfilled: boolean
-
Check the Can be Fulfilled/Received box to enable this item to be received and fulfilled during order processing. Clear this box if this item does not require being received and fulfilled. Note: Once this item has been added to transactions, this setting cannot be changed. This field is used when the Advanced Billing and Advanced Shipping features are both enabled.
- isGCoCompliant Google Checkout Compliant: boolean
- isInactive Inactive: boolean
-
When you check this box, this item will no longer appear on a list unless you check the Show All box at the bottom of the list page.
- isOnline Display in Website: boolean
-
Check this box to make this item available online in your Web site. You cannot sell this item online unless you check this box. If the item is of the Other Charge for Sale or Resale subtype, checking this box does not make it available in the web store catalog. However, it becomes available during web store checkout.
- issueProduct: issueProduct
- itemId Item Name/Number: string
-
Enter up to 250 characters for the name of this item. This name appears in lists on transactions. If you have the option of entering a display name and do not, the item name prints in the Item column of sales forms when Basic printing is used. If you have the option to enter a vendor name and do not, the item name prints in the Item column of purchase forms. If you have entered a display name, it will print on purchases instead of the item name when Basic printing is used.
- itemRevenueCategory: nsResource
- itemTaskTemplates: serviceSaleItem-itemTaskTemplatesCollection
- itemType: object
-
- lastModifiedDate Last Modified: string (date-time)
- links Links: nsLink
-
nsLink - location: location
- matrixItemNameTemplate Matrix Item Name Template: string
-
This field is used to control how the matrix item will be displayed in the Matrix Item Name/Number field. Compose the order in which attributes and matrix options are displayed by selecting from the Insert Item Attribute and Insert Matrix Option dropdown lists. Add custom separator characters to easier distinguish the various options. Example: Item Name: Fabric / Color / Waist / Length [Location]
- matrixItemNameTemplateHelp Matrix Item Name Template: string
- matrixType: object
-
- id Internal identifier.: string , PARENT , CHILD
- refName Reference Name: string
- maximumquantity Maximum Order Qty: integer (int64)
-
Enter the greatest quantity of this item that customers can purchase. If customers enter an item quantity above the maximum amount, a warning message is displayed. Web store customers are unable to complete checkout unless they enter a quantity equal to or below the maximum quantity. Leave this field empty to allow customers to check out without maximum quantity restrictions. You can edit this warning at Setup > Site Builder/SuiteCommerce Advanced > Customize Text.
- metaTagHtml Meta Tag HTML: string
-
Enter the Meta Tag HTML you want to appear in the < head > section of this item page. Meta tags enable your Web site to be found by search engines.
- minimumquantity Minimum Order Qty: integer (int64)
-
Enter the lowest quantity that customers can purchase. Web store customers receive a warning and cannot check out if they enter an item quantity below this minimum. Leave this field empty to allow customers to check out with no minimum quantity restrictions. You can edit this warning at Setup > Site Builder/SuiteCommerce Advanced > Customize Text.
- noPriceMessage No Price Message: string
-
If you opted to not show a price online, enter the message that should show instead of the price. For example, you might enter "Call for Price."
- offerSupport Offer Support: boolean
-
Check this box to offer support for this particular item. By offering support for items, customers can select on case records which item they are having trouble with.
- onSpecial On Special: boolean
-
If you want to put this item on special, check this box. The item then appears in the Specials category in your store or site.
- outOfStockBehavior: object
-
- id Internal identifier.: string DISABLE , ENABLENMSG , REMOVE , ENABLE , DEFAULT
- refName Reference Name: string
- outOfStockMessage Out Of Stock Message: string
-
You can enter a custom out of stock message for this item. The message here replaces the default out of stock message.
- overallQuantityPricingType: object
-
- id Internal identifier.: string ITEM , PARENT , SCHEDULE
- refName Reference Name: string
- pageTitle Page Title: string
-
Enter the text you want to appear as the page's title for this item. This text appears in the browser tab. Use a descriptive title for the item page, this can help achieve better results with search engine ranking.
- parent: serviceSaleItem
- parentOnly Use as Category Only: boolean
- presentationItem: serviceSaleItem-presentationItemCollection
- price: serviceSaleItem-price
- pricesIncludeTax Prices Include Tax: boolean
-
Check this box to save the base price as the tax inclusive price. Clear this box to save the base price as the tax exclusive price.
- pricingGroup: pricingGroup
- projectExpenseType: projectExpenseType
- projectTemplate: projectTemplate
- quantityPricingSchedule: nsResource
- rate Price: number (double)
-
Enter the rate for this discount or markup. The rate can be either a percentage or dollar amount. A percentage discount must be followed by a % sign. A dollar amount should be entered as a positive number.
- rateIncludingTax Price Including Tax: number (double)
- refName Reference Name: string
- residual Residual: number (double)
- revRecForecastRule: nsResource
- revReclassFxAccount: account
- revenueAllocationGroup: nsResource
- revenueRecognitionRule: nsResource
- saleUnit Primary Sale Unit: string
-
Select the unit you use to sell this item to customers on sales transactions.
- salesDescription Sales Description: string
-
Enter a sales description for this item. You can enter letters and numbers. There is a 999 character limit. The sales description displays on transactions such as sales orders, cash sales and invoices. If you use the Web Store feature, the sales description displays immediately under the item's store display name on item list pages in your store or site, if you have not entered a store description for an item. Enter the store description on the Store subtab of the item record. The sales description also displays by default when the item is in the Web store shopping cart.
- searchKeywords Search Keywords: string
-
Enter alternative search keywords that customers might use to find this item using your Web store’s internal search. These can include synonyms, acronyms, alternate languages or misspellings. These keywords are seen as equally important as the item name when searches are conducted.
- siteCategory: serviceSaleItem-siteCategoryCollection
- siteMapPriority: object
-
- storeDescription Store Description: string
-
The store description appears under the item's store display name on item list pages in your store or site. You can enter letters, numbers, and basic HTML code. Note: To make the store description display when an item is in the Web store shopping cart, go to Setup > Web Site > Set Up Web Site. Click the Cart subtab, and check the box next to Store Description.
- storeDetailedDescription Detailed Description: string
-
Enter a detailed description for this item. When your customers click an item's store display name for more information, they see this description. You can enter letters, numbers or basic HTML code. If you are using Internet Explorer, you can also clear the View Source box below to enter and format text using the formatting options above. This eliminates the need for HTML code. If you do not see the View Source box, make sure Rich Text Editing is enabled at Home > Set Preferences > Appearance.
- storeDisplayImage: nsResource
- storeDisplayName Store Display Name: string
-
Enter the name of this item as you want it displayed in your Web site. You can enter up to 250 characters.
- storeDisplayThumbnail: nsResource
- subsidiary: subsidiaryCollection
- subtype: object
-
- id Internal identifier.: string Sale , Purchase , Resale
- refName Reference Name: string
- unitsType: unitsType
- upcCode UPC Code: string
-
Enter a maximum of 999 characters in this field to identify an internal name or number to store the item's UPC Code. You can use the text you enter here when adding the item to transactions, searching, or viewing reports. * When you enter text in this field, the SKU/UPC field on item labels displays this UPC Code and prints in UPC bar code format. * When this field is clear, the SKU/UPC field on item labels displays the Item Name/Number and prints in Code-128 bar code format.
- urlComponent URL Component: string
-
Enter a short, descriptive name for this item to appear as part of its URL in the Web store. Setting a name to show in the URL can result in better ranking from search engines. If you leave this field blank, NetSuite terms and numbers are used as identifiers in the URL. Note: Descriptive URL components are case sensitive. Descriptive URLs must match the case used in the URL Component field of an item record to point to the correct page.
- useMarginalRates Use Marginal Rates: boolean
-
Check this box if you want the quantity discounts in the schedule to be applied to each pricing bracket separately. For example, a schedule offers no discount for the first 100 items sold and a 5% discount if more than 100 are sold. If 150 items are sold, the first 100 are at normal price, and the other fifty items are sold at 5% discount. Leave this box clear if you want the discount to apply to all of the items sold.
serviceSaleItem-accountingBookDetailCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: serviceSaleItem-accountingBookDetailElement
-
serviceSaleItem-accountingBookDetailElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
serviceSaleItem-accountingBookDetailElement
This record is available as a beta record.
- accountingBook: accountingBook
- amortizationTemplate: amortizationTemplate
- createExpensePlansOn: nsResource
- createRevenuePlansOn: nsResource
- links Links: nsLink
-
nsLink - refName Reference Name: string
- revRecForecastRule: nsResource
- revRecSchedule: revRecTemplate
- revenueRecognitionRule: nsResource
- sameAsPrimaryAmortization Same as Primary Book Amortization: boolean
- sameAsPrimaryRevRec Same as Primary Book Rev Rec: boolean
serviceSaleItem-billingRate
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: serviceSaleItem-billingRateElement
-
serviceSaleItem-billingRateElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
serviceSaleItem-billingRateElement
This record is available as a beta record.
- billingClass: billingClass
- links Links: nsLink
-
nsLink - rate Base Price: number (double)
-
Enter the rate for this discount or markup. The rate can be either a percentage or dollar amount. A percentage discount must be followed by a % sign. A dollar amount should be entered as a positive number.
- refName Reference Name: string
serviceSaleItem-hierarchyVersionsCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: serviceSaleItem-hierarchyVersionsElement
-
serviceSaleItem-hierarchyVersionsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
serviceSaleItem-hierarchyVersionsElement
This record is available as a beta record.
- endDate Hierarchy Version End Date: string (date)
- hierarchyNode: merchandiseHierarchyNode
- hierarchyVersion: merchandiseHierarchyVersion
- isIncluded Included In Version: boolean
- links Links: nsLink
-
nsLink - refName Reference Name: string
- startDate Hierarchy Version Start Date: string (date)
serviceSaleItem-itemTaskTemplatesCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: serviceSaleItem-itemTaskTemplatesElement
-
serviceSaleItem-itemTaskTemplatesElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
serviceSaleItem-presentationItemCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: serviceSaleItem-presentationItemElement
-
serviceSaleItem-presentationItemElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
serviceSaleItem-price
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: serviceSaleItem-priceElement
-
serviceSaleItem-priceElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
serviceSaleItem-priceElement
This record is available as a beta record.
- currencyPage: currency
- discountDisplay Default Discount %: number (double)
- isInactive Inactive: boolean
-
When you check this box, this item will no longer appear on a list unless you check the Show All box at the bottom of the list page.
- links Links: nsLink
-
nsLink - price Amount: number (double)
- priceLevel: priceLevel
- priceLevelName Price Level: string
- priceQty Sequence Number: integer (int64)
- quantity: object
-
- value Value: string
- refName Reference Name: string
serviceSaleItem-siteCategoryCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: serviceSaleItem-siteCategoryElement
-
serviceSaleItem-siteCategoryElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
serviceSaleItem-siteCategoryElement
This record is available as a beta record.
- category: nsResource
- links Links: nsLink
-
nsLink - refName Reference Name: string
- webSite: webSite
serviceSaleItemCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: serviceSaleItem
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
serviceSaleItem - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
shipItem
This record is available as a beta record.
- accChange: boolean
- account: account
- accountHandling: account
- costBasis: object
-
- id Internal identifier.: string pluginRate , fedexRealTimeRate , upsRealTimeRate , uspsRealTimeRate , fr , weight , peritem , ptotal , shippingtable
- refName Reference Name: string
- countries: nsResourceCollection
- description Description: string
-
Enter a description for this shipping item.
- discountRate Discount Rate: number (float)
- displayName Display Name/Code: string
-
Enter the name for the shipping item that you want to appear on printed invoices, in your Web store, and centers such as the Customer Center. In all other places, the Ship Name displays.
- doifArrangement Web Site Rules: string
- doifTotal Web Site Visibility Limited by Total: boolean
-
Check this box to only offer this shipping item online if the order total is more or less than the amount you enter here.
- doifTotalAmt Web Site Visibility By Total Limit: number (double)
- doifTotalOperator: object
-
- id Internal identifier.: string OVER , UNDER
- refName Reference Name: string
- doifWeight Web Site Visibility Limited by Weight: boolean
-
Check this box to only offer this shipping item online if the total order weight is over or under the weight you enter here.
- doifWeightAmt Web Site Visibility By Weight Limit: number (float)
- doifWeightOperator: object
-
- id Internal identifier.: string OVER , UNDER
- refName Reference Name: string
- doifWeightUnit: object
-
- id Internal identifier.: string 1 , 2 , 3 , 4
- refName Reference Name: string
- edition: string
- enabletransittime Enable transit time: boolean
- excludeCountries Excluded For Countries: boolean
-
Check this box to make this shipping item NOT available to ship to the countries selected.
- excludeSites Excluded For Sites: boolean
-
Check this box to make this shipping item NOT available on the Web sites selected.
- externalId External ID: string
- fedexDiscountRate Discount Rate: number (float)
-
To offer a discounted FedEx rate, enter the discount rate in decimal form. This amount is multiplied by the real-time rate to display the total discounted rate. For example, if you want to offer a 25% discount, enter 0.75. Note: To offer free shipping, use promotion codes or create a shipping item with a flat rate of $0.00.
- fedexOneRate FedEx One Rate®: boolean
-
Check this box if the package qualifies. FedEx One Rate is flat-rate shipping that doesn't require you to weigh or measure shipments under 50 lbs.
- fedexServiceCode: object
-
- id Internal identifier.: string 44 , 45 , 46 , 47 , 48 , 49 , 50 , 51 , 52 , 53 , 10 , 54 , 11 , 55 , 12 , 56 , 13 , 57 , 14 , 15 , 16 , 17 , 18 , 19 , 1 , 2 , 3 , 4 , 5 , 6 , 7 , 8 , 9 , 20 , 21 , 22 , 23 , 24 , 25 , 26 , 27 , 28 , 29 , 30 , 31 , 32 , 33 , 34 , 35 , 36 , 37 , 38 , 40 , 41 , 42 , 43
- refName Reference Name: string
- freeIfOrderTotalIsOverAmount Free If Total Over Amount: number (double)
- handlingAsPercentageOfTotal Handling Rate As Percent of Total: number (double)
- handlingByWeightAmount Handling Rate By Weight: number (double)
- handlingByWeightPerQuantity Handling Rate By Weight Per: number (float)
- handlingByWeightPerUnit: object
-
- id Internal identifier.: string 1 , 2 , 3 , 4
- refName Reference Name: string
- handlingCost: object
-
- id Internal identifier.: string no_handling , fr , weight , peritem , ptotal , handlingtable
- refName Reference Name: string
- handlingFlatRateAmount Handling Flat Rate: number (double)
- handlingPerItemAmount Handling Rate By Item: number (double)
-
Enter the default handling charge to ship any item.
- handlingTable: shipItem-handlingTableCollection
- handlingTableChargeBy: object
-
- id Internal identifier.: string ORDERTOTAL , WEIGHT
- refName Reference Name: string
- handlingTableUOM: object
-
- id Internal identifier.: string 1 , 2 , 3 , 4
- refName Reference Name: string
- handlingTaxCode: salesTaxItem
- hasMaximumShippingCost Has Maximum Shipping Cost: boolean
-
If you want to limit the shipping costs your customers pay to a certain dollar amount, check this box and enter the amount.
- hasMinimumShippingCost Has Minimum Shipping Cost: boolean
-
If you want to charge a minimum amount for shipping, check this box and enter the dollar amount.
- id Internal ID: string
- integratedLabelsArrangement Integrated Labels: string
- integrationServiceCode: object
-
- id Internal identifier.: string 44 , 45 , 46 , 47 , 48 , 49 , 50 , 51 , 52 , 53 , 10 , 54 , 11 , 55 , 12 , 56 , 13 , 57 , 14 , 15 , 16 , 17 , 18 , 19 , 1 , 2 , 3 , 4 , 5 , 6 , 7 , 8 , 9 , 20 , 21 , 22 , 23 , 24 , 25 , 26 , 27 , 28 , 29 , 30 , 31 , 32 , 33 , 34 , 35 , 36 , 37 , 38 , 40 , 41 , 42 , 43
- refName Reference Name: string
- invt_dispName Display Name: string
-
Enter the translation that you want to display for this item, if shoppers can view your site in a different language.
- isFreeIfOrderTotalIsOver Is Free If Total Over: boolean
-
If you want to offer free shipping to customers who order over a certain dollar amount, check this box and enter the amount.
- isHandlingByWeightBracketed Handling Rate By Weight Bracketed: boolean
-
To not allow partial increments, check the In Whole Increments box.
- isHandlingTaxable Charge Tax on this handling portion of item: boolean
- isInactive Inactive: boolean
-
When you check this box, this shipping item will no longer appear on a list unless you check the Show All box at the bottom of the Shipping Items page.
- isOnline Display in Website: boolean
-
Check this box to make your shipping item available online. If you charge for shipping, you must provide at least one shipping item for customers to check out from your store. If you don't want to charge for shipping, clear the Charge for Shipping check box on the Set Up Accounting page.
- isShippingByWeightBracketed Shipping Rate By Weight Bracketed: boolean
-
To not allow partial increments, check the In Whole Increments box.
- isTaxable Charge Tax on this shipping portion of item: boolean
-
Check this box to charge tax on this shipping item. You may wish to check with your local tax authorities to see if you must charge tax on shipping.
- itemId Ship Name: string
-
Enter a name for this shipping item. This name appears on transaction pages, lists and all other internal facing documents.
- itemType stype: string
- items: shipItem-itemsCollection
- labelPlugin: string
- labelPluginSelect: object
-
- id Internal identifier.: string
- refName Reference Name: string
- labelReg: string
- labelRegSelect: nsResource
- labelService: string
- labelServiceGroup: string
- labelServiceGroupSelect: object
-
- id Internal identifier.: string
- refName Reference Name: string
- labelServiceSelect: object
-
- id Internal identifier.: string
- refName Reference Name: string
- labelType: object
-
- id Internal identifier.: string
- refName Reference Name: string
- links Links: nsLink
-
nsLink - maximumShippingCost Maximum Shipping Cost: number (double)
- minimumShippingCost Minimum Shipping Cost: number (double)
- needsAllFreeShippingItems All items must be purchased: boolean
-
Check this box to require that every item you select be on an order before free shipping is offered. Otherwise, any item on an order qualifies the order for free shipping.
- omitPackaging Omit packaging: boolean
-
Check this box to disable the automatic packaging logic that occurs during item fulfillment and create only one package for the order.
- pluginLabelsArrangement Shipping Partner Labels: string
- pluginRateArrangement Shipping Partner Rate: string
- ratingPlugin: string
- ratingPluginSelect: object
-
- id Internal identifier.: string
- refName Reference Name: string
- ratingReg: string
- ratingRegSelect: nsResource
- ratingService: string
- ratingServiceGroup: string
- ratingServiceGroupSelect: object
-
- id Internal identifier.: string
- refName Reference Name: string
- ratingServiceSelect: object
-
- id Internal identifier.: string
- refName Reference Name: string
- refName Reference Name: string
- restrictionArrangement Shipping Restrictions: string
- returnLabelReg: string
- returnLabelRegSelect: nsResource
- returnLabelService: string
- returnLabelServiceSelect: object
-
- id Internal identifier.: string
- refName Reference Name: string
- returnServiceCode: object
-
- id Internal identifier.: string 44 , 45 , 46 , 47 , 48 , 49 , 50 , 51 , 52 , 53 , 10 , 54 , 11 , 55 , 12 , 56 , 13 , 57 , 14 , 15 , 16 , 17 , 18 , 19 , 1 , 2 , 3 , 4 , 5 , 6 , 7 , 8 , 9 , 20 , 21 , 22 , 23 , 24 , 25 , 26 , 27 , 28 , 29 , 30 , 31 , 32 , 33 , 34 , 35 , 36 , 37 , 38 , 40 , 41 , 42 , 43
- refName Reference Name: string
- returnsIntegrated Return Label Integration: boolean
-
Check this box to be able to print customer return labels with each order fulfillment that uses the shipping item.
- serviceCode: object
-
- id Internal identifier.: string 44 , 45 , 46 , 47 , 48 , 49 , 50 , 51 , 52 , 53 , 10 , 54 , 11 , 55 , 12 , 56 , 13 , 57 , 14 , 15 , 16 , 17 , 18 , 19 , 1 , 2 , 3 , 4 , 5 , 6 , 7 , 8 , 9 , 20 , 21 , 22 , 23 , 24 , 25 , 26 , 27 , 28 , 29 , 30 , 31 , 32 , 33 , 34 , 35 , 36 , 37 , 38 , 40 , 41 , 42 , 43
- refName Reference Name: string
- shipItemCurrency Currency: string
-
Identifies the currency for the subsidiary.
- shipmethodrulerelations: shipItem-shipmethodrulerelationsCollection
- shipperIntegrated Shipping Label Integration: boolean
-
Check this box to have this shipping item integrated with your default shipping carrier selected at Setup > Accounting Shipping. The method you select here is the method used to ship an order and the method charged to your integrated account. You can choose to charge customers based on either the same method or a different method on the Shipping Rate subtab.
- shippingAsPercentageOfTotal Shipping Rate As Percent of Total: number (double)
- shippingByWeightAmount Shipping Rate By Weight: number (double)
- shippingByWeightPerQuantity Shipping Rate By Weight Per: number (float)
- shippingByWeightPerUnit: object
-
- id Internal identifier.: string 1 , 2 , 3 , 4
- refName Reference Name: string
- shippingCarrier: string
- shippingFlatRateAmount Shipping Flat Rate: number (double)
- shippingPerItemAmount Shipping Rate By Item: number (double)
-
Enter the default amount to charge for shipping on a per-item basis.
- shippingTable: shipItem-shippingTableCollection
- shippingTableChargeBy: object
-
- id Internal identifier.: string ORDERTOTAL , WEIGHT
- refName Reference Name: string
- shippingTableUOM: object
-
- id Internal identifier.: string 1 , 2 , 3 , 4
- refName Reference Name: string
- shippingTaxCode: salesTaxItem
- site: webSiteCollection
- states: nsResourceCollection
- subsidiary: subsidiary
- tabText: string
- tabpromisingtext: string
- taxSchedule: nsResource
- taxScheduleHandling: nsResource
- transittimedays Transit Time Days: integer (int64)
- transittimedayslabel: string
- translations: shipItem-translationsCollection
- upsDiscountRate Discount Rate: number (float)
-
Enter a number to multiply the rate by to receive the correct discount. For example, if you want to offer a 25% discount off the real-time rate USPS returns, enter 0.75.
- upsSaverName: string
- upsServiceCode: object
-
- id Internal identifier.: string 44 , 45 , 46 , 47 , 48 , 49 , 50 , 51 , 52 , 53 , 10 , 54 , 11 , 55 , 12 , 56 , 13 , 57 , 14 , 15 , 16 , 17 , 18 , 19 , 1 , 2 , 3 , 4 , 5 , 6 , 7 , 8 , 9 , 20 , 21 , 22 , 23 , 24 , 25 , 26 , 27 , 28 , 29 , 30 , 31 , 32 , 33 , 34 , 35 , 36 , 37 , 38 , 40 , 41 , 42 , 43
- refName Reference Name: string
- uspsDiscountRate Discount Rate: number (float)
- uspsServiceCode: object
-
- id Internal identifier.: string 44 , 45 , 46 , 47 , 48 , 49 , 50 , 51 , 52 , 53 , 10 , 54 , 11 , 55 , 12 , 56 , 13 , 57 , 14 , 15 , 16 , 17 , 18 , 19 , 1 , 2 , 3 , 4 , 5 , 6 , 7 , 8 , 9 , 20 , 21 , 22 , 23 , 24 , 25 , 26 , 27 , 28 , 29 , 30 , 31 , 32 , 33 , 34 , 35 , 36 , 37 , 38 , 40 , 41 , 42 , 43
- refName Reference Name: string
shipItem-handlingTableCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: shipItem-handlingTableElement
-
shipItem-handlingTableElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
shipItem-itemsCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: shipItem-itemsElement
-
shipItem-itemsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
shipItem-itemsElement
This record is available as a beta record.
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- links Links: nsLink
-
nsLink - nQty Quantity: integer (int64)
- refName Reference Name: string
shipItem-shipmethodrulerelationsCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: shipItem-shipmethodrulerelationsElement
-
shipItem-shipmethodrulerelationsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
shipItem-shipmethodrulerelationsElement
This record is available as a beta record.
- item: shipItem
- links Links: nsLink
-
nsLink - refName Reference Name: string
- subsidiary: subsidiary
shipItem-shippingTableCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: shipItem-shippingTableElement
-
shipItem-shippingTableElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
shipItem-translationsCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: shipItem-translationsElement
-
shipItem-translationsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
shipItemCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: shipItem
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
shipItem - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
solution
This record is available as a beta record.
- assigned: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- autoName Auto: boolean
-
This field is available only if you are allowed to override automatically generated numbers for solutions. Clear this box to make the Code field editable rather than auto-generated.
- createdDate Creation Date/Time: string (date-time)
-
The date this solution was created is shown here.
- customForm: object
-
- id Internal identifier.: string -10140
- refName Reference Name: string
- displayOnline Display Online: boolean
-
Check this box if you want this solution available for published knowledge bases. If you do not check this box, this solution will not display if you publish its topic in a knowledge base.
- eventNumber: integer (int64)
- externalId External ID: string
- id Internal ID: string
- isInactive Inactive: boolean
-
Check this box if you no longer want to use this record. Inactivating records removes them from lists and references everywhere in your account, but they are still available by clicking the Show Inactives box on lists.
- lastModifiedDate Last Modified Date/Time: string (date-time)
-
The date and time this solution was last modified is shown here.
- links Links: nsLink
-
nsLink - longDescription Description: string
-
Enter the text of this solution or topic here. You can use Javascript, HTML and CRMDSK tags in this description. Click Preview to see how this solution will appear when published.
- message Abstract: string
-
Write an abstract or brief description about what this solution resolves. Enter text only, not HTML or other code. This abstract shows on the Solutions list and on the Solutions subtab of case and topic records. The abstract also shows with solution titles in published knowledge bases.
- origsolutionCode: string
- refName Reference Name: string
- solutionCode ID: string
-
To avoid duplicate solution codes, NetSuite enters the next available solution code here. You can accept this code or enter a new code for this solution. Codes can include letters and numbers.
- solutions: solutionCollection
- status: object
-
- id Internal identifier.: string UNAPPROVED , APPROVED
- refName Reference Name: string
- title Title: string
-
Enter a title for this solution. Because solution titles can be searched, this title should be relative to the solution subject. This title shows on the Solutions subtab of the case and topic records that this solution is applied to and in published knowledge bases.
- topics: topicCollection
- userNotes: solution-userNotesCollection
solution-userNotesCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: solution-userNotesElement
-
solution-userNotesElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
solutionCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: solution
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
solution - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
statisticalJournalEntry
This record is available as a beta record.
- absoluteUpdateJournalLink: statisticalJournalEntry
- absoluteupdate Absolute Update: boolean
-
Check this box to update the balance of multiple statistical accounts at the same time. The account balances you enter overwrite all previous values. Absolute values are available to you through reporting and for use in dynamic allocation schedules.
- accountingBook: accountingBook
- accountingBookDetail: statisticalJournalEntry-accountingBookDetailCollection
- approvalStatus: object
-
- id Internal identifier.: string 11 , 1 , 2 , 3
- refName Reference Name: string
- approved Approved: boolean
-
Check this box to indicate that this journal entry is approved. If you check this box, this journal entry will post immediately. If you do not check this box, this journal entry must be approved before it posts.
- class: classification
- conversionrate: number (float)
- createdDate Date Created: string (date-time)
- createdFrom: nsResource
- currency: currency
- currencyPrecision Currency Precision: string
- currencyPrevValue: currency
- customForm: object
-
- id Internal identifier.: string -9970 , 30
- refName Reference Name: string
- department: department
- exchangeRate Exchange Rate: number (double)
- excludeFromGLNumbering Exclude from GL Audit Numbering: boolean
- externalId External ID: string
- id Internal ID: string
- isBaseCurrency Base Currency: boolean
- isFromAmortization: boolean
- isReversal Is Reversal: boolean
- isbookspecific Is Book Specific: boolean
- lastModifiedDate Date Last Modified: string (date-time)
- line: statisticalJournalEntry-lineCollection
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
-
If you wish, enter a memo to describe this journal entry. It will appear on this transaction detail as well as reports such as a 2-line account register.
- nextApprover: employee
- nexus: nexus
- offsetJournalLink: statisticalJournalEntry
- parentstat: nsResource
- pluralsuffix: string
- postingPeriod: accountingPeriod
- prevDate Previous Effective Date: string (date)
- refName Reference Name: string
- reversal: statisticalJournalEntry
- reversalDate Reversal Date: string (date)
-
If this journal entry is intended to be reversed, enter the date for the reversing entry to be posted. If Defer Entry is checked, this field is mandatory.
- reversalDefer Defer Entry: boolean
-
Check this box to make the reversal a memorized transaction that automatically occurs on the date entered in the required Reversal Date field. Clear this box to make the reversal an immediately entered transaction with the date in the Reversal Date field.
- subsidiary: subsidiary
- suffix: string
- toSubsidiary: subsidiary
- total Total: number (double)
-
In this field, NetSuite keeps track of the difference between the debits and credits you enter below. If this field does not equal 0.00, NetSuite will not allow you to submit this transaction.
- tranDate Date: string (date)
-
NetSuite inserts today's date as the date of this journal entry. You can enter or select another date.
- tranId Entry No.: string
-
NetSuite increases the largest journal entry number by one. If you wish, you can type another number. The next journal entry number will revert to the standard pattern. You can enter a maximum of 45 characters in this field.
- unit Unit of Measure: string
- unitlabel Unit of Measure: string
-
This field displays the base unit assigned to the selected Unit of Measure Type.
- unitstype: unitsType
- vatSub: integer (int64)
- void Void: boolean
statisticalJournalEntry-accountingBookDetailCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: statisticalJournalEntry-accountingBookDetailElement
-
statisticalJournalEntry-accountingBookDetailElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
statisticalJournalEntry-accountingBookDetailElement
This record is available as a beta record.
- accountingBook: accountingBook
- exchangeRate Exchange Rate: number (double)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- revRecOnRevCommitment Rev Rec on Rev Commit.: boolean
- subsidiary: subsidiary
- tranIsVsoeBundle Transaction Is VSOE Bundle: boolean
statisticalJournalEntry-lineCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: statisticalJournalEntry-lineElement
-
statisticalJournalEntry-lineElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
statisticalJournalEntry-lineElement
This record is available as a beta record.
- account: account
- amortizationType Type: string
- class: classification
- cleared Cleared: boolean
- clearedDate Date Cleared: string (date)
- credit Credit: number (double)
- debit Amount: number (double)
- department: department
- eliminate Eliminate: boolean
- endDate End Date: string (date)
- entity: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- giftCertCode: giftCertificate
- line Line Id: integer (int64)
- lineunit Units: string
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
- previewdebit Amount (Base Unit): number (double)
- refName Reference Name: string
- residual Residual: number (double)
- revenueRecognitionRule: nsResource
- schedule: nsResource
- scheduleNum: nsResource
- scheduleType: object
-
- id Internal identifier.: string Amortization , RevRec
- refName Reference Name: string
- startDate Start Date: string (date)
statisticalJournalEntryCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: statisticalJournalEntry
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
statisticalJournalEntry - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
storePickupFulfillment
This record is available as a beta record.
- createdDate Date Created: string (date-time)
- createdFrom: nsResource
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- entity: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- exchangeRate Exchange Rate: number (float)
- excludeFromGLNumbering Exclude from GL Audit Numbering: boolean
- externalId External ID: string
- id Internal ID: string
- isBaseCurrency Base Currency: boolean
- item: storePickupFulfillment-itemCollection
- lastModifiedDate Date Last Modified: string (date-time)
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
- orderId Order Id: integer (int64)
- orderType Order Type: string
- partner: partner
- pickedDate Picked Date: string (date)
- pickedupdate Picked Up Date: string (date)
- pickupexpirationdate Expiration Date: string (date)
- pickupstatus: object
-
- id Internal identifier.: string
- refName Reference Name: string
- postingPeriod: accountingPeriod
- prevDate Previous Effective Date: string (date)
- refName Reference Name: string
- requestedBy: fulfillmentRequest
- status: object
-
- id Internal identifier.: string A , B , C
- refName Reference Name: string
- storeOrder: string
- subsidiary: subsidiary
- tranDate Date: string (date)
- tranId Ref No.: string
- webSite: string
storePickupFulfillment-itemCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: storePickupFulfillment-itemElement
-
storePickupFulfillment-itemElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
storePickupFulfillment-itemElement
This record is available as a beta record.
- amount Amount: number (double)
- class: classification
- currency Currency: string
- department: department
- description Description: string
- inventorysubsidiary: subsidiary
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemFxAmount Foreign Amount: number (double)
- itemName Item: string
- itemReceive Fulfill/Receive: boolean
- itemSubtype Subtype: string
- itemType Type: string
- itemUnitPrice Unit Price: number (double)
- itemUpc UPC Code: string
- jobName Job: string
- kitMemberOf Member of Line: integer (int64)
- line Transaction Line: integer (int64)
- lineEntity Entity: integer (int64)
- links Links: nsLink
-
nsLink - location: location
- onHand On Hand: number (float)
- orderDoc: nsResource
- orderLine Order Line: integer (int64)
- quantity Quantity: number (float)
- refName Reference Name: string
- units Units: string
- unitsDisplay Units: string
storePickupFulfillmentCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: storePickupFulfillment
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
storePickupFulfillment - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
subscription
- advanceRenewalPeriodNumber Advance Renewal Period: integer (int64)
- advanceRenewalPeriodUnit: object
-
- id Internal identifier.: string DAYS
- refName Reference Name: string
- autoName Auto: boolean
- autoRenewal Automatically Initiate Renewal Process: boolean
-
Check this box to automatically renew the subscription. After checking this box, enter a date by which you want to renew the subscription before it expires. The renewal process can include negotiating pricing, subscription terms, and other subscription details.
- billingAccount: billingAccount
- billingAccountStartDate Start Date: string (date)
-
The Billing Account start date.
- billingSchedule: billingSchedule
- billingSubscriptionStatus: object
-
- id Internal identifier.: string ACTIVE , PENDING_ACTIVATION , SUSPENDED , DRAFT , CLOSED , TERMINATED , NOT_INCLUDED
- refName Reference Name: string
- class: classification
- currency: currency
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- customer: customer
- defaultRenewalMethod: object
-
- id Internal identifier.: string , EXTEND_EXISTING_SUBSCRIPTION , CREATE_NEW_SUBSCRIPTION
- refName Reference Name: string
- defaultRenewalPlan: subscriptionPlan
- defaultRenewalPriceBook: priceBook
- defaultRenewalTerm: subscriptionTerm
- defaultRenewalTranType: object
-
- id Internal identifier.: string
- refName Reference Name: string
- department: department
- endDate End Date: string (date)
-
The contracted end of the subscription. For a standard-term subscription, equal to the subscription start date plus the indicated subscription term. For a custom-term subscription, the subscription-level end date also must be set at the subscription level.
- estimatedRevRecEndDate Estimated Revenue Recognition End Date: string (date)
-
For recurring subscriptions with an evergreen term, chose a forecasted end date for revenue and billing. NetSuite generates revenue elements and charges until this date, and periodically updates this field based on your preferences. If this field is left blank on activation, NetSuite automatically sets it to 3 years from the activation date.
- externalId External ID: string
- frequency: object
-
- generateModificationElements Generate Modification Elements: boolean
- id Internal ID: string
- idNumber Number: string
-
The automatically generated number identifying this subscription.
- initialTerm: subscriptionTerm
- lastBillCycleDate Last Bill Cycle Date: string (date)
-
The start date for the next billing cycle.
- lastBillDate Last Bill Date: string (date)
-
The date of the last invoice.
- links Links: nsLink
-
nsLink - location: location
- name Name: string
-
Enter a name to identify the subscription. If you leave this field blank, NetSuite automatically generates a subscription name upon saving.
- nextBillCycleDate Next Bill Cycle Date: string (date)
-
The next bill date for this Billing Account.
- nextRenewalStartDate Next Renewal Start Date: string (date)
-
The start date for the next renewal of this subscription.
- priceBook: priceBook
- priceInterval: subscription-priceIntervalCollection
- refName Reference Name: string
- renewalNumber Number of Renewal: integer (int64)
- salesOrder: salesOrder
- startDate Start Date: string (date)
-
The contracted start date for the subscription. You must specify the subscription-level start date, or it defaults to the current date. Defines the earliest possible activation date for the subscription line items. Remains editable until any subscription line item becomes active.
- subscriptionLine: subscription-subscriptionLineCollection
- subscriptionPlan: subscriptionPlan
- subscriptionPlanName Subscription Plan: string
- subscriptionRevision Subscription Revision: integer (int64)
-
The current revision number for the subscription. The revision number increases when you create a change order on the subscription. The first activation is revision 1. Another revision is created whenever a change order is saved.
- subsidiary: subsidiary
subscription-priceIntervalCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: subscription-priceIntervalElement
-
subscription-priceIntervalElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
subscription-priceIntervalElement
- catalogType: object
-
- id Internal identifier.: string ADD_ON , OPTIONAL , REQUIRED
- refName Reference Name: string
- chargeType: object
-
- id Internal identifier.: string 1 , 2 , 3 , 4
- refName Reference Name: string
- discount Discount: number (double)
- frequency: object
-
- id Internal ID: integer (int64)
- includedQuantity Included Quantity: number (float)
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- lineNumber Line Number: integer (int64)
- links Links: nsLink
-
nsLink - multiplierLine Included Quantity Multiplier: string
- overageDiscount Overage Discount: number (double)
- overageFrequency: object
-
- overagePricePlan: pricePlan
- overageRepeatEvery Overage Repeat Every: integer (int64)
- pricePlan: pricePlan
- prorateBy: object
-
- id Internal identifier.: string MONTH , DAY
- refName Reference Name: string
- proratebyoption: object
-
- id Internal identifier.: string 1 , 2
- refName Reference Name: string
- quantity Quantity: number (float)
- recurringAmount Recurring Amount: number (double)
- refName Reference Name: string
- repeatEvery Repeat Every: integer (int64)
- startDate Start Date: string (date)
- startOffsetValue Start On: integer (int64)
- status: object
-
- id Internal identifier.: string NOT_INCLUDED , ACTIVE , CLOSED , PENDING_ACTIVATION , DRAFT , TERMINATED , SUSPENDED
- refName Reference Name: string
- subscriptionPlanLineNumber: integer (int64)
- totalintervalvalue Total Interval Value: number (double)
subscription-subscriptionLineCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: subscription-subscriptionLineElement
-
subscription-subscriptionLineElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
subscription-subscriptionLineElement
- billingMode: object
-
- id Internal identifier.: string IN_ARREARS , IN_ADVANCE
- refName Reference Name: string
- catalogType: object
-
- id Internal identifier.: string ADD_ON , OPTIONAL , REQUIRED
- refName Reference Name: string
- changeOrderLine: integer (int64)
- class: classification
- department: department
- discount Discount: number (double)
- endDate End Date: string (date)
- includeInRenewal Include In Renewal Subscription: boolean
- isIncluded Include: boolean
- isRequired: boolean
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- lineNumber Line Number: integer (int64)
- links Links: nsLink
-
nsLink - location: location
- planItem: integer (int64)
- prorateEndDate Prorate End Date: boolean
- prorateStartDate Prorate Start Date: boolean
- quantity Quantity: number (float)
- recurrenceStartDate Recurrence Start Date: string (date)
- refName Reference Name: string
- renewalOption: string
- revRecOption: object
-
- id Internal identifier.: string ONE_TIME , OVER_TERM
- refName Reference Name: string
- startDate Start Date: string (date)
- status: object
-
- id Internal identifier.: string NOT_INCLUDED , ACTIVE , CLOSED , PENDING_ACTIVATION , DRAFT , TERMINATED , SUSPENDED
- refName Reference Name: string
- subscriptionLine: integer (int64)
- subscriptionLineType: object
-
- id Internal identifier.: string
- refName Reference Name: string
- terminationDate Termination Date: string (date)
subscriptionChangeOrder
- action: object
-
- id Internal identifier.: string ACTIVATE , MODIFY_PRICING , SUSPEND , REACTIVATE , RENEW , TERMINATE
- refName Reference Name: string
- approvalDate Approval Date: string (date-time)
- approvalStatus: object
-
- id Internal identifier.: string PENDING_APPROVAL , APPROVED , REJECTED
- refName Reference Name: string
- autoName Auto: boolean
- billingAccount: billingAccount
- changeOrderLine: subscriptionChangeOrder-changeOrderLineCollection
- createdBy Created By: string
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- customer: customer
- dateCreated Date Created: string (date-time)
- effectiveDate Effective Date: string (date)
-
The date on which the change order takes effect.
- externalId External ID: string
- id Internal ID: string
- idNumber Number: string
-
The automatically generated number identifying this subscription.
- links Links: nsLink
-
nsLink - memo Memo: string
-
Use this fields to enter notes.
- modificationType: object
-
- id Internal identifier.: string NEW_CHURN , UPSELL_DOWNSELL , IGNORED
- refName Reference Name: string
- newSubLine: subscriptionChangeOrder-newSubLineCollection
- refName Reference Name: string
- renewalEndDate Renewal End Date: string (date)
- renewalMethod: object
-
- id Internal identifier.: string , EXTEND_EXISTING_SUBSCRIPTION , CREATE_NEW_SUBSCRIPTION
- refName Reference Name: string
- renewalPlan: subscriptionPlan
- renewalPriceBook: priceBook
- renewalStartDate Renewal Start Date: string (date)
- renewalSteps: subscriptionChangeOrder-renewalStepsCollection
- renewalTerm: subscriptionTerm
- renewalTranType: object
-
- id Internal identifier.: string VendPymt , CustCred , ItemShip , Check , RevContr , Journal , CustChrg , OrdResv , RevArrng , GLAdj , InvReval , Opprtnty , CustRfnd , CashRfnd , TrnfrOrd , Build , Unbuild , RevComm , SalesOrd , Rfq , VPrepApp , TegPybl , Deposit , WOIssue , FinChrg , PurchOrd , FftReq , StatChng , ExpRept , DepAppl , Wave , OwnTrnsf , StPickUp , TegRcvbl , WOCompl , NettStlm , InvAdjst , Transfer , Paycheck , BalJrnal , VendBill , YtdAdjst , XChgJrnl , ItemRcpt , Estimate , PChkJrnl , VPrep , SysJrnl , Commissn , TaxPymt , RtnAuth , CustInvc , FxReval , WorkOrd , PurchCon , BinTrnfr , LiaAdjst , InvDistr , VendRfq , LiabPymt , RevComRv , TaxLiab , InvcGrp , CuTrPrch , CustAuth , VendAuth , InvCount , InvWksht , CardRfnd , VendCred , PEJrnl , BinWksht , Custom , CustPymt , CustDep , PurchReq , WOClose , InbShip , CashSale , BlankOrd , CuTrSale , DeprCust , CardChrg , InvTrnfr
- refName Reference Name: string
- requestOffCycleInvoice Request Off-Cycle Invoice for Advance Charges: boolean
-
Select to set the default for off-cycle invoices, which is inherited from other records. An off-cycle invoice bills for subscriptions with a partial period. For example, sending a bill before the recurring scheduled bills.
- requestor: employee
- subLine: subscriptionChangeOrder-subLineCollection
- subscription: subscription
- subscriptionChangeOrderStatus: object
-
- id Internal identifier.: string ACTIVE , VOIDED
- refName Reference Name: string
- subscriptionPlan: subscriptionPlan
- subsidiary: subsidiary
- terminateAtStartOfDay Effective at Start of day: boolean
subscriptionChangeOrder-changeOrderLineCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: subscriptionChangeOrder-changeOrderLineElement
-
subscriptionChangeOrder-changeOrderLineElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
subscriptionChangeOrder-newSubLineCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: subscriptionChangeOrder-newSubLineElement
-
subscriptionChangeOrder-newSubLineElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
subscriptionChangeOrder-newSubLineElement
- discount Discount: number (double)
- include Include: string
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemDisplay Item: string
- links Links: nsLink
-
nsLink - multiplierLine Included Quantity Multiplier: integer (int64)
- pricePlan: pricePlan
- quantity Quantity: number (float)
- refName Reference Name: string
- required Required: string
- sequence Line Number: string
- status: object
-
- id Internal identifier.: string DRAFT
- refName Reference Name: string
- subscriptionLine Subscription Line: string
- subscriptionLineType: object
-
- id Internal identifier.: string 1 , 2 , 3 , 4
- refName Reference Name: string
subscriptionChangeOrder-renewalStepsCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: subscriptionChangeOrder-renewalStepsElement
-
subscriptionChangeOrder-renewalStepsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
subscriptionChangeOrder-renewalStepsElement
- error Error Message: string
- links Links: nsLink
-
nsLink - refName Reference Name: string
- status: object
-
- id Internal identifier.: string SUCCESS , FAILURE
- refName Reference Name: string
- step: object
-
- id Internal identifier.: string CREATE_NEW_SUBSCRIPTION , CREATE_NEW_SALES_TRANSACTION
- refName Reference Name: string
- subscription: subscription
- transaction: nsResource
subscriptionChangeOrder-subLineCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: subscriptionChangeOrder-subLineElement
-
subscriptionChangeOrder-subLineElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
subscriptionChangeOrder-subLineElement
- apply Include: boolean
- billingMode Billing Mode: string
- discount Discount: number (double)
- discountNew Discount: number (double)
- endDate End Date: string (date)
- includeInRenewal Include In Renewal Subscription: boolean
- item Item: integer (int64)
- links Links: nsLink
-
nsLink - pricePlan Rate Plan: integer (int64)
- pricePlanNew: pricePlan
- quantity Quantity: number (float)
- quantityNew Quantity: number (float)
- recurringAmount Recurring Amount: number (double)
- recurringAmountNew Recurring Amount: number (double)
- refName Reference Name: string
- sequence Line Number: string
- startDate Start Date: string (date)
- status Status: string
- statusNew: object
-
- id Internal identifier.: string DRAFT , PENDING_ACTIVATION , ACTIVE , SUSPENDED , CLOSED
- refName Reference Name: string
- subscriptionLine Subscription Line: integer (int64)
- terminationDate Termination Date: string (date)
subscriptionChangeOrderCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: subscriptionChangeOrder
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
subscriptionChangeOrder - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
subscriptionCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: subscription
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
subscription - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
subscriptionLine
- alignChargeWithSub Align Charge amounts with Subscription: boolean
- billingMode: object
-
- id Internal identifier.: string IN_ARREARS , IN_ADVANCE , IMMEDIATE
- refName Reference Name: string
- catalogType: object
-
- id Internal identifier.: string ADD_ON , OPTIONAL , REQUIRED
- refName Reference Name: string
- class: classification
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- department: department
- endDate End Date: string (date)
-
The scheduled end date for this line item on the subscription.
- estimatedRevRecEndDate Estimated Revenue Recognition End Date: string (date)
-
For recurring subscriptions with an evergreen term, chose a forecasted end date for revenue and billing. NetSuite generates revenue elements and charges until this date, and periodically updates this field based on your preferences. If this field is left blank on activation, NetSuite automatically sets it to 3 years from the activation date.
- externalId External ID: string
-
Unique identification number assigned to the item. This is a system-generated read-only field.
- id Internal ID: string
- includeInRenewal Include In Renewal Subscription: boolean
- isIncluded Include: boolean
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- lineNumber Line Number: integer (int64)
-
Unique integer value assigned to this line item in the subscription.
- links Links: nsLink
-
nsLink - location: location
- poNumber PO #: string
- prorateEndDate Prorate End Date: boolean
- prorateStartDate Prorate Start Date: boolean
- recurrenceStartDate Recurrence Start Date: string (date)
- refName Reference Name: string
- revRecOption: object
-
- id Internal identifier.: string ONE_TIME , OVER_TERM
- refName Reference Name: string
- salesOrder: salesOrder
- salesOrderLineNumber Sales Order Line Number: integer (int64)
-
The line number of the subscription line on the associated sales order.
- startDate Start Date: string (date)
-
The scheduled start date for this line item on the subscription.
- subscription: subscription
- subscriptionLineStatus: object
-
- id Internal identifier.: string NOT_INCLUDED , ACTIVE , CLOSED , PENDING_ACTIVATION , DRAFT , TERMINATED , SUSPENDED
- refName Reference Name: string
- subscriptionLineType: object
-
- id Internal identifier.: string 1 , 2 , 3 , 4
- refName Reference Name: string
- subscriptionPlan: subscriptionPlan
- subscriptionPlanLine Subscription Plan Line: string
- terminationDate Termination Date: string (date)
- total Total: number (double)
subscriptionLineCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: subscriptionLine
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
subscriptionLine - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
subscriptionPlan
- advanceRenewalPeriodNumber Advance Renewal Period: integer (int64)
- advanceRenewalPeriodUnit: object
-
- id Internal identifier.: string DAYS
- refName Reference Name: string
- autoRenewal Automatically Initiate Renewal Process: boolean
-
Check this box to automatically start the renewal process on the date specified in the Before Subscription End Date field.
- class: classification
- createdDate Date Created: string (date-time)
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- defaultRenewalMethod: object
-
- id Internal identifier.: string , EXTEND_EXISTING_SUBSCRIPTION , CREATE_NEW_SUBSCRIPTION
- refName Reference Name: string
- defaultRenewalPlan: subscriptionPlan
- defaultRenewalTerm: subscriptionTerm
- defaultRenewalTranType: object
-
- id Internal identifier.: string Opprtnty , Estimate , SalesOrd
- refName Reference Name: string
- department: department
- description Description: string
-
(optional) A name or code to be displayed in place of the Subscription Plan Name.
- displayName Display Name/Code: string
-
Enter an optional display name for the subscription plan.
- externalId External ID: string
- id Internal ID: string
- includeChildren Include Children: boolean
-
Check this box if you want to include subcustomers or subsidiaries.
- incomeAccount: account
- initialTerm: subscriptionTerm
- isInactive Inactive: boolean
-
Check this box if this subscription plan is no longer active.
- itemId Subscription Plan Name: string
-
Enter a name to identify the subscription plan.
- itemType: object
-
- lastModifiedDate Last Modified: string (date-time)
- links Links: nsLink
-
nsLink - location: location
- member: subscriptionPlan-memberCollection
- refName Reference Name: string
- subsidiary: subsidiaryCollection
subscriptionPlan-memberCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: subscriptionPlan-memberElement
-
subscriptionPlan-memberElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
subscriptionPlan-memberElement
- billingMode: object
-
- id Internal identifier.: string IN_ARREARS , IN_ADVANCE
- refName Reference Name: string
- internalId Internal ID: integer (int64)
- isRequired Required: boolean
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- lineNumber Line Number: integer (int64)
- links Links: nsLink
-
nsLink - prorateEndDate Prorate End Date: boolean
- prorateStartDate Prorate Start Date: boolean
- refName Reference Name: string
- renewalOption: object
-
- id Internal identifier.: string ALWAYS , NEVER , SAME_PLAN , DIFFERENT_PLAN
- refName Reference Name: string
- revRecOption: object
-
- id Internal identifier.: string ONE_TIME , OVER_TERM
- refName Reference Name: string
- subscriptionLineType: object
-
- id Internal identifier.: string 1 , 2 , 3 , 4
- refName Reference Name: string
subscriptionPlanCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: subscriptionPlan
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
subscriptionPlan - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
subscriptionTerm
- externalId External ID: string
- id Internal ID: string
- isInactive Inactive: boolean
-
Check this box to remove all references to this record from your account. You can reactivate the record at any time.
- links Links: nsLink
-
nsLink - longitemtype: string
- name Name: string
- refName Reference Name: string
- subscriptionTermDuration Duration: integer (int64)
- subscriptionTermType: object
-
- id Internal identifier.: string EVERGREEN , CUSTOM , STANDARD
- refName Reference Name: string
- subscriptionTermUnit: object
-
- id Internal identifier.: string MONTHS , YEARS , WEEKS , DAYS
- refName Reference Name: string
- tname: string
subscriptionTermCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: subscriptionTerm
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
subscriptionTerm - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
subsidiary
- country: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- currency: currency
- email Return Email Address: string
-
Enter the return email address for this subsidiary.
- externalId External ID: string
- fax Fax: string
-
Enter the fax number for this subsidiary.
- fullName Full Name: string
- id Internal ID: string
- internalId Internal ID: integer (int64)
-
Either the internalID or externalID field is required for update, delete and get operations.
- isElimination Elimination: boolean
-
Check this box if this subsidiary record is to be used for only journal entries and transactions between subsidiaries. When a loan, sale, or inventory transfer is made between subsidiaries, you use an elimination subsidiary to balance your consolidated books. By entering a journal entry against the elimination subsidiary in the same amount as the inter-company transaction, you have both a record of the transactions and a correct balance.
- isInactive Subsidiary is Inactive: boolean
-
Check this box if this subsidiary is no longer active or used in your account. Inactivated subsidiaries no longer show in the Subsidiary field on records and transactions unless they are currently attached to a record. Web sites of inactive subsidiaries are no longer available online.
- lastModifiedDate Last Modified Date: string (date-time)
- legalName Legal Name: string
-
Enter the legal name of this subsidiary as it should appear on tax forms.
- links Links: nsLink
-
nsLink - mainAddress: subsidiary-mainAddress
- name Name: string
-
Enter the name of this subsidiary the way it should appear on all forms except checks. On checks, your company name is pre-printed with address and MICR information. The name can be alphanumeric. The maximum number of characters is 83.
- parent: subsidiary
- refName Reference Name: string
- representingCustomer: customer
- representingVendor: vendor
- returnAddress: subsidiary-returnAddress
- shippingAddress: subsidiary-shippingAddress
- state State: string
-
Select the state or province in which this subsidiary is located.
- tranInternalPrefix Transaction Number Prefix: string
-
When you use auto-generated numbering with NetSuite OneWorld, you can make your transaction number sequences independent per subsidiary. Enter up to 8 alphanumeric characters in this field to number transactions with a prefix to signify this subsidiary. To set up auto-generated numbering, go to Setup > Setup Tasks > Auto-Generated Numbers. On the Transaction Numbers subtab, check the Use Subsidiary box next to each transaction to which this prefix should be applied.
- url Web Site: string
-
Enter this subsidiary's Web Site address, or URL.
subsidiary-mainAddress
- addr1 Address 1: string
- addr2 Address 2: string
- addr3 Address 3: string
- addrPhone Phone: string
- addrText Address: string
- addressee Addressee: string
- attention Attention: string
- city City: string
- country: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- externalId External ID: string
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - override Override: boolean
- refName Reference Name: string
- state State/Province: string
- zip Zip: string
subsidiary-returnAddress
- addr1 Address 1: string
- addr2 Address 2: string
- addr3 Address 3: string
- addrPhone Phone: string
- addrText Address: string
- addressee Addressee: string
- attention Attention: string
- city City: string
- country: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- externalId External ID: string
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - override Override: boolean
- refName Reference Name: string
- state State/Province: string
- zip Zip: string
subsidiary-shippingAddress
- addr1 Address 1: string
- addr2 Address 2: string
- addr3 Address 3: string
- addrPhone Phone: string
- addrText Address: string
- addressee Addressee: string
- attention Attention: string
- city City: string
- country: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- externalId External ID: string
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - override Override: boolean
- refName Reference Name: string
- state State/Province: string
- zip Zip: string
subsidiaryCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: subsidiary
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
subsidiary - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
subtotalItem
This record is available as a beta record.
- availableToPartners Available to Adv. Partners: boolean
-
Check this box to make this item available to partners with the Advanced Partner Center role for viewing. These items are also available to partners with roles that are customized for the Advanced Partner Center and include view, create or edit access to item records.
- createdDate Date Created: string (date-time)
- customForm: object
-
- id Internal identifier.: string -10250 , -250
- refName Reference Name: string
- description Description: string
-
Enter a description for this item. This description will appear in the Description column of sales forms.
- displayName Display Name/Code: string
-
Enter an optional name of up to 250 characters for this item in addition to the Item Name. If you are integrating with a Yahoo! store, this field is imported from Yahoo!. The display name prints in the Item column of sales forms when Basic printing is used. If this item is a member of a kit, this name appears in the Item column when the Print Items box is checked. If you do not enter a display name, the item name appears on printed forms.
- externalId External ID: string
- id Internal ID: string
- includeChildren Include Children: boolean
-
Check the Include Children box to share the item with all the sub-subsidiaries associated with each subsidiary selected in the Subsidiary field. Note: When sharing items across subsidiaries, all of the options selected on the item record must be compatible across subsidiaries. For example, when entering an inventory item to be shared across subsidiaries, you should select Income and Asset accounts on the item record that are also shared across the same subsidiaries.
- isInactive Inactive: boolean
-
When you check this box, this item will no longer appear on a list unless you check the Show All box at the bottom of the list page.
- issueProduct: issueProduct
- itemId Item Name/Number: string
-
Enter up to 250 characters for the name of this item. This name appears in lists on transactions. If you have the option of entering a display name and do not, the item name prints in the Item column of sales forms when Basic printing is used. If you have the option to enter a vendor name and do not, the item name prints in the Item column of purchase forms. If you have entered a display name, it will print on purchases instead of the item name when Basic printing is used.
- itemType: object
-
- lastModifiedDate Last Modified: string (date-time)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- subsidiary: subsidiaryCollection
subtotalItemCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: subtotalItem
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
subtotalItem - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
supplyChainSnapshot
This record is available as a beta record.
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- daterun Date Run: string (date-time)
-
This field displays the date the snapshot is generated.
- externalId External ID: string
- futurehorizon Supply Chain Future Horizon: integer (int64)
-
The Default Supply Chain Future Horizon can be changed only on the item record or using the default preference. Even if no setting is shown for the Future Horizon on a snapshot, the default future order horizon is used to generate the snapshot.
- futurehorizondate Supply Chain Future Horizon Date: string (date)
- id Internal ID: string
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - memo Memo: string
-
Optionally enter a memo to identify this snapshot.
- pasthorizon Supply Chain Past Horizon: string
-
If you have set a Default Supply Chain Past Order Horizon, it is displayed here. You can enter another date if needed. Select the number of days prior you want to be included in the snapshot. This will include past orders from the last generated snapshot for an item. The maximum is 60 days.
- pasthorizondate Supply Chain Past Horizon Date: string (date)
- refName Reference Name: string
- refresh Refresh: boolean
- replenishmentmethod: object
-
- id Internal identifier.: string TIME_PHASED , MPS , REORDER_POINT , MRP
- refName Reference Name: string
- stockunit Stock Unit: string
-
The stock unit for the selected item is displayed in this field.
- supplychainsnapshotdetails: supplyChainSnapshot-supplychainsnapshotdetailsCollection
supplyChainSnapshot-supplychainsnapshotdetailsCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: supplyChainSnapshot-supplychainsnapshotdetailsElement
-
supplyChainSnapshot-supplychainsnapshotdetailsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
supplyChainSnapshot-supplychainsnapshotdetailsElement
This record is available as a beta record.
- allocatedDemand Allocated Demand: number (float)
- allocatedSupply Allocated Supply: number (float)
- availableInvtBalance Available Inventory Balance: number (float)
- blanketpurchaseorderquantity Blanket Purchase Order Quantity: number (float)
- date Date: string (date)
- dayspastdue Days Past Due: string
- demandquantity Demand Quantity: number (float)
- entity: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- inboundShipment Inbound Shipment: string
- invbalance Inventory Balance: number (float)
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- links Links: nsLink
-
nsLink - locationBase: location
- originaltransactiondate Originating Transaction Date: string
- otherdemandquantity Other Demand Quantity: number (float)
- othersupplyquantity Other Supply Quantity: number (float)
- purchaserrderquantity Purchase Order Quantity: number (float)
- refName Reference Name: string
- replenishmentMethod: object
-
- id Internal identifier.: string TIME_PHASED , MPS , REORDER_POINT , MRP
- refName Reference Name: string
- salesorderquantity Sales Order Quantity: number (float)
- sourceType: object
-
- id Internal identifier.: string INV , PDT , PLO , PDSIM , SIM , PDPLO , TRAN
- refName Reference Name: string
- status Status: string
- subsidiary: subsidiary
- supplyquantity Supply Quantity: number (float)
- transaction Transaction: string
- transferorderquantity Transfer Order Quantity: number (float)
- trantype Transaction Type: string
- workorderquantity Work Order Quantity: number (float)
supplyChainSnapshotCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: supplyChainSnapshot
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
supplyChainSnapshot - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
supplyChainSnapshotSimulation
This record is available as a beta record.
- autoName Auto: boolean
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- demandentity: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- demandlocation: location
- demandlocationdate Demand Date: string (date)
- demandlocationsubsidiary: subsidiary
- doccreatedfrom: integer (int64)
- docnumcreatedfrom Document Created From: string
- externalid External ID: string
- id Internal ID: string
- isforreschedule For Reschedule: boolean
- isrecommendation: boolean
- itemnamenumber: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemtype: object
-
- linecreatedfrom Line Created From: integer (int64)
- links Links: nsLink
-
nsLink - memo Memo: string
-
Optionally enter a memo to identify this snapshot.
- owner: employee
- quantity Quantity: number (float)
- refName Reference Name: string
- scompid: string
- simulationnumber Simulation Number: string
- status: object
-
- id Internal identifier.: string R , 5 , E , I
- refName Reference Name: string
- supplyentity: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- supplylocation: location
- supplylocationdate Supply Date: string (date)
- supplylocationsubsidiary: subsidiary
- transactiontype: object
-
- id Internal identifier.: string WorkOrd , TrnfrOrd , SalesOrd , PurchOrd
- refName Reference Name: string
supplyChainSnapshotSimulationCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: supplyChainSnapshotSimulation
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
supplyChainSnapshotSimulation - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
supplyChangeOrder
This record is available as a beta record.
- approvalStatus: object
-
- id Internal identifier.: string 17 , 18 , 19
- refName Reference Name: string
- changeAction: object
-
- id Internal identifier.: string RESCHEDULE_IN , CANCEL , RESCHEDULE_OUT
- refName Reference Name: string
- currentTransactionDate Current Transaction Date: string (date)
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- externalId External ID: string
- id Internal ID: string
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
- newDate New Date: string (date)
- nextApprover: employee
- originalDate Original Date: string (date)
- refName Reference Name: string
- sourcelocation: location
- supplyPlanDefinition: supplyPlanDefinition
- transaction: nsResource
supplyChangeOrderCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: supplyChangeOrder
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
supplyChangeOrder - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
supplyPlanDefinition
This record is available as a beta record.
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- description Description: string
- externalId External ID: string
- generatePegging Generate Pegging: boolean
- horizonInDays Horizon (In Days): integer (int64)
- id Internal ID: string
- itemGroup: planningItemGroup
- links Links: nsLink
-
nsLink - name Name: string
- planningView: planningView
- refName Reference Name: string
- ruleGroup: planningRuleGroup
- scope: supplyPlanDefinition-scopeCollection
supplyPlanDefinition-scopeCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: supplyPlanDefinition-scopeElement
-
supplyPlanDefinition-scopeElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
supplyPlanDefinitionCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: supplyPlanDefinition
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
supplyPlanDefinition - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
supportCase
This record is available as a beta record.
- assigned: employee
- autoName Auto: boolean
-
This field is available only if you are allowed to override automatically generated numbers for cases. Clear this box to make the Number field editable rather than auto-generated.
- caseNumber ID: string
-
If you use auto-generated numbering, this number is automatically assigned to give the case a unique identifier. You can use this case number to quickly access this case using the case search or the Global Search field.
- category: nsResource
- company: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- companyId: integer (int64)
- companyName: string
- contact: contact
- contactId: integer (int64)
- createdDate Creation Date/Time: string (date-time)
-
The date and time that this case record was first created shows in this field.
- customForm: object
-
- id Internal identifier.: string -10102 , -10101 , -10100
- refName Reference Name: string
- dateCreated Creation Date/Time: string (date-time)
-
The date and time when the case was created.
- email Emails: string
-
Enter the individual or company contact's email address. You can enter multiple email addresses separated by commas or semicolons. If you check the Email reply box, your response is emailed to these addresses.
- emailEmployees Copy Employees: string
-
Select other employees whom you would like to send information on this case to. Press and hold CTRL to select more than one name. An email notification with the case's details is sent to these employees when you save this record. Check the Email Reply box to send case messages to both the customer and the employees selected here.
- emailForm Email reply: boolean
-
Check this box to email your reply to the customer's email as entered in the Email field above. When editing a case, you can also send email to customers or employees using the Email button on the Messages subtab.
- endDate Date Closed: string (date-time)
-
The date and time when the case was closed.
- escalateHist: supportCase-escalateHistCollection
- escalateTo: one of: [ customerCollection, partnerCollection, vendorCollection, nsResourceCollection, employeeCollection, contactCollection ]
- escalationMessage Escalation Message: string
-
Enter a message that will be e-mailed to the person you are escalating this case to. The customer does not receive a copy of this e-mail message. The message is not stored in the case record.
- eventNumber: integer (int64)
- externalId External ID: string
- firstIssueAttached First Issue Attached: string (date-time)
-
The date and time of when an issue was first attached to the case.
- firstIssueRemoved First Issue Removed: string (date-time)
-
The date and time of when an issue was first detached from the case.
- firstUpdated First updated: string (date-time)
-
The date and time when the case was first worked on (first edit).
- helpDesk Help Desk: boolean
-
Check this box if this case is internal and is being submitted by or for an employee. Help desk cases are not included in Customer Service reports.
- htmlMessage: boolean
- id Internal ID: string
- inboundEmail Inbound Email Address: string
-
If this case was submitted by email, this field displays the email address to which the case was sent to submit the case. For example, if you use two support email addresses, support@yourcompany.com and help@yourcompany.com, this field shows which address was used. The email address the customer sent the message from displays in the Email field.
- incomingMessage Message: string
-
If this case was submitted by a customer, the customer's most recent message appears here. If you are creating this case, enter the problem or question here. If you change the customer or company who submitted this case, the last message remains, even if it is from the previous company. To view all past messages, click View History on the Messages subtab.
- initialResponseTime Initial Response Time: string
-
The duration between the time the case was created and the first response to the customer.
- internalOnly Internal Only: boolean
-
Check this box if you do not want your reply to be seen by customers. Only people in your company who view this case record can see your internal message. When editing a case, you can also send email to customers or employees using the Email button on the Messages subtab.
- isInactive Inactive: boolean
-
Check this box if you want to remove this case from the cases list. To view inactive cases, you can check the Show Inactives box at the bottom of the list.
- issue: nsResource
- issues: issueCollection
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- lastCustomerMessageReceived Last Customer Message Received: string (date-time)
-
The date and time of the last message received from the customer.
- lastIssueAttached Last Issue Attached: string (date-time)
- lastIssueRemoved Last Issue Removed: string (date-time)
- lastMessageDate Last Message Date: string (date-time)
-
The date and time of the last message received or sent relating to the case.
- lastModifiedDate Last Modified Date/Time: string (date-time)
-
The date and time when the case was last worked on. This field updates automatically when a message is received from a contact and when a message is submitted to a contact.
- lastReopenedDate Date Last Reopened: string (date-time)
-
The date and time when the case was last changed from Closed to Re-opened.
- links Links: nsLink
-
nsLink - mediaItem: nsResourceCollection
- messageNew New Message: boolean
-
Check this box to add a new message from the customer. This might be needed if the customer calls in and his or her question needs to be documented. When you check this box, Message field clears so that you can enter the new message. If the box isn't checked, the customer's most recent message shows in the Message field. All previous messages from and to the customer are listed on the Message subtab.
- messageSave: string
- module Module: string
-
Select the product module this case is related to. You can create and edit modules on product records at Setup > Issues > Products.
- origcaseNumber: string
- origin: nsResource
- outgoingMessage Reply: string
-
Use this field to enter a reply to the message. This can be an answer, solution or request for more information based on the information in the Message field. Check the Send Email box to email this reply to the email address saved on this case record. Check the Internal Only box to email this reply only to those selected in the Email Employees field.
- phone Phone: string
-
Enter the contact's phone number for this case. This phone number can be used by support or IT to follow up on a case.
- priority: nsResource
- product: issueProduct
- profile: nsResource
- quickNote Quick Note: string
-
You can enter information in this field that you want to keep separate from the case details. This note can only be seen by others in your company with access to this case. You can add this field to your cases list view and enter information on the list page using the Inline Editing feature.
- refName Reference Name: string
- serialNumber: inventoryNumber
- solutions: solutionCollection
- spamLock Spam Lock: string
- stage: string
- startDate Incident Date: string (date)
-
Enter, accept or click the calendar to pick the date this case is being reported. This date shows on the Cases list, and the list can be filtered by date. The date also shows on the Case subtab of completed company, customer and solution records.
- startTime Incident Time: string
-
Enter or accept the time that this case is being reported. This time shows under the date on the Cases list. The time also shows on the Cases subtab of completed company, customer, and solution records.
- status: nsResource
- subsidiary: subsidiary
- supportFirstReply Support First Reply: string (date-time)
-
The date and time of when the first reply message was sent to the customer.
- timeElapsed Time Elapsed: string
-
Total number of hours the case has been actively running, excluding time spent on hold.
- timeItem Time Tracking: string
- timeOnHold Time On Hold: string
-
Total number of hours the case has been on hold since case creation.
- timeOpen Time Open: string
-
Total number of hours the case has not been on hold or closed (includes standard statuses and customizations of Not Started, In progress, Escalated, Reopened.)
- timeToAssign Time To Assign: string
-
The time between when the case was created and when it was assigned
- timeToClose Time To Close: string
-
The difference between Date Created and Date Closed.
- title Subject: string
-
Enter the subject of this case. You can enter up to 256 characters in this field. The subject shows in the second column of the Cases list, and it is a useful way to determine what the case is about. On saved records for individuals or companies who submit cases, the subject appears in the Title column of the Cases subtab. If you use the Knowledge Base feature, the subject also appears on the Cases subtab of completed solution records.
- transactionId: string
- useEmployeeTemplate Use Employee Template: boolean
-
Check this box if you want to use the employee template selected at Setup > Support > Preferences > Support Preferences > Notification in the Copy Employee Template field for the email sent to employees to notify them of changes to this case. Keep this box clear if you want to use the customer template for the email sent to employees. Note: Email is only sent if the Send to Customer box is also checked.
- userNotes: supportCase-userNotesCollection
- version: string
supportCase-escalateHistCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: supportCase-escalateHistElement
-
supportCase-escalateHistElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
supportCase-userNotesCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: supportCase-userNotesElement
-
supportCase-userNotesElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
supportCaseCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: supportCase
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
supportCase - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
task
- accessLevel Private: boolean
-
Check this box so that only the creator of this task or person assigned this task can view the task. If you don't check this box, this task is considered public and can be viewed on all task lists.
- actualTime Actual Time: string
-
The Actual Time field shows the total amount of time entered against this task.
- assigned: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- bom: bom
- bomRevision: bomRevision
- company: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- completedDate Date Completed: string (date)
-
Enter the date this task was actually completed.
- contact: contact
- createdDate Date Created: string (date-time)
- customForm: object
-
- id Internal identifier.: string -10120 , -120
- refName Reference Name: string
- dueDate Due Date: string (date)
-
Enter the projected date when this task needs to be complete.
- endTime End time: string
-
Enter the end time for placing this task on the assignee's calendar. You must check the Block Out Time box to set a time in this field.
- estimatedTime Initial Time Budget: string
-
In the Initial Time Budget field, enter your first approximation of the amount of time this task will take. Later, you can increase or decrease your time estimate in the Current Time Budget field. By maintaining an initial time estimate in this field, you can compare your initial estimate to your altered estimate. If you entered a time estimate on a job task template, that amount shows here.
- estimatedTimeOverride Current Time Budget: string
-
If your estimate of the time this task will take increases or decreases from your original estimate, enter the altered estimate in the Current Time Budget field.
- externalId External ID: string
- id Internal ID: string
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - message Comments: string
-
Enter any comments about this task. These comments appear in the e-mail sent to the person this task is assigned to.
- mfgRouting: manufacturingRouting
- milestone: object
-
- id Internal identifier.: string
- refName Reference Name: string
- order Insert Before: string
-
Choose the placement of this task on your task list or the person's tasks list you are assigning this to. Leave this field blank to place this task last on the tasks list.
- owner: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- parent: task
- percentComplete Percent Complete: number (double)
-
In the Percent Complete field, enter an estimate of how much of the total amount of work for this task is already completed. For example, if half the work toward completion is done, enter 50%. Note: The percentage you enter in this field overrides the auto-calculated figure in the Percent Time Complete field and is used for task calculations.
- percentTimeComplete Percent Complete (Time): number (double)
-
The system auto-calculates a value for the Percent Time Complete field, by dividing Actual Time by Current Time Budget (or by Initial Time Budget, if no Current Time Budget has been entered). This value indicates how much of the budgeted time for the task has been completed. You can override this value by entering a percentage value in the Percent Complete field.
- priority: object
-
- id Internal identifier.: string HIGH , MEDIUM , LOW
- refName Reference Name: string
- refName Reference Name: string
- relatedItem: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- reminderMinutes: object
-
- id Internal identifier.: string 0 , 5 , 10 , 15 , 30
- refName Reference Name: string
- reminderType: object
-
- id Internal identifier.: string POPUP , EMAIL
- refName Reference Name: string
- sendEmail Send email: boolean
-
Check this box to send an email message to the person this task is assigned to. The person the task is assigned to also receives an e-mail message when this task is updated if the Send e-mail box is checked. If this person's record does not include an email address, no message will be sent.
- startDate Start Date: string (date)
-
This is the date the task should be started. If you are entering or editing the task, type or pick the start date of the task. This date is included in the e-mail to the assignee.
- startTime Start Time: string
-
Enter the start time for placing this task on the assignee's calendar. You must check the Block Out Time box to set a time in this field.
- status: object
-
- id Internal identifier.: string NOTSTART , PROGRESS , COMPLETE
- refName Reference Name: string
- supportCase: supportCase
- timeRemaining Time Remaining: string
-
The Time Remaining field shows the estimated remaining amount of time for this task. Time remaining is calculated as follows: (Initial Time Budget - Actual Time) If you have entered a Current Time Budget to update your Initial Time Budget, then the time remaining for the task is calculated as: (Current Time Budget - Actual Time)
- timedEvent Timed Event: boolean
-
Check this box to schedule this task on the calendar of the person the task is assigned to. Enter the start and end times in the From and To fields. This time is scheduled on the calendar for the start date.
- timezone Time Zone: string
- title Title: string
-
Enter a name for this task. This name is the subject line of the e-mail sent to the assignee if you check the Send e-mail box. This title also appears to others if the Private Task box is not checked. The title shows on the Tasks list.
- transaction: nsResource
taskCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: task
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
task - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
taxAcct
This record is available as a beta record.
- country Country: string
- description Description: string
-
Enter a description for this account.
- disclaimer Control Accounts created on this page appear in your chart of accounts and general ledger reports as Other Current Liability accounts.: string
- externalId External ID: string
- id Internal ID: string
- isInactive Inactive: boolean
-
Check this box to inactivate this account. Inactive accounts do not show in lists on transactions and records.
- links Links: nsLink
-
nsLink - name Name: string
-
Enter a name for this account.
- nexus: string
- refName Reference Name: string
- taxAcctType: object
-
- id Internal identifier.: string purchase , sale
- refName Reference Name: string
taxAcctCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: taxAcct
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
taxAcct - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
taxGroup
This record is available as a beta record.
- city City: string
-
Enter the city where this tax should be applied. This value is used by NetSuite to automatically determine the correct tax when an order is entered or a customer places an order on your website.
- county County: string
-
Enter the county where this tax should be applied. This value is used by NetSuite to automatically determine the correct tax when an order is entered or a customer places an order on your website.
- defaultTaxCode: string
- description Description: string
-
Enter a description for this record.
- externalId External ID: string
- id Internal ID: string
- includeChildren Include Children: boolean
-
Check this box to apply the tax code to the children of the subsidiary that you selected in the Subsidiaries field. In the Subsidiaries field, colons separate parent subsidiaries (on the left) from their children (on the right).
- isDefault Default Code: boolean
-
Check this box if this code is the default tax group selected on transactions. This tax code is selected if the customer's shipping address does not match another tax group.
- isInactive Inactive: boolean
-
Check this box to inactivate this record. Inactive records do not show on transactions and records for selection in lists.
- itemId Name: string
-
Enter a name for this tax code. You select this name on transactions.
- itemType: string
- links Links: nsLink
-
nsLink - message To select Tax Groups on transactions you must go to Setup > Accounting > Set Up Taxes and set the <b>Tax Code Lists Include</b> preference to <b>Tax Groups Only</b> or <b>Tax Groups And Tax Codes</b>.: string
- nexusCountry Country: string
- piggyBack Piggy Back: boolean
-
Check this box if you want this tax code to include GST in addition to the line item amount when calculating PST. If you do not check this box, PST is calculated for the line item amount only.
- rate Rate: number (double)
-
Enter the appropriate tax rate as a percentage. Example: 8% This percentage will be calculated when you select this tax item on transactions.
- refName Reference Name: string
- state: nsResource
- subsidiary: subsidiaryCollection
- taxItem: taxGroup-taxItemCollection
- taxItem1: salesTaxItem
- taxItem2: salesTaxItem
- taxType: taxType
- unitPrice1 Rate: number (double)
-
The tax rate for the GST item is shown here.
- unitPrice2 Rate: number (double)
-
The rate for the PST item is shown here.
- zip Zip Codes: string
-
Enter the zip codes where this tax should be applied. Separate each zip code with a comma. This value is used by NetSuite to automatically determine the correct tax when an order is entered or a customer places an order on your website.
taxGroup-taxItemCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: taxGroup-taxItemElement
-
taxGroup-taxItemElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
taxGroup-taxItemElement
This record is available as a beta record.
- basis Basis: number (float)
- city: string
- county: string
- links Links: nsLink
-
nsLink - rate Rate: number (double)
- refName Reference Name: string
- state: string
- taxItemNKey: integer (int64)
- taxName: salesTaxItem
- taxName2: string
- taxType Type: string
taxGroupCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: taxGroup
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
taxGroup - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
taxPeriod
This record is available as a beta record.
- closed Closed: boolean
- endDate End Date: string (date)
-
Enter or select the end date of this period using the format dd.mm.yyyy.
- fiscalCalendar: nsResource
- fiscalCalendars: taxPeriod-fiscalCalendarsCollection
- id Internal ID: string
- isAdjust Period is Adjustment: boolean
- isInactive Inactive: boolean
- isPosting Is Posting: boolean
-
Check this box to enable NetSuite to post tax to the period. If this box is not checked, make sure that the period has posting sub-periods.
- isQuarter Period is a Quarter: boolean
- isYear Period is a Year: boolean
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - parent: taxPeriod
- periodName Period Name: string
-
Enter this period's name.
- refName Reference Name: string
- startDate Start Date: string (date)
-
Enter or select the start date of this period using the format dd.mm.yyyy.
- userNotes: taxPeriod-userNotesCollection
taxPeriod-fiscalCalendarsCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: taxPeriod-fiscalCalendarsElement
-
taxPeriod-fiscalCalendarsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
taxPeriod-fiscalCalendarsElement
This record is available as a beta record.
- fiscalCalendar: nsResource
- links Links: nsLink
-
nsLink - parent: taxPeriod
- refName Reference Name: string
taxPeriod-userNotesCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: taxPeriod-userNotesElement
-
taxPeriod-userNotesElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
taxPeriodCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: taxPeriod
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
taxPeriod - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
taxType
This record is available as a beta record.
- country: object
-
- id Internal identifier.: string
- refName Reference Name: string
- description Description: string
-
Enter a description for this record.
- doesNotAddToTotal Does Not Add to Transaction Total: boolean
-
Check this box for special tax types that do not impact the transaction total, such as withholding tax. Tax types with this property can be used on sales and purchase transactions.
- externalId External ID: string
- id Internal ID: string
- isInactive Inactive: boolean
-
Check this box to inactivate this record. Inactive records do not show on transactions and records for selection in lists.
- links Links: nsLink
-
nsLink - moss OSS: boolean
-
Check this box if your company is registered for the EU MOSS VAT scheme. VAT on B2C digital services is charged based on the customer’s country. The MOSS tax type tracks it separately from normal VAT.
- name Name: string
-
Enter a name for this record.
- nexusAccounts: taxType-nexusAccountsCollection
- nexusesTax: taxType-nexusesTaxCollection
- postToItemCost Post to Item Cost: boolean
-
Check this box if the tax amounts for the tax type should be added to the related item cost. Tax types with this property can be used on purchase transactions only.
- refName Reference Name: string
- reverseCharge Reverse Charge: boolean
-
Check this box if reverse charge applies to transactions that have this tax type. Tax types with this property can be used on purchase transactions only.
- taxInNetAmount Tax Included in Net Amount: boolean
-
Check this box for special tax types where the tax amount is included in the item price. Tax types with this property can be used on sales and purchase transactions.
- taxType Tax Type: string
taxType-nexusAccountsCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: taxType-nexusAccountsElement
-
taxType-nexusAccountsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
taxType-nexusesTaxCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: taxType-nexusesTaxElement
-
taxType-nexusesTaxElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
taxTypeCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: taxType
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
taxType - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
term
This record is available as a beta record.
- dateDriven: object
-
- id Internal identifier.: string
- refName Reference Name: string
- dayDiscountExpires Day Discount Expires: integer (int64)
-
If you offer a discount for early payment under date driven terms, enter the last day of the month the early payment discount is available. For example, if the early payment discount is available through the 20th of each month, enter 20 in this field.
- dayOfMonthNetDue Day Of Month Net Due: integer (int64)
-
For date driven terms, enter the day of the month when the net amount of the invoice is due. If you enter a date that does not exist in the month the transaction is due, the last day of the month becomes the due date.
- daysUntilExpiry Days Till Discount Expires: integer (int64)
-
For standard terms, enter the number of days the early payment discount is available. For example, if the early payment discount is available for 15 days after the bill is issued, enter 15 in this field.
- daysUntilNetDue Days Till Net Due: integer (int64)
-
Enter the number of days until the net amount of the bill becomes due. For example, if you are creating a term of Net 30, enter 30 in this field.
- discountPercent % Discount: number (float)
-
For standard terms, enter the percentage discount if the invoice is paid early.
- discountPercentDateDriven Date Driven % Discount: number (float)
-
For date driven terms, enter the percentage discount if the invoice is paid early.
- dueNextMonthIfWithinDays Due Next Month If Within Days: integer (int64)
-
For date driven terms, enter the number of days before the due date that the invoice can be postponed until the next month's due date. For example, if invoices are due on the 30th of each month and you enter 5 in this field, then invoices issued between the 25th and 30th are due for payment by the 30th of the following month. For another example, Day of Month Net Due = 15 and Due Next Month if Within Days = 30 Date range within 30 days: 5/16-6/14 move to 7/15 6/15-7/15 move to 8/15 8/16-9/14 move to 10/15 9/15-10/15 move to 11/15 10/16-11/14 move to 12/15 11/15-12/15 move to 1/5
- externalId External ID: string
- id Internal ID: string
- installment Installment: boolean
-
Check the Installment box to use the Installment payment term. Installments are set payments made over a specified amount of time. Any shipping and tax due are included in the first installment. The remaining balance is divided over equal payments.
- isInactive Inactive: boolean
-
Check this box to remove all references to this record from your account. You can reactivate the record at any time.
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - longitemtype: string
- name Terms: string
-
Enter the name for this record. This name appears in lists that include this record.
- payTaxUpfront Pay Tax Upfront: boolean
- percentages: term-percentagesCollection
- preferred Preferred: boolean
-
Check this box to make this term or message show by default on sales transactions you create. Note: Terms set on customer records override terms marked as preferred.
- recurrenceCount Recurrence Count: integer (int64)
-
Enter the number of payments. For example, 3.
- recurrenceFrequency: object
-
- refName Reference Name: string
- repeatEvery Repeat Every: integer (int64)
-
Indicate the repeat interval of payments. For example, if the payment occurs once every month, enter 1. If you selected Annual for the Recurrence Frequency and payments are biannual, enter 2.
- splitEvenly Split Evenly: boolean
-
Check this box to split payments evenly across all payments. Note that the first payment will also include any tax and shipping charges in addition to the evenly divided payment.
- tname: string
term-percentagesCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: term-percentagesElement
-
term-percentagesElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
termCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: term
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
term - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
timeBill
- approvalStatus: object
-
- id Internal identifier.: string
- refName Reference Name: string
- billingClass: billingClass
- billingSubsidiary: subsidiary
- caseTaskEvent: nsResource
- class: classification
- customForm: object
-
- id Internal identifier.: string -10400
- refName Reference Name: string
- customer: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- department: department
- displayField Time Tracking: string
- employee: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- externalId External ID: string
- hours Duration: string
-
If you filled in the Start Time, End Time and Break fields, NetSuite automatically fills in the Duration field for you. If you didn't fill in these fields, enter the total time worked in hours and minutes. If you want to time yourself as you work, click the Timer link next to the Duration field.
- id Internal ID: string
- isBillable Billable: boolean
-
Check this box if the time you are entering can be billed.
- isExempt Exempt: boolean
- isProductive Productive: boolean
- isUtilized Utilized: boolean
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
-
If you want, enter a memo for this time transaction. If you are billing this time back to a customer or job, this memo appears as a description for this line item on the customer invoice.
- nextApprover: employee
- overrideRate Lock this Rate: boolean
-
If you're billing this time back to a customer, check this box to lock the rate you enter so it's not affected by rate changes that happen before the customer is billed. If you're entering time for a charge-based project and there are time-based charge rules, the rate is determined by the applied charge rule. Any rates entered on time records are discarded. If you are entering time for a payroll item like vacation time, leave this field blank.
- paidExternally Paid Externally: boolean
-
Check this box to designate that this time will be or has been paid to the employee outside of NetSuite. This removes the time entry from NetSuite payroll lists and transactions but still keeps the time available for billing back to the customer.
- payrollItem: payrollItem
- payrollWorkplace: workplace
- posted Posted: boolean
-
Check this box to manually mark this time transaction as posted. This transaction is no longer available for posting and it appears on the Void Time page. Manually checking the Posted box on a time transaction does not create a corresponding journal entry. Voiding a manually checked time transaction clears the Posted box.
- price: priceLevel
- rate Rate: number (double)
-
If you selected a price in the Price Level field, it automatically appears here. If you don't use multiple prices or if you selected Custom in the Price Level field, enter a rate for this time transaction. If you're entering time for a payroll item like vacation time, leave this field blank. If you're entering time for a charge-based project and there are time-based charge rules, any rate entered in this field will be overridden by the applied charge rule.
- refName Reference Name: string
- rejectionNote Rejection Note: string
-
If you are rejecting this time entry, enter a rejection note for this time entry. Rejection notes are used to explain why an entry was rejected.
- subsidiary: subsidiary
- supervisorApproval Supervisor Approval: boolean
-
Check this box if you have authority as a supervisor to approve this time entry.
- timeModified Time Modified: boolean
- timeOffType: nsResource
- timeType: object
-
- id Internal identifier.: string P , A , B
- refName Reference Name: string
- timesheet: timeSheet
- tranDate Date: string (date)
-
NetSuite inserts today's date as the date of this transaction. You can type or pick another date.
timeBillCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: timeBill
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
timeBill - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
timeEntry
This record is available as a beta record.
- approvalStatus: object
-
- id Internal identifier.: string
- refName Reference Name: string
- billingClass: billingClass
- caseTaskEvent: nsResource
- class: classification
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- customer: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- day Date: string (date)
-
Select a date for this time entry.
- dayNum: integer (int64)
- dayOfWeek: string
- department: department
- displayField Time Tracking: string
- employee: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- externalId External ID: string
- hours Duration: string
-
If you filled in the Start Time, End Time and Break fields, NetSuite automatically fills in the Duration field for you. If you didn't fill in these fields, enter the total time worked in hours and minutes. If you want to time yourself as you work, click the Timer link next to the Duration field.
- id Internal ID: string
- isBillable Billable: boolean
-
Check this box if the time you are entering can be billed.
- isExempt Exempt: boolean
- isProductive Productive: boolean
- isUtilized Utilized: boolean
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
-
If you want, enter a memo for this time transaction. If you are billing this time back to a customer or job, this memo appears as a description for this line item on the customer invoice.
- nextApprover: employee
- overrideRate Lock this Rate: boolean
-
If you're billing this time back to a customer, check this box to lock the rate you enter so it's not affected by rate changes that happen before the customer is billed. If you're entering time for a charge-based project and there are time-based charge rules, the rate is determined by the applied charge rule. Any rates entered on time records are discarded. If you are entering time for a payroll item like vacation time, leave this field blank.
- paidExternally Paid Externally: boolean
-
Check this box to designate that this time will be or has been paid to the employee outside of NetSuite. This removes the time entry from NetSuite payroll lists and transactions but still keeps the time available for billing back to the customer.
- payrollItem: payrollItem
- payrollWorkplace: workplace
- posted Posted: boolean
-
Check this box to manually mark this time transaction as posted. This transaction is no longer available for posting and it appears on the Void Time page. Manually checking the Posted box on a time transaction does not create a corresponding journal entry. Voiding a manually checked time transaction clears the Posted box.
- price: priceLevel
- rate Rate: number (double)
-
If you selected a price in the Price Level field, it automatically appears here. If you don't use multiple prices or if you selected Custom in the Price Level field, enter a rate for this time transaction. If you're entering time for a payroll item like vacation time, leave this field blank. If you're entering time for a charge-based project and there are time-based charge rules, any rate entered in this field will be overridden by the applied charge rule.
- refName Reference Name: string
- subsidiary: subsidiary
- supervisorApproval Supervisor Approval: boolean
- timeType: object
-
- id Internal identifier.: string P , A , B
- refName Reference Name: string
- timesheet: timeSheet
timeEntryCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: timeEntry
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
timeEntry - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
timeSheet
This record is available as a beta record.
- allocatedhours Allocated Hours: string
- approvalStatus: object
-
- id Internal identifier.: string
- refName Reference Name: string
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- employee: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- endDate End Date: string (date)
- externalId External ID: string
- hassupervisor: boolean
- hoursTotal Total Hours: string
-
The total hours entered for this week appears here.
- id Internal ID: string
- links Links: nsLink
-
nsLink - lockstatus: object
-
- id Internal identifier.: string unlocked , locked , partially
- refName Reference Name: string
- name Name: string
- plannedhours Planned Hours: string
- refName Reference Name: string
- rejectedhours Rejected Hours: string
- startDate Start Date: string (date)
-
NetSuite displays the start date for the current timesheet.
- submittedhours Submitted hours: string
- subsidiary Subsidiary: string
-
The subsidiary associated with the employee is displayed here.
- totalHours Total Hours: string
-
NetSuite displays the total hours entered on this timesheet. This field is updated in real time.
- tranDate Week Of: string (date)
-
NetSuite inserts today's date as the date of this transaction. You can type or pick another date.
- workcalendarhours Work Calendar Hours: string
timeSheetCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: timeSheet
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
timeSheet - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
topic
This record is available as a beta record.
- description Brief Description: string
-
Enter a description of this topic. This description shows in the topic list and also where it is published.
- externalId External ID: string
- id Internal ID: string
- isInactive Inactive: boolean
-
Check this box if you no longer want to use this record. Inactivating records removes them from lists and references everywhere in your account, but they are still available by clicking the Show Inactives box on lists.
- links Links: nsLink
-
nsLink - longDescription Detailed Description: string
-
Enter the text of this solution or topic here. You can use Javascript, HTML and CRMDSK tags in this description. Click Preview to see how this solution will appear when published.
- parentTopic: topic
- publish: topic-publishCollection
- refName Reference Name: string
- solution: solutionCollection
- title Title: string
-
Enter a title for this solution. Because solution titles can be searched, this title should be relative to the solution subject. This title shows on the Solutions subtab of the case and topic records that this solution is applied to and in published knowledge bases.
topic-publishCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: topic-publishElement
-
topic-publishElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
topicCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: topic
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
topic - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
transferOrder
This record is available as a beta record.
- accountingBookDetail: transferOrder-accountingBookDetailCollection
- altHandlingCost Handling Cost: number (double)
-
This field shows handling costs associated with this order.
- altShippingCost Shipping Cost: number (double)
-
This field displays shipping costs associated with this transfer order.
- canBeUnapproved Can Be Unapproved: boolean
- class: classification
- createdDate Date Created: string (date-time)
- createdFrom: nsResource
- currency: currency
- customForm: object
-
- id Internal identifier.: string -9943
- refName Reference Name: string
- department: department
- discountAmount Discount Amount: number (double)
- discountDate Discount Date: string (date)
- dueDate Due Date: string (date)
- employee: employee
- endDate End Date: string (date)
- exchangeRate Exchange Rate: number (double)
- excludefromsupplyplanning Exclude from Supply Planning: boolean
- externalId External ID: string
- firmed Firmed: boolean
-
When the Firmed box is checked, the line items are no longer eligible for reallocation to another order. The items must remain committed to the firmed order. Firmed transfer orders are not available to be rescheduled or cancelled.
- fob FOB: string
- handlingCost Handling Cost: number (double)
-
The handling cost automatically calculates depending on the shipping method you select in the Ship Via field. To change the cost of handling, go to Lists > Accounting > Shipping Items and select the shipping method with the handling cost you want to change.
- handlingTaxAmount Handling Tax Amount: number (double)
- hasMultiFulfillmentsToReceive: boolean
- icto: string
- id Internal ID: string
- incoTerm: nsResource
- isTransferPriceCosting: boolean
- isfobshipping: boolean
- item: transferOrder-itemCollection
- lastModifiedDate Date Last Modified: string (date-time)
- linkedTrackingNumbers Linked Tracking Numbers: string
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
-
Enter a memo to identify this transfer order. When you use the Search Transactions feature, you can search for specific words and phrases in the Memo field.
- needsPick: boolean
- nexus: nexus
- ordReceived Order Received: boolean
- orderStatus: object
-
- id Internal identifier.: string A , B
- refName Reference Name: string
- orderType: nsResource
- originator Originator: string
- otherRefNum PO/Check Number: string
- prevDate Previous Effective Date: string (date)
- refName Reference Name: string
- shipAddress Ship To: string
-
The Ship To Address of the transfer order defaults to the address of the destination location. To enter a different address: * Select another address in the Ship To Select field. * Select New in the Ship To Select field to enter a new billing address.
- shipAddressList: nsResource
- shipComplete Ship Complete: boolean
-
Check this box if you want to ship this order when there are enough items available to fully fulfill the orders. When fulfilling orders in bulk, you can filter the list to include those orders marked Ship Complete that can be completely fulfilled by selecting Respect Ship Complete in the Filter By field.
- shipDate Ship Date: string (date)
-
The date defaults to show the current date. You can type or pick another shipping date for this order.
- shipIsResidential Shipping address is residential: boolean
- shipMethod: shipItem
- shipOverride Override: boolean
- shippingAddress: transferOrder-shippingAddress
- shippingAddress_text Shipping Address: string
- shippingCost Shipping Cost: number (double)
-
The shipping cost automatically calculates depending on the shipping method you select in the Ship Via field above. To change the cost of a shipping method, go to Lists > Accounting > Shipping Items and select the shipping method you want to change. If you use UPS Real-Time rates and a package is over 150lbs, the package is charged as multiple packages equal to or less than 150lbs.
- shippingCostOverridden Shipping Cost Overridden: boolean
- shippingTaxAmount Shipping Tax Amount: number (double)
- source: object
-
- startDate Start Date: string (date)
- storeOrder: string
- subsidiary: subsidiary
- subtotal Subtotal: number (double)
-
As you add items, the total shows in this field.
- supplyPlanId: string
- supplyPlanLineId: string
- terms: term
- tosubsidiary: subsidiary
- total Total: number (double)
-
This field shows the total amount associated with this order, including shipping and handling costs.
- trackingNumbers Tracking Numbers: string
-
This field displays the tracking number provided by the carrier for the shipment.
- tranDate Date: string (date)
-
The current date autofills for this transfer order. You can select or enter a different date.
- tranId Transaction Number: string
-
Enter the number of this transfer order. If you use autogenerated numbering, the next order number in the sequence shows here. You can enter another number if you choose.
- transferlocation: location
- useItemCostAsTransferCost Use Item Cost As Transfer Cost: boolean
-
Check this box to use the transfer price as a declared shipping value for reference only. For example, for insurance or international shipping. * The transfer price is not a charge for the destination location. * The transfer price does not affect inventory costing on transactions. * The transfer price defaults to show the value in the Transfer Price field of item records. * Partial fulfillment and receipt of transfer orders is allowed, but you cannot receive more than you have fulfilled on any date. For example, if you have fulfilled 10 widgets out of 20 on a transfer order, you cannot receive 12 widgets on that order. Clear this box to use the transfer price shown on the transfer order as the item cost on the item receipt. Important: If no transfer price is entered on the transfer order, no cost is recorded on the item receipt. * Any difference between the actual cost and the transfer price posts to a Gain/Loss account when the item is shipped. * The transfer price and the Gain/Loss account are defined on each item record. * The transfer price defaults to show the value in the Transfer Price field of item records. If you use approval routing, this setting can be changed on a transfer order as long as the transfer order is not yet approved. Once the transfer order is approved, this setting cannot be changed.
- webSite: string
transferOrder-accountingBookDetailCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: transferOrder-accountingBookDetailElement
-
transferOrder-accountingBookDetailElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
transferOrder-accountingBookDetailElement
This record is available as a beta record.
- accountingBook: accountingBook
- exchangeRate Exchange Rate: number (double)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- revRecOnRevCommitment Rev Rec on Rev Commit.: boolean
- subsidiary: subsidiary
- tranIsVsoeBundle Transaction Is VSOE Bundle: boolean
transferOrder-item-inventoryDetail
This record is available as a beta record.
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- externalId External ID: string
- inventoryassignment: transferOrder-item-inventoryDetail-inventoryassignmentCollection
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemDescription Description: string
-
A more complete Description of the item.
- links Links: nsLink
-
nsLink - location: location
- quantity Quantity: number (float)
-
In the Quantity to Build field, enter the number of assembly items you want to build. You cannot enter a quantity that exceeds the amount displayed in the Buildable Quantity field.
- refName Reference Name: string
- toLocation: location
- unit Units: string
-
If the assembly uses Units of Measure, the base units are displayed in the Units field.
transferOrder-item-inventoryDetail-inventoryassignmentCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: transferOrder-item-inventoryDetail-inventoryassignmentElement
-
transferOrder-item-inventoryDetail-inventoryassignmentElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
transferOrder-item-inventoryDetail-inventoryassignmentElement
This record is available as a beta record.
- binNumber: bin
- expirationDate Expiration Date: string (date)
- internalId Internal ID: integer (int64)
- inventoryDetail Inventory Detail: integer (int64)
- inventoryStatus: inventoryStatus
- issueInventoryNumber: inventoryNumber
- links Links: nsLink
-
nsLink - packCarton Pack Carton: string
- pickCarton Pick Carton: string
- quantity Quantity: number (float)
- quantityAvailable Unpicked Bin Qty: number (float)
- receiptInventoryNumber Serial/Lot Number: string
- refName Reference Name: string
- secondaryQuantity Secondary Quantity: number (float)
- toBinNumber: bin
- toInventoryStatus: inventoryStatus
transferOrder-itemCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: transferOrder-itemElement
-
transferOrder-itemElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
transferOrder-itemElement
This record is available as a beta record.
- allocationAlert Reallocate Order Item: string
- amount Amount: number (double)
- billVarianceStatus: object
-
- id Internal identifier.: string NOVARIANCES , JOURNALNOTPOSTED , JOURNALPOSTED
- refName Reference Name: string
- class: classification
- commitInventory: object
-
- id Internal identifier.: string 1 , 2 , 3
- refName Reference Name: string
- commitmentFirm Commitment Confirmed: boolean
- costingMethod: string
- daysLate Days Late: integer (int64)
- department: department
- description Description: string
- excludeFromPredictiveRisk Exclude From Predictive Risk: boolean
- expectedShipDate Expected Ship Date: string (date)
- initOqpBucket Initial OQP Bucket: string
- inventoryDetail: transferOrder-item-inventoryDetail
- isClosed Closed: boolean
- isOpen Is Opened: boolean
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemSubtype: object
-
- id Internal identifier.: string Sale , Purchase , Resale
- refName Reference Name: string
- itemType: object
-
- licenseCode License Code: string
- line Transaction Line: integer (int64)
- linked Linked: boolean
- links Links: nsLink
-
nsLink - location: location
- marginal Marginal: boolean
- matrixType Matrix Type: string
- minQty Minimum Quantity: number (float)
- options Options: string
- oqpBucket Oqp Bucket: string
- orderAllocationStrategy: nsResource
- orderPriority Order Priority: number (float)
- printItems Print Items: boolean
- quantity Quantity: number (float)
- quantityAllocated Quantity Allocated: number (float)
- quantityAvailable Available: number (float)
- quantityBackOrdered Back Ordered: number (float)
- quantityCommitted Committed: number (float)
- quantityDemandAllocated Allocated Demand: number (float)
- quantityFulfilled <NULL>: number (float)
- quantityOnHand On Hand: number (float)
- quantityPacked Quantity Packed: number (float)
- quantityReceived <NULL>: number (float)
- rate Rate: number (double)
- rateIncludingTax Rate: number (double)
- rateSchedule Rate Schedule: string
- refName Reference Name: string
- requestedDate Requested Date: string (date)
- subsidiary: subsidiary
- units Units: string
transferOrder-shippingAddress
This record is available as a beta record.
- addr1 Address 1: string
-
Enter the address the way it should appear on forms. For employees, customers, partners, and vendors, what you enter here autofills on forms if this address is marked default for Shipping or Billing. Enter up to 50 characters. This field is required for the Online Bill Pay feature.
- addr2 Address 2: string
-
Enter an optional second address line the way it should appear on forms. For employees, customers, partners, and vendors, what you enter here autofills on forms if this address is marked default for Shipping or Billing. Enter up to 50 characters.
- addr3 Address 3: string
- addrPhone Phone: string
-
Enter the phone number.
- addrText Address: string
-
The values entered in the other address fields are displayed here.
- addressee Addressee: string
-
Enter the name of the entity that should appear on the shipping label here. This name appears on the shipping label below what you enter in the Attention field.
- attention Attention: string
-
Enter the name of the person to whom a shipment is addressed, as it should appear on shipping labels. This field is required for UPS Integration.
- city City: string
-
Enter the city the way it should appear on all forms except checks.
- country: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- externalId External ID: string
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - override Override: boolean
-
Check this box to disable the free-form address text field. When this field is disabled, text entered in the other address fields does not display in the Address text field. Clear this box to allow text entered in the address component fields to appear in the free-form address text field.
- refName Reference Name: string
- state State/Province: string
-
Enter your company's state or province the way it should appear on all forms except checks.
- zip Zip: string
-
Enter the postal code the way it should appear on all forms except checks.
transferOrderCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: transferOrder
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
transferOrder - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
unitsType
This record is available as a beta record.
- externalId External ID: string
- id Internal ID: string
- inUseBySerial: boolean
- isInactive Inactive: boolean
-
Check this box to inactivate this unit record. When a record is inactive, it does not appear in lists and cannot be selected on records and transactions.
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - name Type Name: string
-
Enter a name for the type of units you are creating. For example, enter "Length" to create units of Inch, Foot and Yard.
- refName Reference Name: string
- uom: unitsType-uomCollection
unitsType-uomCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: unitsType-uomElement
-
unitsType-uomElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
unitsType-uomElement
This record is available as a beta record.
- abbreviation Abbreviation: string
- baseUnit Base Unit: boolean
- conversionRate Conversion Rate {1}: number (float)
- inUse: boolean
- internalId Internal ID: integer (int64)
- links Links: nsLink
-
nsLink - pluralAbbreviation Plural Abbreviation: string
- pluralName Plural Name: string
- refName Reference Name: string
- unitName Name: string
unitsTypeCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: unitsType
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
unitsType - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
usage
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- customer: customer
- externalId External ID: string
- id Internal ID: string
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- links Links: nsLink
-
nsLink - memo Memo: string
- refName Reference Name: string
- status: object
-
- id Internal identifier.: string ACTIVE , VOIDED
- refName Reference Name: string
- subscriptionPlan: subscriptionPlan
- usageDate Date: string (date)
- usageQuantity Quantity: number (float)
- usageSubscription: subscription
- usageSubscriptionLine: subscriptionLine
usageCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: usage
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
usage - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
vendor
- accountNumber Account Number: string
-
If your vendors assign account numbers to you, enter one here. This number will later appear in these places: * In the Vendor # field on purchase orders * In the Memo field on checks
- addressBook: vendor-addressBookCollection
- altEmail Alt. Email: string
- altPhone Alt. Phone: string
-
Enter an optional alternate phone number for this record. Phone numbers can be entered in the following formats:999-999-9999, 1-999-999-9999, (999) 999-9999, 1(999) 999-9999 or 999-999-9999 ext 9999 .
- autoName Auto: boolean
-
Clear this box to manually enter a name for this record. If you leave this box marked, NetSuite assigns a name or number for this record based on your settings at Setup > Company > Auto-Generated Numbers.
- balance Balance (Base): number (double)
-
The vendor's current accounts payable balance due appears here.
- balancePrimary Balance: number (double)
-
This is a read-only calculated field that returns the vendor's current accounts payable balance in the specified currency.
- billingClass: billingClass
- campaigns: vendor-campaignsCollection
- category: vendorCategory
- comments Comments: string
-
Enter any other information you wish to track for this vendor.
- companyName Company Name: string
-
In the Company name field, enter the supplier's legal name. If you use Auto-Generated Numbering, you should enter the vendor name here to ensure that it appears along with the code in lists.
- contact: contact
- contactList: contactCollection
- creditLimit Credit Limit: number (double)
-
Enter an optional credit limit for your purchases from this vendor. If you have a NetSuite OneWorld account, enter the global credit limit for this vendor and any assigned subsidiary. This value can exceed the sum of the vendor and subsidiary credit limits. This credit limit sets a maximum currency amount that should be spent using credit without making a payment. The value displays in the vendor’s primary currency. The default is no value, or no credit limit. You can place the vendor on hold by entering 0 (zero.) Any new purchase order or vendor bill transaction displays a warning message. You cannot enter a negative value. NetSuite validates the transaction amounts on purchase orders and vendor bills against the global credit limit specified in the Credit Limit field. NetSuite does not include individual subsidiary credit limits in the global credit limit validation.
- currency: currency
- currencyList: vendor-currencyListCollection
- customForm: object
-
- id Internal identifier.: string -10021 , -10020
- refName Reference Name: string
- dateCreated Date Created: string (date-time)
-
The date this record was created displays here.
- defaultAddress Default Address: string
-
This field automatically shows the default billing address that you enter and add using the Address subtab.
- defaultBankAccount: account
- defaultShippingAddress Default Shipping Address: string
- defaultTaxReg Default Tax Reg. Number: string
-
Select the default tax registration number for this entity.
- defaultVendorPaymentAccount: account
- email Vendor Email: string
-
Enter the e-mail address of your vendor. If you allow your vendors online access, this becomes part of their access code.
- emailPreference: object
-
- id Internal identifier.: string PDF , HTML , DEFAULT
- refName Reference Name: string
- emailTransactions Email Transactions: boolean
-
Set a preferred transaction delivery method for this vendor. Choose to send transactions by regular mail, by email, by fax, or by a combination of the three. Then, when you select the vendor on a transaction, their preferred delivery method is marked by default. * Email – Check this box to check the To Be Emailed box by default on transactions when this vendor is selected. * Print – Check this box to check the To Be Printed box by default on transactions when this vendor is selected. * Fax – Check this box to check the To Be Faxed box by default on transactions when this vendor is selected. Once you enter these settings on the vendor record, these boxes are checked by default for transactions created from the vendor record or for transactions that are copied or converted. Note: These settings override any customized settings on transaction forms you use. There are also preferences to set default values for new vendor records at Setup > Company > Printing, Fax and Email Preferences. On the Print subtab, Fax subtab, or Email subtab, check Vendors Default to [Print/Fax/Email] Transactions. You can also set these fields using the Mass Update function. Go to Lists > Mass Update > Mass Updates > General and click Vendor.
- entityId Entity ID: string
-
In the Supplier ID field, enter your supplier's name as it should appear in all lists. If you use Auto-Generated Numbering, this field fills with the vendor number or code.
- expenseAccount: account
- externalId External ID: string
- fax Fax: string
-
Enter a fax number for this record. You should enter the fax number exactly as it must be dialed. If a '1' is required to fax to this number, be sure to include it at the beginning of the number. The number you enter here automatically appears in the To Be Faxed field of transactions when you select this customer. To fax NetSuite forms, an administrator must first set up fax service at Setup > Company > Printing, Fax and Email Preferences.
- faxTransactions Fax Transactions: boolean
-
Set a preferred transaction delivery method for this vendor. Choose to send transactions by regular mail, by email, by fax, or by a combination of the three. Then, when you select the vendor on a transaction, their preferred delivery method is marked by default. * Email – Check this box to check the To Be Emailed box by default on transactions when this vendor is selected. * Print – Check this box to check the To Be Printed box by default on transactions when this vendor is selected. * Fax – Check this box to check the To Be Faxed box by default on transactions when this vendor is selected. Once you enter these settings on the vendor record, these boxes are checked by default for transactions created from the vendor record or for transactions that are copied or converted. Note: These settings override any customized settings on transaction forms you use. There are also preferences to set default values for new vendor records at Setup > Company > Printing, Fax and Email Preferences. On the Print subtab, Fax subtab, or Email subtab, check Vendors Default to [Print/Fax/Email] Transactions. You can also set these fields using the Mass Update function. Go to Lists > Mass Update > Mass Updates > General and click Vendor.
- firstName First Name: string
-
Optionally enter a first name here.
- giveAccess Login Access: boolean
-
Check this box to give your vendor access to NetSuite. On the Roles subtab, assign a role to customize the level of access. You can assign multiple roles. To let your vendor view prior transactions and purchase orders, select the Vendor Center role.
- globalSubscriptionStatus: object
-
- id Internal identifier.: string 1 , 2 , 3 , 4
- refName Reference Name: string
- homePhone Home Phone: string
- id Internal ID: string
- image: nsResource
- incoterm: nsResource
- isAutogeneratedRepresentingEntity Is Autogenerated Representing Entity: boolean
-
This field indicates that this entity was automatically generated by NetSuite to represent a specific subsidiary.
- isInactive Vendor is Inactive: boolean
-
When you check this box, this vendor will no longer appear on a list unless you check the Show Inactives box at the bottom of the list page.
- isJobResourceVend Job Resource: boolean
-
Check this box to enable this vendor to be chosen as a resource on tasks and jobs. As a job resource, a vendor can be assigned to complete a task or to manage a project. Clear this box if you do not want this vendor assigned as a job resource. Note: If you use NetSuite OneWorld, you cannot share a vendor with multiple subsidiaries and define the vendor as a resource on tasks and jobs.
- isPerson Is Individual: boolean
-
Next to Type, select to identify the supplier as a Company or Individual.
- laborCost Labor Cost: number (double)
-
Enter the cost of labor for this vendor in order to be able to calculate profitability on jobs.
- laborcategory: nsResource
- lastModifiedDate Last Modified Date: string (date-time)
- lastName Last Name: string
-
Optionally enter a last name here.
- legalName Legal Name: string
-
Enter the legal name for this vendor for financial purposes. If you entered a name in the Company Name field, that name appears here.
- links Links: nsLink
-
nsLink - manufacturingLocations: locationCollection
- middleName Middle Name: string
- mobilePhone Mobile Phone: string
- openingBalance Opening Balance: number (double)
-
Enter the opening balance of your account with this vendor.
- openingBalanceAccount: account
- openingBalanceDate Opening Balance Date: string (date)
-
Enter the date of the balance entered in the Opening Balance field
- password Password: string
-
Assign a password to give this vendor access to NetSuite. The Password Criteria panel will help you ensure you create a password that meets the password policy in effect in your account. You will need to tell the user the password you assign. For more information, see the help topic NetSuite Password Requirements.
- password2 Confirm Password: string
-
Reenter the password in this field to verify that you entered the same password twice.
- payablesAccount: account
- phone Phone: string
-
Enter a phone number for your vendor. It will appear on the Vendor List report. This field is required for the Online Bill Pay feature.
- phoneticName Furigana: string
-
Enter the furigana character you want to use to sort this record.
- predConfidence Predicted Risk Confidence: number (double)
-
Enter the confidence you have that this vendor will provide the required material expressed as a percentage.
- predictedDays Predicted Days Late/Early: integer (int64)
-
Enter how late or early you expect this vendor to provide the required material in number of days. To indicate days early, enter a negative number.
- prepaymentBalance Prepayment Balance: number (double)
-
This field displays the total balance of prepayments made to this vendor that have not been applied to a bill payment yet.
- printOnCheckAs Print on Check As: string
-
What you enter here prints on the Pay to the Order of line of a check instead of what you entered in the Vendor field.
- printTransactions Print Transactions: boolean
-
Set a preferred transaction delivery method for this vendor. Choose to send transactions by regular mail, by email, by fax, or by a combination of the three. Then, when you select the vendor on a transaction, their preferred delivery method is marked by default. * Email – Check this box to check the To Be Emailed box by default on transactions when this vendor is selected. * Print – Check this box to check the To Be Printed box by default on transactions when this vendor is selected. * Fax – Check this box to check the To Be Faxed box by default on transactions when this vendor is selected. Once you enter these settings on the vendor record, these boxes are checked by default for transactions created from the vendor record or for transactions that are copied or converted. Note: These settings override any customized settings on transaction forms you use. There are also preferences to set default values for new vendor records at Setup > Company > Printing, Fax and Email Preferences. On the Print subtab, Fax subtab, or Email subtab, check Vendors Default to [Print/Fax/Email] Transactions. You can also set these fields using the Mass Update function. Go to Lists > Mass Update > Mass Updates > General and click Vendor.
- purchaseOrderAmount Vendor Bill - Purchase Order Amount Tolerance: number (float)
-
Enter the tolerance limit for the discrepancy between the amount on the vendor bill and purchase order.
- purchaseOrderQuantity Vendor Bill - Purchase Order Quantity Tolerance: number (float)
-
Enter the tolerance limit for the discrepancy between the quantity on the vendor bill and purchase order
- purchaseOrderQuantityDiff Vendor Bill - Purchase Order Quantity Difference: number (float)
-
Enter the difference limit for the discrepancy between the quantity on the vendor bill and purchase order.
- rate Hourly Rate: number (double)
- rates: vendor-ratesCollection
- receiptAmount Vendor Bill - Item Receipt Amount Tolerance: number (float)
-
Enter the tolerance limit for the discrepancy between the amount on the vendor bill and item receipt.
- receiptQuantity Vendor Bill - Item Receipt Quantity Tolerance: number (float)
-
Enter the tolerance limit for the discrepancy between the quantity on the vendor bill and item receipt.
- receiptQuantityDiff Vendor Bill - Item Receipt Quantity Difference: number (float)
-
Enter the difference limit for the discrepancy between the quantity on the vendor bill and item receipt.
- refName Reference Name: string
- representingSubsidiary: subsidiary
- requirePwdChange Require Password Change On Next Login: boolean
-
Check this box to require this user to change their password on their next login to NetSuite. When the user next logs in, they see the Change Password page and cannot access other NetSuite pages until a new password is created and saved. Requiring this action protects your account from unauthorized access using generic passwords and prepares your account for an audit. The Require Password Change on Next Login box never displays as checked. When you check this box and save the record, an internal flag is set. When the password change occurs, the flag is cleared. If you later check the box again and save the record, the internal flag is reset to require another password change.
- roles: vendor-rolesCollection
- salutation Mr./Ms...: string
- sendEmail Send New Access Notification Email: boolean
-
Check this box to automatically send an email notifying the vendor that you have given limited access to your NetSuite account. The standard NetSuite email message also contains a link to let the user create a password. If you do not check this box, you must check the Manually Assign or Change Password box. You must create the password, and tell the user the password, and when and how to log in. For security reasons, do not send the password by email.
- subscriptionMessageHistory: vendor-subscriptionMessageHistoryCollection
- subscriptions: vendor-subscriptionsCollection
- subsidiary: subsidiary
- subsidiaryEdition Edition: string
- taxRegistration: vendor-taxRegistrationCollection
- terms: term
- title Job Title: string
- unbilledOrders Unbilled Orders (Base): number (double)
-
This field displays the total amount of orders that have been entered but not yet billed. If you have enabled the preference Vendor Credit Limit Includes Orders, then this total is included in credit limit calculations. Set this preference at Setup > Accounting > Preferences > Accounting Preferences > General.
- unbilledOrdersPrimary Unbilled Orders: number (double)
-
This field displays the total amount of orders that have been entered but not yet billed in the specified currency.
- url URL: string
-
Enter a URL for this vendor's Web address. When you return to this record for viewing, this address is a link.
- workCalendar: nsResource
vendor-addressBook-addressBookAddress
- addr1 Address 1: string
- addr2 Address 2: string
- addr3 Address 3: string
- addrPhone Phone: string
- addrText Address: string
- addressee Addressee: string
- attention Attention: string
- city City: string
- country: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- externalId External ID: string
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - override Override: boolean
- refName Reference Name: string
- state State/Province: string
- zip Zip: string
vendor-addressBookCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: vendor-addressBookElement
-
vendor-addressBookElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
vendor-addressBookElement
- addressBookAddress: vendor-addressBook-addressBookAddress
- addressBookAddress_text Address: string
- addressId Internal ID: string
- defaultBilling Default Billing: boolean
- defaultShipping Default Shipping: boolean
- id ID: integer (int64)
- internalId Internal ID: integer (int64)
- label Label: string
- links Links: nsLink
-
nsLink - refName Reference Name: string
vendor-campaignsCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: vendor-campaignsElement
-
vendor-campaignsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
vendor-currencyListCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: vendor-currencyListElement
-
vendor-currencyListElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
vendor-ratesCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: vendor-ratesElement
-
vendor-ratesElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
vendor-rolesCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: vendor-rolesElement
-
vendor-rolesElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
vendor-rolesElement
- billingWarn <A href='/app/billing/billingterms.nl?user=T'>Charges may apply</a>: string
- centerType: string
- deviceidOnly: string
- links Links: nsLink
-
nsLink - refName Reference Name: string
- selectedRole: nsResource
- ssoOnly: string
- wsOnly: string
vendor-subscriptionMessageHistoryCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: vendor-subscriptionMessageHistoryElement
-
vendor-subscriptionMessageHistoryElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
vendor-subscriptionsCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: vendor-subscriptionsElement
-
vendor-subscriptionsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
vendor-subscriptionsElement
- lastModifiedDate Last Modified: string (date-time)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- subscribed Subscribed: boolean
- subscription: nsResource
vendor-taxRegistrationCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: vendor-taxRegistrationElement
-
vendor-taxRegistrationElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
vendor-taxRegistrationElement
- address Address: string
- id ID: integer (int64)
- links Links: nsLink
-
nsLink - nexus: nexus
- nexusCountry: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- nexusState: nsResource
- refName Reference Name: string
- taxRegistrationNumber Tax Reg. Number: string
vendorBill
- account: account
- accountingBookDetail: vendorBill-accountingBookDetailCollection
- appliedRules: vendorBill-appliedRulesCollection
- approvalStatus: object
-
- id Internal identifier.: string 11 , 1 , 2 , 3
- refName Reference Name: string
- availableVendorCredit Available Vendor Credit: number (double)
-
The Available Vendor Credit field displays the remaining credit available to this vendor before a payment is received. It is converted from vendor’s primary currency into the transaction currency. The field value is available only in edit mode. This field is visible after you customize the vendor bill. To display this field, enable accounts payable preferences: 1. Go to Setup >Accounting > Preferences > Accounting Preferences. 2. In the Accounts Payable section, check the Vendor Credit Limit Warnings and Vendor Credit Limit Includes Orders boxes. 3. Click Save. 4. In the vendor bill Customize menu, click Customize Form. 5. In the Screen Fields subtab, beside Available Vendor Credit, check the Show box. 6. Click Save. If the transaction exceeds the vendor’s credit limit, a warning message appears displaying the exceeded credit amount. The message does not prevent you from saving the transaction.
- balance Balance: number (double)
- billAddr1 Billing Address Line 1: string
- billAddr2 Billing Address Line 2: string
- billAddr3 Billing Address Line 3: string
- billAddress Bill To: string
-
In the Vendor Select field, choose a vendor. Verify the billing address displayed in the Vendor field.
- billAddressList: nsResource
- billAddressee Billing Addressee: string
- billAttention Billing Attention: string
- billCity Billing Address City: string
- billCountry: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- billOverride Override: string
- billPhone Billing Phone: string
- billState Billing Address State: string
- billZip Billing Address Zip Code: string
- billingAddress: vendorBill-billingAddress
- billingAddress_text Billing Address: string
- class: classification
- createdDate Date Created: string (date-time)
- creditLimit Credit Limit: number (double)
-
The credit limit you entered for your purchases from this vendor will appear here. To enter or change a credit limit, go to Lists > Relationships > Vendors. On the vendor record's Financial tab, enter the credit limit. NetSuite will warn you when you meet or exceed this vendor's limit while you are entering orders if you go to Home > Set Preferences and check the Credit Limit Warnings box.
- currency: currency
- customForm: object
-
- id Internal identifier.: string -9950
- refName Reference Name: string
- department: department
- discountAmount Discount Amount: number (double)
-
NetSuite enters the amount discounted on this bill. This discount is based on the purchase order terms. For example, if terms are set as 2%-10, Net 30 and the bill is paid within 10 days, a 2% discount is applied. If this discount item is taxable, the discount is applied before taxes. If it is not taxable, the discount is applied after taxes.
- discountDate Discount Date: string (date)
-
If your vendor offers discounts for early payments on bills, a calculated date based on the terms of the bill automatically shows up in this field. This date is the last day you can pay this bill in order to receive a discount.
- documentStatus Status: string
- dueDate Due Date: string (date)
-
NetSuite inserts today's date. You can type or pick another date. If you do not assign a due date, this bill will not appear on aging reports.
- endDate End Date: string (date)
- entity: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- entityTaxRegNum Vendor Tax Reg. Number: string
-
The tax registration number for this entity displays here.
- exchangeRate Exchange Rate: number (double)
-
The currency's exchange rate is shown in this field. You can edit the exchange rate for this transaction only, or you can update the currency record with the exchange rate you enter here.
- excludeFromGLNumbering Exclude from GL Audit Numbering: boolean
- expense: vendorBill-expenseCollection
- externalId External ID: string
- id Internal ID: string
- installment: vendorBill-installmentCollection
- intercoStatus: object
-
- id Internal identifier.: string 1 , 2 , 3
- refName Reference Name: string
- intercoTransaction: nsResource
- item: vendorBill-itemCollection
- landedCostMethod: object
-
- id Internal identifier.: string WEIGHT , QUANTITY , VALUE
- refName Reference Name: string
- lastModifiedDate Date Last Modified: string (date-time)
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
-
Enter a memo that will appear on such reports as the 2-line Accounts Payable Register.
- nextApprover: employee
- nexus: nexus
- overrideInstallments Override: boolean
-
Check this box to override the default calculated installment amounts and enter custom ones. Note that you must ensure that custom installment amounts must add up to the total amount due.
- paymentHold Payment Hold: boolean
-
Check the Payment Hold box to apply a payment hold on a disputed bill: * The Make Payment button does not appear on the vendor bill and a vendor payment for that bill cannot be processed. * Vendor bills subject to a payment hold do not appear on the bill payments page. * The Electronic Payment SuiteApp does not process payments that are subject to a payment hold.
- postingPeriod: accountingPeriod
- prevDate Previous Effective Date: string (date)
- received Received Bill: boolean
-
Place a check mark in this box if you have received a bill for this order. If you have received all the items on your order but have not checked this box, this transaction will now appear in your open bills report with no due date.
- refName Reference Name: string
- startDate Start Date: string (date)
- status: object
-
- id Internal identifier.: string A , B , C , D , E , F
- refName Reference Name: string
- subsidiary: subsidiary
- subsidiaryTaxRegNum Subsidiary Tax Reg. Number: string
-
This field shows the tax registration number of the transaction nexus. NetSuite automatically populates this field based on the nexus lookup logic. You can override the transaction nexus and tax registration number that NetSuite automatically selects by checking the Nexus Override box. When you select a different tax registration number in the dropdown list, the corresponding nexus is automatically selected in the Nexus field.
- taxDetails: vendorBill-taxDetailsCollection
- taxDetailsOverride Tax Details Override: boolean
-
Check this box to override the tax information on the Tax Details subtab of the transaction. Only roles with at least the Edit level of the Tax Details Tab permission can override the tax details.
- taxPointDate Tax Point Date: string (date)
-
Tax point date is a legal requirement in many countries. It is the date of the transaction that determines the taxability. It may be different from the transaction date that determines the GL impact. Specific rules consider the reporting of transactions based on tax point date and other factors.
- taxPointDateOverride Tax Point Date Override: boolean
-
Check this box to change the tax point date.
- taxRegOverride Tax Registration Override: boolean
-
Check this box to override the values in the Nexus and Subsidiary Tax Reg. Number fields. Only roles with at least the Edit level of the Tax Details Tab permission can override the values that NetSuite automatically selects in these fields.
- taxTotal Tax: number (double)
-
NetSuite multiplies the tax rate by the taxable total of line items and enters it here.
- terms: term
- toBePrinted To Be Printed: boolean
- total Amount: number (double)
- totalAfterTaxes Total After Taxes: number (double)
- tranDate Date: string (date)
-
NetSuite inserts today's date for the posting date of this bill. You can type or pick another date. What you enter here determines the date range in which this transaction appears on the Accounts Payable Register. You can select or enter custom date ranges on registers.
- tranId Reference No.: string
-
Enter additional information to identify this transaction, such as the vendor's invoice number. This reference appears on reports such as the Accounts Payable Register. Note: You can enter 45 Latin alphanumeric characters maximum in this field. Entries that use special characters, for example, characters from other languages, may support fewer than 45 characters.
- unbilledOrders Unbilled Orders: number (double)
- userTotal Amount: number (double)
-
You can enter the dollar amount of the bill, but NetSuite will update this amount as you add or edit line items.
vendorBill-accountingBookDetailCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: vendorBill-accountingBookDetailElement
-
vendorBill-accountingBookDetailElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
vendorBill-accountingBookDetailElement
- accountingBook: accountingBook
- exchangeRate Exchange Rate: number (double)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- revRecOnRevCommitment Rev Rec on Rev Commit.: boolean
- subsidiary: subsidiary
- tranIsVsoeBundle Transaction Is VSOE Bundle: boolean
vendorBill-appliedRulesCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: vendorBill-appliedRulesElement
-
vendorBill-appliedRulesElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
vendorBill-billingAddress
- addr1 Address 1: string
-
Enter the address the way it should appear on forms. For employees, customers, partners, and vendors, what you enter here autofills on forms if this address is marked default for Shipping or Billing. Enter up to 50 characters. This field is required for the Online Bill Pay feature.
- addr2 Address 2: string
-
Enter an optional second address line the way it should appear on forms. For employees, customers, partners, and vendors, what you enter here autofills on forms if this address is marked default for Shipping or Billing. Enter up to 50 characters.
- addr3 Address 3: string
- addrPhone Phone: string
-
Enter the phone number.
- addrText Address: string
-
The values entered in the other address fields are displayed here.
- addressee Addressee: string
-
Enter the name of the entity that should appear on the shipping label here. This name appears on the shipping label below what you enter in the Attention field.
- attention Attention: string
-
Enter the name of the person to whom a shipment is addressed, as it should appear on shipping labels. This field is required for UPS Integration.
- city City: string
-
Enter the city the way it should appear on all forms except checks.
- country: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- externalId External ID: string
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - override Override: boolean
-
Check this box to disable the free-form address text field. When this field is disabled, text entered in the other address fields does not display in the Address text field. Clear this box to allow text entered in the address component fields to appear in the free-form address text field.
- refName Reference Name: string
- state State/Province: string
-
Enter your company's state or province the way it should appear on all forms except checks.
- zip Zip: string
-
Enter the postal code the way it should appear on all forms except checks.
vendorBill-expenseCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: vendorBill-expenseElement
-
vendorBill-expenseElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
vendorBill-expenseElement
- account: account
- amortizStartDate Amortization Start Date: string (date)
- amortizationEndDate Amortization End Date: string (date)
- amortizationResidual Residual: string
- amortizationSched: amortizationSchedule
- amortizationType Type: string
- amount Amount: number (double)
- category: expenseCategory
- class: classification
- customer: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- department: department
- isBillable Billable: boolean
- line Line: integer (int64)
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
- orderDoc: string
- orderLine Order Line: string
- projecttask: projectTask
- refName Reference Name: string
- scheduleType Schedule Type: string
- taxAmount Tax Amount: number (double)
- taxDetailsReference Tax Details Reference: string
vendorBill-installmentCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: vendorBill-installmentElement
-
vendorBill-installmentElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
vendorBill-item-inventoryDetail
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- externalId External ID: string
- inventoryassignment: vendorBill-item-inventoryDetail-inventoryassignmentCollection
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemDescription Description: string
-
A more complete Description of the item.
- links Links: nsLink
-
nsLink - location: location
- quantity Quantity: number (float)
-
In the Quantity to Build field, enter the number of assembly items you want to build. You cannot enter a quantity that exceeds the amount displayed in the Buildable Quantity field.
- refName Reference Name: string
- toLocation: location
- unit Units: string
-
If the assembly uses Units of Measure, the base units are displayed in the Units field.
vendorBill-item-inventoryDetail-inventoryassignmentCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: vendorBill-item-inventoryDetail-inventoryassignmentElement
-
vendorBill-item-inventoryDetail-inventoryassignmentElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
vendorBill-item-inventoryDetail-inventoryassignmentElement
- binNumber: bin
- expirationDate Expiration Date: string (date)
- internalId Internal ID: integer (int64)
- inventoryDetail Inventory Detail: integer (int64)
- inventoryStatus: inventoryStatus
- issueInventoryNumber: inventoryNumber
- links Links: nsLink
-
nsLink - packCarton Pack Carton: string
- pickCarton Pick Carton: string
- quantity Quantity: number (float)
- quantityAvailable Unpicked Bin Qty: number (float)
- receiptInventoryNumber Serial/Lot Number: string
- refName Reference Name: string
- secondaryQuantity Secondary Quantity: number (float)
- toBinNumber: bin
- toInventoryStatus: inventoryStatus
vendorBill-itemCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: vendorBill-itemElement
-
vendorBill-itemElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
vendorBill-itemElement
- amortizStartDate Amortization Start Date: string (date)
- amortizationEndDate Amortization End Date: string (date)
- amortizationResidual Residual: string
- amortizationSched: amortizationSchedule
- amortizationType Type: string
- amount Amount: number (double)
- billReceipts: itemReceiptCollection
- billVarianceStatus: object
-
- id Internal identifier.: string NOVARIANCES , JOURNALNOTPOSTED , JOURNALPOSTED
- refName Reference Name: string
- catchUpPeriod: accountingPeriod
- class: classification
- customer: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- deferRevRec: boolean
- department: department
- description Description: string
- dueToFromSubsidiary: subsidiary
- initOqpBucket Initial OQP Bucket: string
- inventoryDetail: vendorBill-item-inventoryDetail
- isBillable Billable: boolean
- isCatchWeightItem: boolean
- isClosed Closed: boolean
- isOpen Is Opened: boolean
- isVsoeBundle Is VSOE Bundle: string
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemSubtype: object
-
- id Internal identifier.: string Sale , Purchase , Resale
- refName Reference Name: string
- itemType: object
-
- job: job
- landedCostCategory: costCategory
- licenseCode License Code: string
- line Transaction Line: integer (int64)
- linked Linked: boolean
- links Links: nsLink
-
nsLink - location: location
- marginal Marginal: boolean
- matrixType Matrix Type: string
- minQty Minimum Quantity: number (float)
- options Options: string
- oqpBucket Oqp Bucket: string
- orderDoc: nsResource
- orderLine Order Line: integer (int64)
- primaryToSecondaryUnitConversionRate: number (float)
- printItems Print Items: boolean
- projecttask: projectTask
- quantity Quantity: number (float)
- rate Rate: number (double)
- rateIncludingTax Rate: number (double)
- rateSchedule Rate Schedule: string
- refName Reference Name: string
- scheduleType Schedule Type: string
- secondaryQuantity Secondary Quantity: number (float)
- secondaryUnitConversionRate: number (float)
- secondaryUnits Secondary Units: string
- secondaryUnitsList: string
- subsidiary: subsidiary
- targetLocation: location
- taxAmount Tax Amount: number (double)
- taxDetailsReference Tax Details Reference: string
- units Units: string
- vendorName Vendor Name: string
vendorBill-taxDetailsCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: vendorBill-taxDetailsElement
-
vendorBill-taxDetailsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
vendorBill-taxDetailsElement
- calcDetail Details: string
- lineName Name: string
- lineType Line type: string
- links Links: nsLink
-
nsLink - netAmount Net Amount: number (double)
- refName Reference Name: string
- taxAmount Tax Amount: number (double)
- taxBasis Tax Basis: number (double)
- taxCode: salesTaxItem
- taxDetailsReference: object
-
- id Internal identifier.: string
- refName Reference Name: string
- taxRate Tax Rate: number (double)
- taxType Tax Type: string
vendorBillCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: vendorBill
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
vendorBill - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
vendorCategory
This record is available as a beta record.
- externalId External ID: string
- id Internal ID: string
- isInactive Inactive: boolean
-
Check this box to remove all references to this record from your account. You can reactivate the record at any time.
- isTaxAgency Tax Agency: boolean
-
You can set up tax agencies as vendors to initiate, record, and track tax payments. Select this check box if this vendor is a taxing agency.
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - longitemtype: string
- name Vendor: string
-
Enter the name for this record. This name appears in lists that include this record.
- refName Reference Name: string
- tname: string
vendorCategoryCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: vendorCategory
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
vendorCategory - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
vendorCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: vendor
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
vendor - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
vendorCredit
This record is available as a beta record.
- account: account
- accountingBookDetail: vendorCredit-accountingBookDetailCollection
- applied Applied: number (double)
-
NetSuite will update the Applied amount as you check bills on the Apply tab.
- appliedRules: vendorCredit-appliedRulesCollection
- apply: vendorCredit-applyCollection
- billAddr1 Billing Address Line 1: string
- billAddr2 Billing Address Line 2: string
- billAddr3 Billing Address Line 3: string
- billAddress Bill To: string
-
In the Vendor Select field, choose a vendor. Verify the billing address displayed in the Vendor field.
- billAddressList: nsResource
- billAddressee Billing Addressee: string
- billAttention Billing Attention: string
- billCity Billing Address City: string
- billCountry: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- billOverride Override: string
- billPhone Billing Phone: string
- billState Billing Address State: string
- billZip Billing Address Zip Code: string
- billingAddress: vendorCredit-billingAddress
- billingAddress_text Billing Address: string
- class: classification
- createdDate Date Created: string (date-time)
- createdFrom: nsResource
- currency: currency
- customForm: object
-
- id Internal identifier.: string -9952
- refName Reference Name: string
- department: department
- dueDate Due Date: string (date)
-
This field specifies a due date for the bill credit. You can use it to track due dates of bill credit at time of bill payment. The due date information is available in Bill Credit and Bill Payment pages, as well as saved searches, reports, and SuiteAnalytics workbooks.
- entity: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- entityTaxRegNum Vendor Tax Reg. Number: string
-
This field displays the selected vendor's tax registration number.
- exchangeRate Exchange Rate: number (double)
-
The currency's exchange rate is shown in this field. You can edit the exchange rate for this transaction only, or you can update the currency record with the exchange rate you enter here.
- excludeFromGLNumbering Exclude from GL Audit Numbering: boolean
- expense: vendorCredit-expenseCollection
- externalId External ID: string
- id Internal ID: string
- intercoStatus: object
-
- id Internal identifier.: string 1 , 2 , 3
- refName Reference Name: string
- intercoTransaction: nsResource
- item: vendorCredit-itemCollection
- lastModifiedDate Date Last Modified: string (date-time)
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
-
Enter a memo that will appear on such reports 2-line Accounts Payable Register.
- nexus: nexus
- postingPeriod: accountingPeriod
- prevDate Previous Effective Date: string (date)
- refName Reference Name: string
- subsidiary: subsidiary
- subsidiaryTaxRegNum Subsidiary Tax Reg. Number: string
-
This field shows the tax registration number of the transaction nexus. NetSuite automatically populates this field based on the nexus lookup logic. You can override the transaction nexus and tax registration number that NetSuite automatically selects by checking the Nexus Override box. When you select a different tax registration number in the dropdown list, the corresponding nexus is automatically selected in the Nexus field.
- taxDetails: vendorCredit-taxDetailsCollection
- taxDetailsOverride Tax Details Override: boolean
-
Check this box to override the tax information on the Tax Details subtab of the transaction. Only roles with at least the Edit level of the Tax Details Tab permission can override the tax details.
- taxPointDate Tax Point Date: string (date)
-
Tax point date is a legal requirement in many countries. It is the date of the transaction that determines the taxability. It may be different from the transaction date that determines the GL impact. Specific rules consider the reporting of transactions based on tax point date and other factors.
- taxPointDateOverride Tax Point Date Override: boolean
-
Check this box to override the tax point date.
- taxRegOverride Tax Registration Override: boolean
-
Check this box to override the values in the Nexus and Subsidiary Tax Reg. Number fields. Only roles with at least the Edit level of the Tax Details Tab permission can override the values that NetSuite automatically selects in these fields.
- taxTotal Tax: number (double)
-
Enter the Goods and Services tax.
- toBePrinted To Be Printed: boolean
- total Amount: number (double)
- totalAfterTaxes Total After Taxes: number (double)
- tranDate Date: string (date)
-
NetSuite inserts today's date for the posting date of this vendor credit. You can type or pick another date. What you enter here determines the date range in which this transaction appears on the Accounts Payable Register. You can select or enter custom date ranges on registers.
- tranId Reference No.: string
-
Enter up to 45 characters to identify this transaction, such as the vendor's invoice or credit number. This reference appears on reports such as the Accounts Payable Register.
- unapplied Unapplied: number (double)
-
NetSuite will update the Unapplied amount as you check bills on the Apply tab.
- userTotal Amount: number (double)
-
You can enter the total amount of the transaction, but NetSuite will update this as you add or edit line items. The total amount cannot be negative.
vendorCredit-accountingBookDetailCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: vendorCredit-accountingBookDetailElement
-
vendorCredit-accountingBookDetailElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
vendorCredit-accountingBookDetailElement
This record is available as a beta record.
- accountingBook: accountingBook
- exchangeRate Exchange Rate: number (double)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- revRecOnRevCommitment Rev Rec on Rev Commit.: boolean
- subsidiary: subsidiary
- tranIsVsoeBundle Transaction Is VSOE Bundle: boolean
vendorCredit-appliedRulesCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: vendorCredit-appliedRulesElement
-
vendorCredit-appliedRulesElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
vendorCredit-applyCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: vendorCredit-applyElement
-
vendorCredit-applyElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
vendorCredit-applyElement
This record is available as a beta record.
- amount Payment: number (double)
- apply Apply: boolean
- applyDate Date: string (date)
- createdFrom: string
- currency Currency: string
- doc: nsResource
- due Amt. Due: number (double)
- jobName Subcustomer: string
- line: integer (int64)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- refNum Ref No.: string
- total Orig. Amt.: number (double)
- type Type: string
vendorCredit-billingAddress
This record is available as a beta record.
- addr1 Address 1: string
-
Enter the address the way it should appear on forms. For employees, customers, partners, and vendors, what you enter here autofills on forms if this address is marked default for Shipping or Billing. Enter up to 50 characters. This field is required for the Online Bill Pay feature.
- addr2 Address 2: string
-
Enter an optional second address line the way it should appear on forms. For employees, customers, partners, and vendors, what you enter here autofills on forms if this address is marked default for Shipping or Billing. Enter up to 50 characters.
- addr3 Address 3: string
- addrPhone Phone: string
-
Enter the phone number.
- addrText Address: string
-
The values entered in the other address fields are displayed here.
- addressee Addressee: string
-
Enter the name of the entity that should appear on the shipping label here. This name appears on the shipping label below what you enter in the Attention field.
- attention Attention: string
-
Enter the name of the person to whom a shipment is addressed, as it should appear on shipping labels. This field is required for UPS Integration.
- city City: string
-
Enter the city the way it should appear on all forms except checks.
- country: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- externalId External ID: string
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - override Override: boolean
-
Check this box to disable the free-form address text field. When this field is disabled, text entered in the other address fields does not display in the Address text field. Clear this box to allow text entered in the address component fields to appear in the free-form address text field.
- refName Reference Name: string
- state State/Province: string
-
Enter your company's state or province the way it should appear on all forms except checks.
- zip Zip: string
-
Enter the postal code the way it should appear on all forms except checks.
vendorCredit-expenseCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: vendorCredit-expenseElement
-
vendorCredit-expenseElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
vendorCredit-expenseElement
This record is available as a beta record.
- account: account
- amortizStartDate Amortization Start Date: string (date)
- amortizationEndDate Amortization End Date: string (date)
- amortizationResidual Residual: string
- amortizationSched: amortizationSchedule
- amortizationType Type: string
- amount Amount: number (double)
- category: expenseCategory
- class: classification
- customer: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- department: department
- isBillable Billable: boolean
- line Line: integer (int64)
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
- orderDoc: string
- orderLine Order Line: string
- projecttask: projectTask
- refName Reference Name: string
- scheduleType Schedule Type: string
- taxAmount Tax Amount: number (double)
- taxDetailsReference Tax Details Reference: string
vendorCredit-item-inventoryDetail
This record is available as a beta record.
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- externalId External ID: string
- inventoryassignment: vendorCredit-item-inventoryDetail-inventoryassignmentCollection
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemDescription Description: string
-
A more complete Description of the item.
- links Links: nsLink
-
nsLink - location: location
- quantity Quantity: number (float)
-
In the Quantity to Build field, enter the number of assembly items you want to build. You cannot enter a quantity that exceeds the amount displayed in the Buildable Quantity field.
- refName Reference Name: string
- toLocation: location
- unit Units: string
-
If the assembly uses Units of Measure, the base units are displayed in the Units field.
vendorCredit-item-inventoryDetail-inventoryassignmentCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: vendorCredit-item-inventoryDetail-inventoryassignmentElement
-
vendorCredit-item-inventoryDetail-inventoryassignmentElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
vendorCredit-item-inventoryDetail-inventoryassignmentElement
This record is available as a beta record.
- binNumber: bin
- expirationDate Expiration Date: string (date)
- internalId Internal ID: integer (int64)
- inventoryDetail Inventory Detail: integer (int64)
- inventoryStatus: inventoryStatus
- issueInventoryNumber: inventoryNumber
- links Links: nsLink
-
nsLink - packCarton Pack Carton: string
- pickCarton Pick Carton: string
- quantity Quantity: number (float)
- quantityAvailable Unpicked Bin Qty: number (float)
- receiptInventoryNumber Serial/Lot Number: string
- refName Reference Name: string
- secondaryQuantity Secondary Quantity: number (float)
- toBinNumber: bin
- toInventoryStatus: inventoryStatus
vendorCredit-itemCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: vendorCredit-itemElement
-
vendorCredit-itemElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
vendorCredit-itemElement
This record is available as a beta record.
- amortizStartDate Amortization Start Date: string (date)
- amortizationEndDate Amortization End Date: string (date)
- amortizationResidual Residual: string
- amortizationSched: amortizationSchedule
- amortizationType Type: string
- amount Amount: number (double)
- billVarianceStatus: object
-
- id Internal identifier.: string NOVARIANCES , JOURNALNOTPOSTED , JOURNALPOSTED
- refName Reference Name: string
- catchUpPeriod: accountingPeriod
- class: classification
- customer: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- deferRevRec: boolean
- department: department
- description Description: string
- dueToFromSubsidiary: subsidiary
- initOqpBucket Initial OQP Bucket: string
- inventoryDetail: vendorCredit-item-inventoryDetail
- isBillable Billable: boolean
- isClosed Closed: boolean
- isOpen Is Opened: boolean
- isVsoeBundle Is VSOE Bundle: string
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemSubtype: object
-
- id Internal identifier.: string Sale , Purchase , Resale
- refName Reference Name: string
- itemType: object
-
- job: job
- licenseCode License Code: string
- line Transaction Line: integer (int64)
- linked Linked: boolean
- links Links: nsLink
-
nsLink - location: location
- marginal Marginal: boolean
- matrixType Matrix Type: string
- minQty Minimum Quantity: number (float)
- options Options: string
- oqpBucket Oqp Bucket: string
- orderDoc: nsResource
- orderLine Order Line: integer (int64)
- printItems Print Items: boolean
- projecttask: projectTask
- quantity Quantity: number (float)
- rate Rate: number (double)
- rateIncludingTax Rate: number (double)
- rateSchedule Rate Schedule: string
- refName Reference Name: string
- scheduleType Schedule Type: string
- subsidiary: subsidiary
- targetLocation: location
- taxAmount Tax Amount: number (double)
- taxDetailsReference Tax Details Reference: string
- units Units: string
- vendorName Vendor Name: string
vendorCredit-taxDetailsCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: vendorCredit-taxDetailsElement
-
vendorCredit-taxDetailsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
vendorCredit-taxDetailsElement
This record is available as a beta record.
- calcDetail Details: string
- lineName Name: string
- lineType Line type: string
- links Links: nsLink
-
nsLink - netAmount Net Amount: number (double)
- refName Reference Name: string
- taxAmount Tax Amount: number (double)
- taxBasis Tax Basis: number (double)
- taxCode: salesTaxItem
- taxDetailsReference: object
-
- id Internal identifier.: string
- refName Reference Name: string
- taxRate Tax Rate: number (double)
- taxType Tax Type: string
vendorCreditCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: vendorCredit
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
vendorCredit - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
vendorPayment
This record is available as a beta record.
- account: account
- accountingBookDetail: vendorPayment-accountingBookDetailCollection
- address Pay To: string
-
NetSuite inserts the mailing address of the vendor from the record at Lists > Relationships > Vendors. If you wish, you can change it here for just this transaction by typing up to 4 rows of information.
- apAcct: account
- apply: vendorPayment-applyCollection
- approvalStatus: object
-
- id Internal identifier.: string 11 , 1 , 2 , 3
- refName Reference Name: string
- availableBalance Available Balance: number (double)
-
The Available Balance is displayed for the selected account. The bank account available balance is calculated as follows: * Bank account balance - Sum of outstanding in-transit payments = Available balance
- balance Balance: number (double)
-
NetSuite shows you the balance in this bank account.
- billPay Bill Pay: boolean
-
Check this box to send this payment online. You must follow the set up procedure in How Do I Set Up Online Bill Pay before you can use this feature. The NetSuite basic package includes a set number of bill pay transactions. Click the Charges May Apply link for more information.
- class: classification
- cleared Cleared: boolean
- clearedDate Date Cleared: string (date)
- createdDate Date Created: string (date-time)
- credit: vendorPayment-creditCollection
- currency: currency
- customForm: object
-
- id Internal identifier.: string -9966 , -9955
- refName Reference Name: string
- department: department
- entity: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- exchangeRate Exchange Rate: number (double)
-
The currency's exchange rate is shown in this field. You can edit the exchange rate for this transaction only, or you can update the currency record with the exchange rate you enter here.
- excludeFromGLNumbering Exclude from GL Audit Numbering: boolean
- externalId External ID: string
- id Internal ID: string
- isInTransitPayment In Transit: boolean
-
Check the In Transit box to designate this vendor payment as an In-Transit Payment. This defaults based on the setting for the Use In-Transit Vendor Payments by Default preference. The In Transit box can be checked only when first creating a payment. After the payment form is saved, this setting cannot be changed. Clear this box if this vendor payment is not an In-Transit payment. The setting for this field cannot be changed after the form is saved.
- lastModifiedDate Date Last Modified: string (date-time)
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
-
Enter a memo that shows the vendor's invoice number or your account number. This appears on the memo line of the check.
- nextApprover: employee
- nexus: nexus
- payeeAddress: vendorPayment-payeeAddress
- payeeAddressList: nsResource
- payeeAddress_text Pay To: string
- postingPeriod: accountingPeriod
- prevDate Previous Effective Date: string (date)
- printVoucher Voucher: boolean
-
Check this box to queue a voucher to print for this payment. After you have entered payments, print vouchers for them at Transactions > Management > Print Checks and Forms > Payment Vouchers.
- refName Reference Name: string
- status: object
-
- id Internal identifier.: string A , B , C , D , E , V , F , Z
- refName Reference Name: string
- subsidiary: subsidiary
- toBeEmailed To Be Emailed: boolean
- toBePrinted To Be Printed: boolean
-
Check this box if you wish to save this in a queue of checks to print. You can also click Save & Print to print this at once.
- total Amount: number (double)
-
NetSuite will update this amount as you add or edit line items.
- tranDate Date: string (date)
-
NetSuite inserts today's date for the posting date of this bill payment. You can type or pick another date. What you enter here determines the date range in which this transaction appears on the Accounts Payable Register. You can select or enter custom date ranges on registers.
- tranId Check #: string
-
If you have clicked To Be Printed, you will choose starting check numbers later, when you print those checks. If you are submitting and immediately printing this check, NetSuite increases the largest check number by one. If you wish, you can type another number here, and the next check number will revert to the standard pattern.
- unapplied Unapplied: number (double)
- voidjournal: nsResource
vendorPayment-accountingBookDetailCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: vendorPayment-accountingBookDetailElement
-
vendorPayment-accountingBookDetailElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
vendorPayment-accountingBookDetailElement
This record is available as a beta record.
- accountingBook: accountingBook
- exchangeRate Exchange Rate: number (double)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- revRecOnRevCommitment Rev Rec on Rev Commit.: boolean
- subsidiary: subsidiary
- tranIsVsoeBundle Transaction Is VSOE Bundle: boolean
vendorPayment-applyCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: vendorPayment-applyElement
-
vendorPayment-applyElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
vendorPayment-applyElement
This record is available as a beta record.
- amount Payment: number (double)
- apply Apply: boolean
- applyDate Date: string (date)
- createdFrom: string
- currency Currency: string
- doc: nsResource
- due Amt. Due: number (double)
- jobName Subcustomer: string
- line: integer (int64)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- refNum Ref No.: string
- total Orig. Amt.: number (double)
- type Type: string
vendorPayment-creditCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: vendorPayment-creditElement
-
vendorPayment-creditElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
vendorPayment-creditElement
This record is available as a beta record.
- amount Payment: number (double)
- appliedTo Applied To: string
- apply Apply: boolean
- createdFrom: string
- creditDate Date: string (date)
- currency Currency: string
- doc: nsResource
- due Amt. Due: number (double)
- line: integer (int64)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- refNum Ref No.: string
- total Orig. Amt.: number (double)
- type Type: string
vendorPayment-payeeAddress
This record is available as a beta record.
- addr1 Address 1: string
- addr2 Address 2: string
- addr3 Address 3: string
- addrPhone Phone: string
- addrText Address: string
- addressee Addressee: string
- attention Attention: string
- city City: string
- country: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- externalId External ID: string
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - override Override: boolean
- refName Reference Name: string
- state State/Province: string
- zip Zip: string
vendorPaymentCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: vendorPayment
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
vendorPayment - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
vendorReturnAuthorization
This record is available as a beta record.
- accountingBookDetail: vendorReturnAuthorization-accountingBookDetailCollection
- billAddr1 Billing Address Line 1: string
- billAddr2 Billing Address Line 2: string
- billAddr3 Billing Address Line 3: string
- billAddress Bill To: string
-
In the Vendor Select field, choose a vendor. Verify the billing address displayed in the Vendor field.
- billAddressList: nsResource
- billAddressee Billing Addressee: string
- billAttention Billing Attention: string
- billCity Billing Address City: string
- billCountry: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- billOverride Override: string
- billPhone Billing Phone: string
- billState Billing Address State: string
- billZip Billing Address Zip Code: string
- billingAddress: vendorReturnAuthorization-billingAddress
- billingAddress_text Billing Address: string
- class: classification
- createdDate Date Created: string (date-time)
- createdFrom: nsResource
- currency: currency
- customForm: object
-
- id Internal identifier.: string -9956
- refName Reference Name: string
- department: department
- entity: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- entityTaxRegNum Vendor Tax Reg. Number: string
-
Select the vendor's tax registration number associated with this vendor return authorization.
- exchangeRate Exchange Rate: number (double)
-
The currency's exchange rate is shown in this field. You can edit the exchange rate for this transaction only, or you can update the currency record with the exchange rate you enter here.
- expense: vendorReturnAuthorization-expenseCollection
- externalId External ID: string
- id Internal ID: string
- intercoStatus: object
-
- id Internal identifier.: string 1 , 2 , 3
- refName Reference Name: string
- intercoTransaction: nsResource
- isCrossSubTransaction Cross-Subsidiary Transaction: boolean
- item: vendorReturnAuthorization-itemCollection
- lastModifiedDate Date Last Modified: string (date-time)
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
-
If you wish, enter a memo to describe this vendor return authorization. What you enter in this field will appear on reports.
- nexus: nexus
- orderStatus: object
-
- id Internal identifier.: string A , B
- refName Reference Name: string
- prevDate Previous Effective Date: string (date)
- refName Reference Name: string
- subsidiary: subsidiary
- subsidiaryTaxRegNum Subsidiary Tax Reg. Number: string
-
This field shows the tax registration number of the transaction nexus. NetSuite automatically populates this field based on the nexus lookup logic. You can override the transaction nexus and tax registration number that NetSuite automatically selects by checking the Nexus Override box. When you select a different tax registration number in the dropdown list, the corresponding nexus is automatically selected in the Nexus field.
- taxDetails: vendorReturnAuthorization-taxDetailsCollection
- taxDetailsOverride Tax Details Override: boolean
- taxPointDate Tax Point Date: string (date)
- taxPointDateOverride Tax Point Date Override: boolean
- taxRegOverride Tax Registration Override: boolean
- taxTotal Tax: number (double)
- total Amount: number (double)
- totalAfterTaxes Total After Taxes: number (double)
- tranDate Date: string (date)
-
Accept, enter, or select the date of this transaction.
- tranId Transaction Number: string
-
Optionally enter a number to refer to this return transaction. Typically, this is a number provided by the vendor once the return is approved. You can enter a maximum of 45 characters in this field.
- userTotal Amount: number (double)
-
The total currency amount of the line items you enter below shows in this field.
vendorReturnAuthorization-accountingBookDetailCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: vendorReturnAuthorization-accountingBookDetailElement
-
vendorReturnAuthorization-accountingBookDetailElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
vendorReturnAuthorization-accountingBookDetailElement
This record is available as a beta record.
- accountingBook: accountingBook
- exchangeRate Exchange Rate: number (double)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- revRecOnRevCommitment Rev Rec on Rev Commit.: boolean
- subsidiary: subsidiary
- tranIsVsoeBundle Transaction Is VSOE Bundle: boolean
vendorReturnAuthorization-billingAddress
This record is available as a beta record.
- addr1 Address 1: string
-
Enter the address the way it should appear on forms. For employees, customers, partners, and vendors, what you enter here autofills on forms if this address is marked default for Shipping or Billing. Enter up to 50 characters. This field is required for the Online Bill Pay feature.
- addr2 Address 2: string
-
Enter an optional second address line the way it should appear on forms. For employees, customers, partners, and vendors, what you enter here autofills on forms if this address is marked default for Shipping or Billing. Enter up to 50 characters.
- addr3 Address 3: string
- addrPhone Phone: string
-
Enter the phone number.
- addrText Address: string
-
The values entered in the other address fields are displayed here.
- addressee Addressee: string
-
Enter the name of the entity that should appear on the shipping label here. This name appears on the shipping label below what you enter in the Attention field.
- attention Attention: string
-
Enter the name of the person to whom a shipment is addressed, as it should appear on shipping labels. This field is required for UPS Integration.
- city City: string
-
Enter the city the way it should appear on all forms except checks.
- country: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- externalId External ID: string
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - override Override: boolean
-
Check this box to disable the free-form address text field. When this field is disabled, text entered in the other address fields does not display in the Address text field. Clear this box to allow text entered in the address component fields to appear in the free-form address text field.
- refName Reference Name: string
- state State/Province: string
-
Enter your company's state or province the way it should appear on all forms except checks.
- zip Zip: string
-
Enter the postal code the way it should appear on all forms except checks.
vendorReturnAuthorization-expenseCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: vendorReturnAuthorization-expenseElement
-
vendorReturnAuthorization-expenseElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
vendorReturnAuthorization-expenseElement
This record is available as a beta record.
- account: account
- amortizStartDate Amortization Start Date: string (date)
- amortizationEndDate Amortization End Date: string (date)
- amortizationResidual Residual: string
- amortizationSched: amortizationSchedule
- amortizationType Type: string
- amount Amount: number (double)
- category: expenseCategory
- class: classification
- customer: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- department: department
- isBillable Billable: boolean
- line Line: integer (int64)
- links Links: nsLink
-
nsLink - location: location
- memo Memo: string
- orderDoc: string
- orderLine Order Line: string
- projecttask: projectTask
- refName Reference Name: string
- scheduleType Schedule Type: string
- taxAmount Tax Amount: number (double)
- taxDetailsReference Tax Details Reference: string
vendorReturnAuthorization-item-inventoryDetail
This record is available as a beta record.
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- externalId External ID: string
- inventoryassignment: vendorReturnAuthorization-item-inventoryDetail-inventoryassignmentCollection
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemDescription Description: string
-
A more complete Description of the item.
- links Links: nsLink
-
nsLink - location: location
- quantity Quantity: number (float)
-
In the Quantity to Build field, enter the number of assembly items you want to build. You cannot enter a quantity that exceeds the amount displayed in the Buildable Quantity field.
- refName Reference Name: string
- toLocation: location
- unit Units: string
-
If the assembly uses Units of Measure, the base units are displayed in the Units field.
vendorReturnAuthorization-item-inventoryDetail-inventoryassignmentCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: vendorReturnAuthorization-item-inventoryDetail-inventoryassignmentElement
-
vendorReturnAuthorization-item-inventoryDetail-inventoryassignmentElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
vendorReturnAuthorization-item-inventoryDetail-inventoryassignmentElement
This record is available as a beta record.
- binNumber: bin
- expirationDate Expiration Date: string (date)
- internalId Internal ID: integer (int64)
- inventoryDetail Inventory Detail: integer (int64)
- inventoryStatus: inventoryStatus
- issueInventoryNumber: inventoryNumber
- links Links: nsLink
-
nsLink - packCarton Pack Carton: string
- pickCarton Pick Carton: string
- quantity Quantity: number (float)
- quantityAvailable Unpicked Bin Qty: number (float)
- receiptInventoryNumber Serial/Lot Number: string
- refName Reference Name: string
- secondaryQuantity Secondary Quantity: number (float)
- toBinNumber: bin
- toInventoryStatus: inventoryStatus
vendorReturnAuthorization-itemCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: vendorReturnAuthorization-itemElement
-
vendorReturnAuthorization-itemElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
vendorReturnAuthorization-itemElement
This record is available as a beta record.
- amortizStartDate Amortization Start Date: string (date)
- amortizationEndDate Amortization End Date: string (date)
- amortizationResidual Residual: string
- amortizationSched: amortizationSchedule
- amortizationType Type: string
- amount Amount: number (double)
- billVarianceStatus: object
-
- id Internal identifier.: string NOVARIANCES , JOURNALNOTPOSTED , JOURNALPOSTED
- refName Reference Name: string
- catchUpPeriod: accountingPeriod
- class: classification
- customer: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- deferRevRec: boolean
- department: department
- description Description: string
- initOqpBucket Initial OQP Bucket: string
- inventoryDetail: vendorReturnAuthorization-item-inventoryDetail
- isBillable Billable: boolean
- isClosed Closed: boolean
- isDropShipment Drop Shipment: boolean
- isOpen Is Opened: boolean
- isVsoeBundle Is VSOE Bundle: string
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemSubtype: object
-
- id Internal identifier.: string Sale , Purchase , Resale
- refName Reference Name: string
- itemType: object
-
- licenseCode License Code: string
- line Transaction Line: integer (int64)
- linked Linked: boolean
- links Links: nsLink
-
nsLink - location: location
- marginal Marginal: boolean
- matrixType Matrix Type: string
- minQty Minimum Quantity: number (float)
- options Options: string
- oqpBucket Oqp Bucket: string
- orderDoc: nsResource
- orderLine Order Line: integer (int64)
- printItems Print Items: boolean
- projecttask: projectTask
- quantity Quantity: number (float)
- rate Rate: number (double)
- rateIncludingTax Rate: number (double)
- rateSchedule Rate Schedule: string
- refName Reference Name: string
- scheduleType Schedule Type: string
- subsidiary: subsidiary
- targetLocation: location
- targetSubsidiary: subsidiary
- taxAmount Tax Amount: number (double)
- taxDetailsReference Tax Details Reference: string
- units Units: string
- vendorName Vendor Name: string
vendorReturnAuthorization-taxDetailsCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: vendorReturnAuthorization-taxDetailsElement
-
vendorReturnAuthorization-taxDetailsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
vendorReturnAuthorization-taxDetailsElement
This record is available as a beta record.
- calcDetail Details: string
- lineName Name: string
- lineType Line type: string
- links Links: nsLink
-
nsLink - netAmount Net Amount: number (double)
- refName Reference Name: string
- taxAmount Tax Amount: number (double)
- taxBasis Tax Basis: number (double)
- taxCode: salesTaxItem
- taxDetailsReference: object
-
- id Internal identifier.: string
- refName Reference Name: string
- taxRate Tax Rate: number (double)
- taxType Tax Type: string
vendorReturnAuthorizationCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: vendorReturnAuthorization
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
vendorReturnAuthorization - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
vendorSubsidiaryRelationship
- balance Balance: number (double)
-
The vendor's current accounts payable balance due appears here.
- balanceBase Balance (Base): number (double)
- baseCurrency: currency
- baseInTransitBalance In-Transit Balance (Base): number (double)
- creditLimit Credit Limit: number (double)
-
Enter an optional credit limit for your purchases from this vendor. If you have a NetSuite OneWorld account, enter the global credit limit for this vendor and any assigned subsidiary. This value can exceed the sum of the vendor and subsidiary credit limits. This credit limit sets a maximum currency amount that should be spent using credit without making a payment. The value displays in the vendor’s primary currency. The default is no value, or no credit limit. You can place the vendor on hold by entering 0 (zero.) Any new purchase order or vendor bill transaction displays a warning message. You cannot enter a negative value. NetSuite validates the transaction amounts on purchase orders and vendor bills against the global credit limit specified in the Credit Limit field. NetSuite does not include individual subsidiary credit limits in the global credit limit validation.
- entity: vendor
- externalId External ID: string
- id Internal ID: string
- inTransitBalance In-Transit Balance: number (double)
- isPrimarySub Is Primary Subsidiary: boolean
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - name Name: string
- prepaymentBalance Prepayment Balance: number (double)
- prepaymentBalanceBase Prepayment Balance (Base): number (double)
- primaryCurrency: currency
- refName Reference Name: string
- subsidiary: subsidiary
- taxItem: nsResource
- unbilledOrders Unbilled Orders: number (double)
-
This field displays the total amount of orders that have been entered but not yet billed. If you have enabled the preference Vendor Credit Limit Includes Orders, then this total is included in credit limit calculations. Set this preference at Setup > Accounting > Preferences > Accounting Preferences > General.
- unbilledOrdersBase Unbilled Orders (Base): number (double)
vendorSubsidiaryRelationshipCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: vendorSubsidiaryRelationship
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
vendorSubsidiaryRelationship - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
webSite
This record is available as a beta record.
- CREDITSALESREPSONWEB Credit Sales Reps for Website Orders: boolean
- CheckoutErrorEmail: nsResource
- DownloadAvailableEmail: nsResource
- GiftCertificateConfEmail: nsResource
- GiftCertificateEmail: nsResource
- LicenseCodeEmail: nsResource
- OrderApprovedConfEmail: nsResource
- OrderCancelledConfEmail: nsResource
- OrderFulfilledConfEmail: nsResource
- OrderReceivedConfEmail: nsResource
- PasswordRecoveryEmail: nsResource
- RegistrationConfEmail: nsResource
- analyticsclickattributes Analytics Click Attributes: string
-
Add attributes for the Add To Cart button in this field. You can capture analytics data before your shopper gets to the shopping cart. For example: onclick="handleLink(this.href); return false;" The code inside handleLink() should be implemented to reconstruct the URL such that shopper identification parameters needed for your analytics package are added to the href.
- analyticssubmitattributes Analytics Submit Attributes: string
-
Add attributes for the Proceed to Checkout button in this field. You can capture analytics data when your shoppers go to checkout from the shopping cart. For example: onsubmit="handlePost(this); return true;" The code inside handlePost () should be implemented to add fields to the form such that shopper identification parameters needed for your analytics package are posted with the form.
- assignnewcustomerstosite Assign New Customers to this Site: boolean
-
Check this box to restrict customer access to this web site. All customers who register on this web site get access to a customer account on this website only. Note: Customers who were already registered on your site are not affected by this setting.
- authorization_url Authorization Endpoint: string
-
If you chose the Set Configuration Manually option, you must gather the required information for the Authorization Endpoint field from your OpenID Connect Provider (OP).
- autoapplypromotionsenabled Auto-Apply Promotions: boolean
-
To set up promotions to be automatically applied to eligible transactions, enable Auto-Apply Promotions. Note: To be able to use the Auto-Apply Promotions feature, you must enable the promotions feature. For more information, see the help topic Configuring Promotions.
- autodownloadmedia Automatically download published site media items: boolean
-
Check this box to automatically download a file or folder when you click the Download link in the file cabinet.
- bSendCheckoutErrorEmail Send email of Checkout errors: boolean
-
You can receive alerts if errors occur during checkout and customers are unable to complete a purchase. Email alerts include a ticket number that refers to the error logged in NetSuite. If you are receiving several alerts, please contact NetSuite Customer Support with these ticket numbers to expedite a resolution. Email alerts can indicate any of the following problems: * Sales order creation failure * Transaction is out of balance * Custom field error - This can occur if an item option selected for an item in the shopping cart has been deleted or inactivated since it was added to the card. * Credit card processor error * Other problems that may prevent customers from checking out
- bSendDownloadAvailableEmail Send email that Download is available: boolean
-
Check this box to send an email message informing the web customer that a file is ready for download.
- bSendGiftCertificateConfEmail Send Gift Certificate Confirmation email: boolean
-
Check this box to send an email message to the web customer, confirming that a gift certificate was purchased.
- bSendGiftCertificateEmail Send Gift Certificate email: boolean
-
Check this box to send an email message to gift certificate recipients.
- bSendLicenseCodeEmail Send License Code email: boolean
-
Check this box to send an email message providing the web customer with a licence code.
- bSendOrderApprovedConfEmail Send email when order is approved: boolean
-
Check this box to send email to customers when their orders are approved.
- bSendOrderCancelledConfEmail Send email when order is cancelled: boolean
-
Check this box to send email to customers when their orders are canceled.
- bSendOrderFulfilledConfEmail Send email when order is fulfilled: boolean
-
Check this box to send email to customers when their orders are fulfilled.
- bSendOrderReceivedConfEmail Send email when order is received: boolean
-
Check this box to send an email message to customers when an order is received.
- bSendPasswordRecoveryEmail Send Password Recovery email: boolean
-
Check this box to send password recovery email.
- bStrRegistrationConfCopy Send BCC Registration Confirmation Emails: boolean
-
Check this box to receive copies of the message sent to your customers when they register on your website. If you do not check this, you will not receive copies of registration confirmation messages.
- bsendregistrationconfemail Send Registration Confirmation Email: boolean
-
Check this box to send a registration confirmation email message to customers who sign up on your website.
- bstrapproveordercopy Send BCC Order Approved Emails: boolean
-
Select this box and enter your email address into the following text area if you want to receive copies of the Order Approved emails sent to your customers. If you do not select this, you won't receive copies of customers' email confirmation messages.
- bstrcancelordercopy Send BCC Order Cancelled Emails: boolean
-
Select this box and enter your email address into the following text area if you want to receive copies of the Order Canceled emails sent to your customers. If you do not select this, you won't receive copies of customers' email confirmation messages.
- bstremailcopy Send BCC Order Received Emails: boolean
-
Select this box and enter your email address into the following text area if you want to receive copies of the Order Received emails sent to your customers. If you do not select this, you won't receive copies of customers' email confirmation messages.
- bstremailgiftconfcopy Send BCC Gift Certificate Confirmation Emails: boolean
-
Select this box and enter your email address into the following text area if you want to receive copies of the Gift Certificate Confirmation emails sent to your customers. If you do not select this, you won't receive copies of customers' email confirmation messages.
- bstremailgiftcopy Send BCC Gift Certificate Emails: boolean
-
Select this box and enter your email address into the following text area to receive copies of the message sent to your customers when a gift certificate is purchased on your website. If you do not select this, you won't receive copies of customers' email confirmation messages.
- bstrfulfillordercopy Send BCC Order Fulfilled Emails: boolean
-
Select this box and enter your email address into the following text area if you want to receive copies of the Order Fulfilled emails sent to your customers. If you do not select this, you won't receive copies of customers' email confirmation messages.
- cartcolumn: webSite-cartcolumnCollection
- cartdisplayorder: object
-
- id Internal identifier.: string RECENT_LAST , RECENT_FIRST
- refName Reference Name: string
- cartsharingmode: object
-
- id Internal identifier.: string PER_CUSTOMER , PER_CONTACT
- refName Reference Name: string
- cartupsellitems: object
-
- id Internal identifier.: string UPSELL_FIRST_RELATED_NEXT , ONLY_UPSELL_ITEMS , RELATED_FIRST_UPSELL_NEXT , ONLY_RELATED_ITEMS
- refName Reference Name: string
- categorylistlayout: nsResource
- ccformtemplate: object
-
- id Internal identifier.: string 88 , 89 , -9960 , 90 , 91 , -9965 , 92 , -9966 , 93 , -9967 , 94 , -9968 , 95 , -9961 , 96 , -9962 , 97 , 98 , 10 , -9964 , 99 , 11 , 12 , 13 , 14 , 18 , 1 , -9970 , -9971 , -9976 , -9977 , -9978 , -9979 , -9972 , 20 , -9974 , 21 , -9975 , -9907 , 22 , -9908 , 23 , -9909 , 24 , -9903 , -9904 , -9905 , 28 , -9906 , -9980 , -9981 , -9982 , -9987 , -9988 , -9989 , -9901 , -9902 , -9983 , 30 , -9984 , -9985 , -9986 , -9918 , -9919 , 35 , 36 , -9914 , -9915 , 39 , -9916 , -9917 , -9990 , -9991 , -9992 , -9993 , -9910 , -9998 , -9999 , -9911 , -9912 , -9913 , 40 , -9994 , 41 , -9995 , -9996 , -9997 , 44 , -9929 , 45 , 46 , 47 , -9925 , 48 , -9926 , 49 , -9927 , -9928 , -9921 , -9922 , -9923 , -9924 , 50 , 52 , -9920 , 55 , 56 , 57 , 58 , 59 , -9936 , -9938 , -9939 , -9892 , -9893 , -9894 , -9932 , -9899 , -9933 , 60 , -9934 , 61 , -9935 , 62 , -9895 , 63 , -9896 , 64 , -9930 , -9931 , -9898 , 66 , 67 , 68 , 69 , -9947 , -9948 , -9943 , 70 , -9944 , 71 , -9945 , 72 , -9946 , 73 , 74 , -9940 , 75 , -9941 , 76 , -9942 , 77 , 78 , 79 , -9958 , -9959 , -9954 , 80 , -9955 , 81 , -9956 , 82 , 83 , -9957 , -9950 , 84 , -9951 , 85 , -9952 , 86 , -9953 , 87
- refName Reference Name: string
- ccrequireauth Process an online payment with Sales Order creation: boolean
-
Check this box to require authorization for your customer's credit card before you accept an order. This preference only applies to sales orders generated by transactions on your web site.
- cctemplatecompatible: string
- checkoutdomain Checkout URL: string
-
Select a Checkout URL. You can make a selection from a list of checkout subdomains already configured by NetSuite. If you have configured a custom checkout domain, it should appear in this list. Select your custom checkout domain as the checkout URL.
- chromaSubsampling Chroma Subsampling: boolean
-
Check this box to apply chroma subsampling to the images. Chroma subsampling reduces the color information in favor of luminance data and results in image files that look the same but are smaller in size.
- client_id Client ID: string
-
Enter the Client ID you obtained from your OpenID Connect Provider (OP).
- client_secret Client secret: string
-
Enter the Client Secret you obtained from your OpenID Connect Provider (OP).
- colorset: object
-
- id Internal identifier.: string
- refName Reference Name: string
- commerceapiunifiedmode Commerce API Unified Mode: boolean
- compressedImageQuality Compressed Image Quality: string
-
Select the quality level you want the compressed images to have: * Low (maximum compression) - minor reduction in quality * Standard - minor reduction in quality when images are zoomed * Optimum (recommended) – occasional minor reduction in quality when images are zoomed * Very High (minimum compression) - no noticeable reduction in quality at any time
- config_url Configuration URL: string
-
The Set Configuration From URL option is selected by default. Enter the Configuration URL you obtained from your OpenID Connect Provider (OP). You should use the Set Configuration From URL option. However, if you choose the Set Configuration Manually option, you must gather the required information for the Issuer, Authorization Endpoint, Token Endpoint, and Certificate URL fields from your OP.
- confpagetrackinghtml Order Tracking Script HTML: string
-
Enter any tracking HTML you want to use in the header of the order confirmation page. This allows you to track the number of order you receive a day, for example.
- cookiepolicy: nsResource
- createcustomersascompanies Create Customers as Companies: boolean
-
Check this box to have all customers who register in your site created as Company type. You must also check the Mandatory box to have customers created as companies. Clear this box to have all customers created as Individuals. Customers created as individuals can also be saved as contacts and have a first and last name saved on record with an optional Company field. Customers created as companies have a Contacts subtab for individuals in the company and a mandatory Company field.
- currentidpinfo Entity ID: string
-
This read-only field lists the identity provider currently in use for SAML single sign-on authentication to the web store, if any. This value is based on the URL or metadata file provided below.
- custromeregistrationtype: object
-
- id Internal identifier.: string OPTANON , MANDATORY , DISALLOWED , ALLANON
- refName Reference Name: string
- defaultapplication: nsResource
- defaultcustomercategory: customerCategory
- defaulthostingroot: nsResource
- defaultshippingcountry: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- defaultshippingmethod: shipItem
- descriptionfontsize Description Font Size: integer (int64)
-
Enter the font size you want to use for item and category descriptions in your Web site.
- dispfirstlastnameseparately Display First and Last Name in Separate Fields on Registration Page: boolean
-
Check this box to display separate fields for first and last name on the registration page. When this box is cleared, one field appears in which customers can enter their names. Note: Even when one Name field is displayed, both first and last names are required. Note also that this check box only affects Site Builder websites where the My Account extension is not applied.
- displaycompanyfield Display Company Field on Registration Page: boolean
-
Check this box to let customers enter a company name during the checkout process.
- displaycustomercode Display Customer Code Field on Payment Info Page: boolean
-
Check this box to allow customers to enter a Customer Code associated with their company credit card on the Payment Information page in the web site. Companies that use one credit card across several departments can assign a separate code to each department. The code can then be used to track where and how the card is being used. This option is only available with Level 2 Credit Card Processing.
- displayname Display Name: string
-
This is the name for your site that displays in the heading of your Web store and in customers' browser windows.
- displayunsubscribe Display Unsubscribe to Email Checkbox on Registration Page: boolean
-
Check this box if you want to give customers the option to unsubscribe from your e-mail campaigns on your Web site when they register. To set the default for this field in your site, set the marketing preference at Setup > Marketing > Marketing Preferences.
- doctypehtml Document Type: string
-
Enter the code for the document type declaration of your Web site. This tells the browser the type of code you are using in your site. For example, if you are using HTML5, the document type declaration is: <!DOCTYPE html>
- dropshipspecorditemsalwaysinstock Drop Ship/Special Order items are always in stock: boolean
- emailfooter Footer Text: string
- emailheader Header Text: string
- enableCompression Compress all website images: boolean
-
Check this box to apply image compression to all website images that meet the compression criteria.
- enablegaintegration Enable Google Analytics Integration: boolean
-
Check this box to pass Google tracking cookies from shopping to checkout. This along with the fields on the Analytics subtab are required for cross-domain analytics tracking to integrate NetSuite with your Google Analytics account. Clear this box if Google Analytics Integration interferes with a custom solution you have already implemented for cross-domain tracking.
- entrypoints: webSite-entrypointsCollection
- facetfield: string
- fieldset: webSite-fieldsetCollection
- filtermethodsbycurrency Restrict Payment methods by currency of a customer: boolean
-
Check this box to display on the Payment page of your web store only those payment methods that support the shopper's currency. Note: When the Use Strict Rules for the Selection of Payment Processing Profiles accounting preference is enabled, it takes precedence over this preference. For more information, see the help topic Restricting Payment Processing Profiles by Customer Data.
- filtermethodsbyshippingaddress Restrict Payment Methods by Country of Shipping Address: boolean
- font: object
-
- id Internal identifier.: string OCRB , Garamond , Times-Roman , Trebuchet , Univers , OCRA , MS Gothic , Helvetica , BARCODE , Myriad Pro , Arial , Times New Roman , Gothic , NotoSansArabic , Palatino , Verdana , Tahoma , ComicSans , UniversCondensed , Georgia , Open Sans
- refName Reference Name: string
- giftcerteaffectsminamount Gift Certificate Affects Minimum Order Amount: boolean
-
This preference is for e-commerce merchants who require a minimum order amount for web store checkout. * When the box is checked, the gift certificate amount counts against the minimum order amount. Customers are not allowed to submit an order with a total order amount below the minimum requirement. * If you clear this box, a customer can successfully submit an order on your web site when a gift certificate brings the total order amount below the minimum requirement. The gift certificate amount and other credits (such as coupons) are excluded from the calculation of the total order amount.
- hidepaymentpagewhennobalance Hide Payment Page If Order Total Equals Zero: boolean
-
Check this box to hide the payment page in the checkout process if the order is equal to zero. Some e-commerce sites offer promotional products for free. This preference allows web customers to put a promotional item in the cart, and complete checkout without being required to input payment information.
- id Internal ID: string
- idp_login_as_default Primary Authentication Method: boolean
- idp_meta_file: string
- igniteedition: object
-
- id Internal identifier.: string STANDARD , ADVANCED
- refName Reference Name: string
- imagedomain Image Domain: string
-
Select the domain you want to use in the Image Domain field.
- imagefilenameformat Image Filename Format: string
-
Decide on a naming convention for image files that includes an item identifier. The first step in setting up images for Advanced Storefront is to rename each of your image files with an item identifier. Rename image files by appending the item identifier to the beginning of the image file name you want associated with each item record. You can add to the file name of each image using the Item ID Delimiter and the Structure Delimiter. The example below shows the image file name format when the item identifier is set to UPC code: SKU123_modelshot-longcoat.jpg.
- imagefolder: nsResource
- imageitemfielddelimiter Item ID Delimiter: string
-
The Item ID Delimiter is required. The default value is an underscore (_). It is used to parse the item identifier from the image file name.
- imagesize: webSite-imagesizeCollection
- imagestructurefielddelimiter Structure Delimiter: string
-
The default value of the Structure Delimiter field is a single dash (-). The Structure delimiter can be used to add information to the image filename. You are not required to use the Structure Delimiter in your image file names, but the Structure Delimiter field requires a value to prevent the Item Search API from returning internal errors.
- imageuniquefield: nsResource
- includeuncategorizeditems Show Uncategorized Items: boolean
-
Check this box to display items in search results that have the Display in Web Site box checked, even if they are not published in your Web site. This can be useful if you have not categorized an item that is for sale. Clear this box to only allow search results to return items published on tabs and categories in your site.
- includevatwithprices Prices Include Tax: boolean
-
For UK accounts, check this box to include VAT in the item prices on lists and descriptions in your site as follows: £100.00 (Incl. VAT).
- internalId Internal ID: integer (int64)
- internalname Internal Name: string
-
This is the name for your site that displays on lists in your NetSuite account. This name is not exposed to external customers.
- invalidDescriptiveURLAction: object
-
- id Internal identifier.: string 1 , 2 , 3
- refName Reference Name: string
- invoiceformtemplate: object
-
- id Internal identifier.: string 88 , 89 , -9960 , 90 , 91 , -9965 , 92 , -9966 , 93 , -9967 , 94 , -9968 , 95 , -9961 , 96 , -9962 , 97 , 98 , 10 , -9964 , 99 , 11 , 12 , 13 , 14 , 18 , 1 , -9970 , -9971 , -9976 , -9977 , -9978 , -9979 , -9972 , 20 , -9974 , 21 , -9975 , -9907 , 22 , -9908 , 23 , -9909 , 24 , -9903 , -9904 , -9905 , 28 , -9906 , -9980 , -9981 , -9982 , -9987 , -9988 , -9989 , -9901 , -9902 , -9983 , 30 , -9984 , -9985 , -9986 , -9918 , -9919 , 35 , 36 , -9914 , -9915 , 39 , -9916 , -9917 , -9990 , -9991 , -9992 , -9993 , -9910 , -9998 , -9999 , -9911 , -9912 , -9913 , 40 , -9994 , 41 , -9995 , -9996 , -9997 , 44 , -9929 , 45 , 46 , 47 , -9925 , 48 , -9926 , 49 , -9927 , -9928 , -9921 , -9922 , -9923 , -9924 , 50 , 52 , -9920 , 55 , 56 , 57 , 58 , 59 , -9936 , -9938 , -9939 , -9892 , -9893 , -9894 , -9932 , -9899 , -9933 , 60 , -9934 , 61 , -9935 , 62 , -9895 , 63 , -9896 , 64 , -9930 , -9931 , -9898 , 66 , 67 , 68 , 69 , -9947 , -9948 , -9943 , 70 , -9944 , 71 , -9945 , 72 , -9946 , 73 , 74 , -9940 , 75 , -9941 , 76 , -9942 , 77 , 78 , 79 , -9958 , -9959 , -9954 , 80 , -9955 , 81 , -9956 , 82 , 83 , -9957 , -9950 , 84 , -9951 , 85 , -9952 , 86 , -9953 , 87
- refName Reference Name: string
- invtemplatecompatible: string
- isadvanced: boolean
- isinactive Inactive: boolean
-
Check the Inactive box if you want to make a website inaccessible to users but you do not want to delete it permanently. An inactive site still retains internal references to other areas of NetSuite. For more information, see Making a Website Inactive.
- isprimary Primary: string
- isscriptablecartandcheckout Scriptable Cart and Checkout: boolean
-
Check this box to run SuiteScript on the sales order form submitted during the web store checkout. To use scriptable checkout, you must customize a Standard Online Order form by adding your script to the transaction form. Check this box to activate your script during Web store checkout. Note: If you use terms for your customers, you must attach your checkout script to both a customized Online Order - Invoice form, and an Online Order - Cash Sales form.
- issuer Issuer: string
-
If you chose the Set Configuration Manually option, you must gather the required information for the Issuer field from your OpenID Connect Provider (OP).
- iswebstoreoffline Take Website Offline for Maintenance: boolean
-
Check this box to temporarily take your store or site offline for maintenance. When you have finished making changes, clear this check box and your store or site will be available for shoppers.
- iswsdk WSDK: boolean
-
Select this check box to make this site an external catalog site. You can use the scripts available from the Web Site Developer's Kit (WSDK) to make the items in your NetSuite account display up-to-date pricing and availability information on your Web site. Go to Setup > Web Site > Preview Web Site for the WSDK links and scripts that integrate your site with NetSuite.
- itemlistlayout: nsResource
- itemtemplateaccountingtitem: object
-
- id Internal identifier.: string -178 , -134 , -177 , -133 , -136 , -179 , -135 , -174 , -130 , -173 , -176 , -132 , -175 , -131 , -138 , -137 , -139 , -150 , -145 , -101 , -144 , -100 , -147 , -103 , -146 , -102 , -141 , -140 , -143 , -142 , -109 , -108 , -149 , -105 , -148 , -104 , -107 , -106 , -161 , -160 , -156 , -112 , -155 , -111 , -158 , -114 , -157 , -113 , -154 , -110 , -153 , -119 , -116 , -159 , -115 , -118 , -117 , -170 , -172 , -171 , -123 , -122 , -125 , -124 , -162 , -121 , -120 , -127 , -126 , -129 , -128
- refName Reference Name: string
- itemtemplateinformationitem: object
-
- id Internal identifier.: string -178 , -134 , -177 , -133 , -136 , -179 , -135 , -174 , -130 , -173 , -176 , -132 , -175 , -131 , -138 , -137 , -139 , -150 , -145 , -101 , -144 , -100 , -147 , -103 , -146 , -102 , -141 , -140 , -143 , -142 , -109 , -108 , -149 , -105 , -148 , -104 , -107 , -106 , -161 , -160 , -156 , -112 , -155 , -111 , -158 , -114 , -157 , -113 , -154 , -110 , -153 , -119 , -116 , -159 , -115 , -118 , -117 , -170 , -172 , -171 , -123 , -122 , -125 , -124 , -162 , -121 , -120 , -127 , -126 , -129 , -128
- refName Reference Name: string
- jwks_uri Certificates URL: string
-
If you chose the Set Configuration Manually option, you must gather the required information for the Certificates URL field from your OpenID Connect Provider (OP).
- legacycategorydescriptions Legacy Category Descriptions: boolean
- legacydenselistsupport Legacy Dense List Layout: boolean
- legacyimageattributetags Legacy Tag Support for Images: boolean
-
If this box is checked, tags that access any image attribute (image, thumbnail, or image custom field) return the file name. If this box is cleared, the URL the image is hosted from is returned. Clearing this box is preferred. By providing you with the complete URL, you can use the tag to construct embedded images or links to popup windows.
- legacynavigationlinks Legacy Navigation Style: boolean
- legacywelcomepage Legacy Welcome Page Style: boolean
- links Links: nsLink
-
nsLink - loginallowed Allow Login / Register: boolean
- logout_url End Session Endpoint: string
- minimumorderamount Minimum Order Amount: number (double)
- noactivatetabonhostedpages Don't Activate Hosted Page Tabs: boolean
-
Check this box if you do not want hosted pages to be associated with a tab in your store. For example, if you link to a hosted site from a tab, the hosted page does not inherit settings from the tab, such as custom tags. In addition, the tab is not highlighted as the tab being viewed.
- nonccpaymethodsallowed Allow non-credit card payment methods during Checkout: boolean
-
Check this box to display custom payment methods that you create as alternatives to credit card payment methods. If you use Site Builder, checking this box will automatically display the payment method on the Payment Information page in the checkout process. If you operate a SuiteCommerce Advanced web site, a web developer can use the Commerce API to store the payment method selected on the web order. Additional customization is required. For more information, visit the Help Center, and read Creating an Alternative to Credit Card Payment Methods for Web Store Orders.
- nub: nsResource
- nubhtml Item Bullet HTML: string
- oidc_setup_option: object
-
- id Internal identifier.: string
- refName Reference Name: string
- onlinepricelevel: priceLevel
- outofstockbehavior: object
-
- id Internal identifier.: string ENABLE , ENABLENMSG , DISABLE , REMOVE
- refName Reference Name: string
- outofstockitems Include Out Of Stock Items in Website: boolean
-
Select an option for displaying items that my be out of stock on your site. For SuiteCommerce Advanced sites: Check the box to display out-of-stock items on your site. Clear the box to omit items that are out of stock. For Site Builder sites: Choose one of the following options: * Allow back orders but display out-of-stock message – Customers can purchase an out-of-stock item. An out-of-stock message appears beside the item in your store, but this item can be purchased and processed through the shopping cart. * Remove out-of-stock items from store – Customers cannot purchase out-of-stock items because they are automatically removed from your store until their supply is replenished. * Allow back orders with no out-of-stock message – Customers can purchase an out-of-stock item. No out-of-stock message is posted. * Disallow back orders but display out-of-stock message – Customers cannot purchase an out-of-stock item. An out-of-stock message appears beside the item in your store and the Add to Shopping Cart link is removed. Note: If you choose this setting and turn on the Multi-Location Inventory feature, items do not show in your Web store until after they have been distributed.
- outputlinebreaksasbr Output Line Breaks as <br>: boolean
-
Check this box to covert any line break in descriptions fields for items, tabs or categories you've created in NetSuite to the BR tag.
- pagealign: object
-
- id Internal identifier.: string CENTER , LEFT , RIGHT
- refName Reference Name: string
- pagewidth Page Width: string
-
To set a fixed width for your site, enter the width in pixels. When you set a fixed width, your site content stays the same width when site visitors change the browser window size.
- pagezoom: object
-
- passpromocodetocheckout Pass URL Promotion Code to Checkout: boolean
-
Check this box to automatically apply promotion codes passed through a link to items added to the shopping cart. When a shopper clicks a link with an appended promotion code that has an associated discount, the shopper will see the discount itemized and reflected in the order total on the last page of checkout. Create promotion codes at Lists > Marketing > Promotions > New. Append codes for promo codes to URL links using &promocode=[promotioncode]. For example, you can append the promo code for the fall clearance sale on t-shirts, http://shop.mywebsite.com/tshirts&promocode=FALLSALE.
- paymentprocessingprofiles: nsResourceCollection
- paypalaccount PayPal Account: string
-
Select the appropriate PayPal account for this web site. For more information about PayPal setup, visit the Help Center and read the topic, PayPal Integration and Express Checkout.
- presetcheckoutdomainprefix Domain prefix: string
- refName Reference Name: string
- relateditemsdescription Related Items Description: string
-
Enter a brief description of the list of Related Items, that you set up in NetSuite. A list of related items will show on the item details page. For example, you can enter “If you like these items, you may also like:”
- relateditemslayout: nsResource
- relevanceboostweight Relevance/Boost Weight: integer (int64)
- requestshippingaddressfirst Ask For Shipping Address First: boolean
-
Check this box to ask for customers' shipping addresses before their billing addresses during the Web store checkout process.
- requirecompanyfield Mandatory Company Field on Registration Page: boolean
-
If you checked the field named Display Company Field on Registration Page, then check this box to make the Company field mandatory. Clear this box to make this field optional. You must check this box to create customer records of company type.
- requireloginforpricing Require Login For Pricing: boolean
-
Check this box if you want item prices and the Add to Cart button hidden from customers who have not logged in. All item prices display the message “Please log in for price.” to customers who have not logged in. You can change or translate this message at Setup > Web Site > Customize Web Site Text on the Messages subtab. Note: Checking this box restricts most users from viewing prices on your website. However, pricing information can still be accessed using specific URLs that call the underlying APIs.
- requireshippinginformation Shipping Information is Required: boolean
-
Check this box to require shipping information to be entered before checking out of your Web store.
- requiretermsandconditions Require Terms and Conditions: boolean
-
Check this box to have customers to agree to the terms of the product or service they are buying before checking out of your store. This places an “I Agree” checkbox that customers must check to show that they agree to your terms. They can view the full terms and conditions by clicking a link that opens a popup window. If you use the Advanced Site Customization feature, you can customize the name of this checkbox at Setup > Web Site > Customize Web Site Text.
- sFromCheckoutErrorEmail Send email of Checkout errors from address: string
-
Enter the email address that should show in the From field when email messages are sent to Web store customers. If you operate multiple Web sites, you can enter a different address for each site.
- sFromDownloadAvailableEmail Download availability email sent from address: string
-
Enter the email address that should show in the From field when email messages are sent to Web store customers. If you operate multiple Web sites, you can enter a different address for each site.
- sFromGiftCertificateConfEmail Gift Certificate Confirmation sent from email address: string
-
Enter the email address that should show in the From field when email messages are sent to Web store customers. If you operate multiple Web sites, you can enter a different address for each site.
- sFromGiftCertificateEmail Gift Certificate sent from email address: string
-
Enter the email address that should show in the From field when email messages are sent to Web store customers. If you operate multiple Web sites, you can enter a different address for each site.
- sFromLicenseCodeEmail Send License Code email from this address: string
-
Enter the email address that should show in the From field when email messages are sent to Web store customers. If you operate multiple Web sites, you can enter a different address for each site.
- sFromOrderApprovedConfEmail Order approval email sent from address: string
-
Enter the email address that should show in the From field when email messages are sent to Web store customers. If you operate multiple Web sites, you can enter a different address for each site.
- sFromOrderCancelledConfEmail Canceled order email sent from address: string
-
Enter the email address that should show in the From field when email messages are sent to Web store customers. If you operate multiple Web sites, you can enter a different address for each site.
- sFromOrderFulfilledConfEmail Order fulfillment email sent from address: string
-
Enter the email address that should show in the From field when email messages are sent to Web store customers. If you operate multiple Web sites, you can enter a different address for each site.
- sFromOrderReceivedConfEmail Order received email sent from address: string
-
Enter the email address that should show in the From field when email messages are sent to web store customers. If you operate multiple web sites, you can enter a different address for each site.
- sFromPasswordRecoveryEmail Send Password Recovery email from this address: string
-
Enter the email address that should show in the From field when email messages are sent to Web store customers. If you operate multiple Web sites, you can enter a different address for each site.
- sFromRegistrationConfEmail Registration Confirmation email sent from address: string
-
Enter the email address that should show in the From field when email messages are sent to Web store customers. If you operate multiple Web sites, you can enter a different address for each site.
- sRegistrationConfEmailCopy BCC Registration Confirmation Recipient Emails: string
-
If you checked the BCC Confirmation Email box, enter the email address here that you want to receive web store registration confirmation email. You can enter more than one address separated by a comma.
- salesordertype: object
-
- id Internal identifier.: string 88 , 89 , -9960 , 90 , 91 , -9965 , 92 , -9966 , 93 , -9967 , 94 , -9968 , 95 , -9961 , 96 , -9962 , 97 , 98 , 10 , -9964 , 99 , 11 , 12 , 13 , 14 , 18 , 1 , -9970 , -9971 , -9976 , -9977 , -9978 , -9979 , -9972 , 20 , -9974 , 21 , -9975 , -9907 , 22 , -9908 , 23 , -9909 , 24 , -9903 , -9904 , -9905 , 28 , -9906 , -9980 , -9981 , -9982 , -9987 , -9988 , -9989 , -9901 , -9902 , -9983 , 30 , -9984 , -9985 , -9986 , -9918 , -9919 , 35 , 36 , -9914 , -9915 , 39 , -9916 , -9917 , -9990 , -9991 , -9992 , -9993 , -9910 , -9998 , -9999 , -9911 , -9912 , -9913 , 40 , -9994 , 41 , -9995 , -9996 , -9997 , 44 , -9929 , 45 , 46 , 47 , -9925 , 48 , -9926 , 49 , -9927 , -9928 , -9921 , -9922 , -9923 , -9924 , 50 , 52 , -9920 , 55 , 56 , 57 , 58 , 59 , -9936 , -9938 , -9939 , -9892 , -9893 , -9894 , -9932 , -9899 , -9933 , 60 , -9934 , 61 , -9935 , 62 , -9895 , 63 , -9896 , 64 , -9930 , -9931 , -9898 , 66 , 67 , 68 , 69 , -9947 , -9948 , -9943 , 70 , -9944 , 71 , -9945 , 72 , -9946 , 73 , 74 , -9940 , 75 , -9941 , 76 , -9942 , 77 , 78 , 79 , -9958 , -9959 , -9954 , 80 , -9955 , 81 , -9956 , 82 , 83 , -9957 , -9950 , 84 , -9951 , 85 , -9952 , 86 , -9953 , 87
- refName Reference Name: string
- sapproveordercopyemail BCC Order Approved Recipient Emails: string
- savecreditinfo Save Credit Card Info by Default: boolean
-
Check this box to save customer credit card information by default. If you check the Display Save My Credit Card Infor Field box, customers can still opt to clear this box in your site if they do not want card information saved. Note: If you have website customers that are companies with multiple contacts, do not check this box. A contact is a company-owned entity. A credit card created by a contact will be available to other contacts associated with that company.
- scancelordercopyemail BCC Order Canceled Recipient Emails: string
- scripttemplatecreditcard: object
-
- id Internal identifier.: string 88 , 89 , -9960 , 90 , 91 , -9965 , 92 , -9966 , 93 , -9967 , 94 , -9968 , 95 , -9961 , 96 , -9962 , 97 , 98 , 10 , -9964 , 99 , 11 , 12 , 13 , 14 , 18 , 1 , -9970 , -9971 , -9976 , -9977 , -9978 , -9979 , -9972 , 20 , -9974 , 21 , -9975 , -9907 , 22 , -9908 , 23 , -9909 , 24 , -9903 , -9904 , -9905 , 28 , -9906 , -9980 , -9981 , -9982 , -9987 , -9988 , -9989 , -9901 , -9902 , -9983 , 30 , -9984 , -9985 , -9986 , -9918 , -9919 , 35 , 36 , -9914 , -9915 , 39 , -9916 , -9917 , -9990 , -9991 , -9992 , -9993 , -9910 , -9998 , -9999 , -9911 , -9912 , -9913 , 40 , -9994 , 41 , -9995 , -9996 , -9997 , 44 , -9929 , 45 , 46 , 47 , -9925 , 48 , -9926 , 49 , -9927 , -9928 , -9921 , -9922 , -9923 , -9924 , 50 , 52 , -9920 , 55 , 56 , 57 , 58 , 59 , -9936 , -9938 , -9939 , -9892 , -9893 , -9894 , -9932 , -9899 , -9933 , 60 , -9934 , 61 , -9935 , 62 , -9895 , 63 , -9896 , 64 , -9930 , -9931 , -9898 , 66 , 67 , 68 , 69 , -9947 , -9948 , -9943 , 70 , -9944 , 71 , -9945 , 72 , -9946 , 73 , 74 , -9940 , 75 , -9941 , 76 , -9942 , 77 , 78 , 79 , -9958 , -9959 , -9954 , 80 , -9955 , 81 , -9956 , 82 , 83 , -9957 , -9950 , 84 , -9951 , 85 , -9952 , 86 , -9953 , 87
- refName Reference Name: string
- scripttemplateinvoice: object
-
- id Internal identifier.: string 88 , 89 , -9960 , 90 , 91 , -9965 , 92 , -9966 , 93 , -9967 , 94 , -9968 , 95 , -9961 , 96 , -9962 , 97 , 98 , 10 , -9964 , 99 , 11 , 12 , 13 , 14 , 18 , 1 , -9970 , -9971 , -9976 , -9977 , -9978 , -9979 , -9972 , 20 , -9974 , 21 , -9975 , -9907 , 22 , -9908 , 23 , -9909 , 24 , -9903 , -9904 , -9905 , 28 , -9906 , -9980 , -9981 , -9982 , -9987 , -9988 , -9989 , -9901 , -9902 , -9983 , 30 , -9984 , -9985 , -9986 , -9918 , -9919 , 35 , 36 , -9914 , -9915 , 39 , -9916 , -9917 , -9990 , -9991 , -9992 , -9993 , -9910 , -9998 , -9999 , -9911 , -9912 , -9913 , 40 , -9994 , 41 , -9995 , -9996 , -9997 , 44 , -9929 , 45 , 46 , 47 , -9925 , 48 , -9926 , 49 , -9927 , -9928 , -9921 , -9922 , -9923 , -9924 , 50 , 52 , -9920 , 55 , 56 , 57 , 58 , 59 , -9936 , -9938 , -9939 , -9892 , -9893 , -9894 , -9932 , -9899 , -9933 , 60 , -9934 , 61 , -9935 , 62 , -9895 , 63 , -9896 , 64 , -9930 , -9931 , -9898 , 66 , 67 , 68 , 69 , -9947 , -9948 , -9943 , 70 , -9944 , 71 , -9945 , 72 , -9946 , 73 , 74 , -9940 , 75 , -9941 , 76 , -9942 , 77 , 78 , 79 , -9958 , -9959 , -9954 , 80 , -9955 , 81 , -9956 , 82 , 83 , -9957 , -9950 , 84 , -9951 , 85 , -9952 , 86 , -9953 , 87
- refName Reference Name: string
- searchcategorylistlayout: nsResource
- searchfield: string
- searchforcategories Include Categories in Search Results: boolean
-
Check the Show Categories in Search Results box to include relevant categories in search results. Clearing this box returns only relevant items.
- searchforinformationitems Include Information Items in Search Results: boolean
-
Check the Show Information Items in Search Results check box to include items of type Information Item in the search results when a global search is performed in the web store. If this box is unchecked, then, items of this type will not be included/displayed in the search results.
- searchformitemlistlayout: nsResource
- searchitemlistlayout: nsResource
- searchlinkform: object
-
- id Internal identifier.: string
- refName Reference Name: string
- searchportletdisplay Global Search: boolean
-
Choose Global Search to display the default search entry field in the left navigation column of your Web store. Choose Search Form to display a custom search form that you create in the left navigation column of your Web store.
- searchportletform: object
-
- id Internal identifier.: string
- refName Reference Name: string
- semailaddrforerror Send email of Checkout errors to address: string
-
If you opt to receive checkout error email, enter the email address where you would like to receive the error alerts.
- sfulfillordercopyemail BCC Order Fulfilled Recipient Emails: string
- shippingestimatorpriority: object
-
- id Internal identifier.: string LOWEST_PRICE , WEBSTORE_DEFAULT , COMPANY_DEFAULT , USER_PREVIOUS_PREFERENCE
- refName Reference Name: string
- shipstoallcountries Website Ships to All Countries: boolean
-
Check this box to allow orders placed in the Web store to be shipped to any country. Clear this box to limit the countries you ship to using the Countries Web Store ships to field.
- shipstocountries Countries Website Ships To: string
-
You must clear the Web Store ships to all countries box to edit this field. Select the countries you want to allow customers to select when entering shipping addresses in the Web store. This prevents customers from placing orders to ship to countries you do not ship to.
- showbillingaddress Display Billing Address: boolean
- showcartsummaryportlet Show Cart Summary: boolean
-
Check this box to include the Shopping Cart portlet in your Web site.This portlet shows what customers currently have in their shopping carts.
- showcookieconsentbanner Show Cookie Consent Banner: boolean
-
Check this box to publish a banner requesting that shoppers comply with the use of cookies on your site.
- showcurrencyportlet Show Website Currency: boolean
-
Check this box to allow web site customers to choose a currency for shopping in your store. When you check this box, an online shopper can select a currency on your site's Home page. After a currency is selected, all item prices will appear in the selected currency. For more information, visit SuiteAnswers, and read the topic, Multiple Currencies in the Web Store.
- showextendedcart Show Extended Cart: boolean
-
The extended cart allows shoppers to add the following information on the shopping cart page: * Coupon code * Gift certificate * Shipping information To display additional fields for entering shipping information, you must enable both preferences, Show Shipping Estimator in Cart and Show Extended Cart.
- shownavigationportlet Show Navigation Portlet: boolean
-
Check this box to include the Item Navigation portlet in your site. This portlet appears on the left side of your site and lets customers navigate between items and categories. You can set preferences for this portlet on site themes if you use the Advanced Site Customization feature.
- showordertrackinglink Display Order Tracking Link: boolean
- showpofieldonpayment Display Purchase Order Field on Payment Info Page: boolean
-
Check this box to show a text field on the Payment Information page of your store where customers can enter Purchase Order numbers. The Purchase Order number entered will automatically appear on sales orders generated from your Web store.
- showquantitypricinginlists Show Quantity Pricing in Lists: boolean
-
Check this box to show a table with item quantities and prices in lists for items that have price breaks in certain quantities. If you do not check this box, the pricing table shows when the item name is clicked to view details, but the single quantity price is displayed in lists.
- showsavecreditinfo Display 'Save My Credit Card Info' Field: boolean
-
Check this box to allow customers to save their credit card information wth their login for use the next time they shop with you. When customers opt to save credit card info during checkout, the credit card info is stored on the customer record and available as a payment choice the next time they check out. Note: If you have website customers that are companies with multiple contacts, do not check this box. A contact is a company-owned entity. A credit card created by a contact will be available to other contacts associated with that company.
- showsearchportlet Show Search: boolean
-
Check this box to display the Search portlet in your Web site. Customers can use this system-generated search entry field to search for products or information on your site.
- showshippingestimator Show Shipping Estimator in Cart: boolean
-
- In Site Builder websites, check this box to give customers an estimate of shipping costs before they complete shipping information in checkout. The lowest estimated shipping cost is displayed by default. If you offer real-time rates, a customer can enter a zip code to receive an estimate. If the order qualifies for free shipping, “Free Shipping” is displayed. * In SuiteCommerce Advanced websites, you can check this box if you do not have a default Shipping Method chosen. The Shipping Estimator shows the lowest shipping cost from available Shipping Methods.
- showtellafriendlink Show "Tell a Friend" Link: boolean
-
Checking this box adds a “Tell A Friend” link to the detailed description page for each item published to your site. When a shopper on your site clicks the Tell a Friend link, an email editor opens up. The subject of the email message is “Hi There,” by default. The content includes the text, “I thought you would like to have a look at this product at,” followed by a link to the item on your site. You can customize the text in the email message by going to Setup > Standard Storefront > Customize Text.
- sitecurrency: webSite-sitecurrencyCollection
- sitelanguage: webSite-sitelanguageCollection
- siteloginrequired Password-Protect Entire Site: boolean
-
Check this box to require a login and password to view any page in your site. Once visitors log in, they can navigate through pages in your site freely. You must give customers access in your account for them to be able to view your site if you check this box. Note: Checking this box restricts most users from being able to access your website without logging in. However, item information and other website content can still be accessed using specific URLs that call the underlying APIs.
- siteportletstyle: object
-
- id Internal identifier.: string HEADERBAR , HEADERBARSM , JOINED , BOXED , TRANSPARENT , ROUNDEDCAPS
- refName Reference Name: string
- siteregion Subsidiaries: string
- sitetabalignment: object
-
- id Internal identifier.: string CENTER , LEFT , RIGHT
- refName Reference Name: string
- sitetabstyle: object
-
- id Internal identifier.: string STANDARDTABS , TABBAR , LINKS , BUTTONBAR , RECTTABS , CURVEDTABS , DEFAULT
- refName Reference Name: string
- siteusescarttags Site Uses Cart Summary Tags: boolean
-
Check this box if you use Web site tags to display the list of items in the shopping cart.
- siteusesdropshadows Site Uses Drop Shadows: boolean
- sortfield: string
- sstoreemailaddrforcopy BCC Order Received Recipient Emails: string
-
If you checked the BCC Confirmation Email box, enter the email address here that you want to receive store order confirmation email. You can enter more than one address separated by a comma.
- sstoreemailaddrforgiftconfcopy BCC Gift Certificate Confirmation Recipient Emails: string
- sstoreemailaddrforgiftcopy BCC Gift Certificate Recipient Emails: string
-
If you checked the BCC Order Received Email box or the BCC Gift Certificate Emails box, enter the email address where you want to send copies of the message. You can enter more than one address separated by a comma.
- storealias Checkout Alias: string
-
If you do not have your own domain name, enter the name of your site as one word, all lower case and without punctuation. This name appears in your Web address after http://shopping.netsuite.com/. Use this format: mystore
- storeemail Default Website Email From Address: string
-
Enter the email address that should show in the From field when email notification and confirmation is sent to Web site customers. This field is optional. Note: This address is only used if you leave the Email From Address field blank on any of the email template subtabs.
- storetab: webSite-storetabCollection
- stripMetadata Strip metadata: boolean
-
Check this box to remove all metadata (such as camera details, caption, copyright information) from the images.
- termsandconditionshtml Terms and Conditions HTML: string
-
Enter HTML code for the terms and conditions text that should be available from your Web site. Customers can click a link to view this text in a popup window before agreeing to the terms.
- textgroup: object
-
- id Internal identifier.: string -2
- refName Reference Name: string
- titlefontsize Title Font Size: integer (int64)
-
Enter the font size you want to use for item and category titles in your Web site.
- token_url Token Endpoint: string
-
If you chose the Set Configuration Manually option, you must gather the required information for the Token Endpoint field from your OpenID Connect Provider (OP).
- upload_method: object
-
- id Internal identifier.: string
- refName Reference Name: string
- upselldescription Upsell Description: string
-
Enter a brief description of the upsell correlated items list to show above the list of recommended items in your site. For example, you can enter “Customers Who Bought This Item Also Bought:”
- upsellitems: object
-
- id Internal identifier.: string UPSELL_FIRST_RELATED_NEXT , ONLY_UPSELL_ITEMS , RELATED_FIRST_UPSELL_NEXT , ONLY_RELATED_ITEMS
- refName Reference Name: string
- upsellitemslayout: nsResource
- upsellminimumcorrelation Minimum Correlation % for Upsell: number (double)
-
Enter the minimum correlation percentage an item should have to the item being viewed or items in the cart. Correlation percentage measures how often items are purchased together.
- upsellminimumcount Minimum Number of Buyers for Upsell: integer (int64)
-
Only items with a greater count than what you set here are displayed. Count represents the number of customers that have purchased both the items being viewed or in the cart and the upsell item recommendations.
- upsellminimumlift Minimum Lift % for Upsell: number (double)
-
Only items with greater lift than what you set here are displayed. Lift is the degree to which the item's correlation exceeds its overall purchase frequency. A high lift implies a more reliable correlation.
- urlformat: object
-
- id Internal identifier.: string T , F
- refName Reference Name: string
- useurlfileextension Use File Extension: boolean
-
Check this box to optimize descriptive URLs. This preference does the following: * On a file hosted in the file cabinet, it includes the extension for the image, or HTML file in the URL. * On URLs that point to tabs and categories, it includes a trailing slash.
- websitehomepage: object
-
- id Internal identifier.: string
- refName Reference Name: string
- websitehomepagetype: object
-
- id Internal identifier.: string
- refName Reference Name: string
- websitelogo: nsResource
- websitelogoalign: object
-
- id Internal identifier.: string CENTER , LEFT , RIGHT
- refName Reference Name: string
- websitelogolinkurl Logo Link URL: string
-
Enter the URL you want to use as a hyperlink when site visitors click your logo. If you don't want to create a hyperlink for your logo, leave this field blank.
- websitescope: object
-
- id Internal identifier.: string SUITE_COMMERCE_IN_STORE , SUITE_COMMERCE , FULL_WEB_STORE , INFO_CATALOG_PRICING , INFO_CATALOG , SUITE_COMMERCE_MY_ACCOUNT , INFO_ONLY , SUITE_COMMERCE_ADVANCED
- refName Reference Name: string
- websitetheme: object
-
- id Internal identifier.: string -101 , 99 , -100 , -103 , -102 , -104
- refName Reference Name: string
- webstoreadditembehavior: object
-
- id Internal identifier.: string SHOWCART , SAMEPAGE
- refName Reference Name: string
- webstoremetatags Addition to <head>: string
-
Enter data for the header in this field. You can enter a script to capture web analytics. For information, see the Web Analytics Tools Preferences help topic. In this field, you can also add Meta Tag HTML to appear in the < head > section of all your Web store pages. Note that Meta tags entered on Category and Tab pages are more effective for the purpose of search engine optimization (SEO).
- wsdkcancelcarturl Shopping cart page Continue Shopping link URL: string
-
The URL you provide is a link back into your website. When shoppers on your site click the Continue Shopping link displayed in NetSuite checkout, they are redirected to the page defined in the URL you enter in this field. By defining the link back to the appropriate page of your site, you complete integration of the NetSuite checkout pages with your site.
- wsdkcancelcheckouturl Checkout page Cancel link URL: string
-
The URL you provide is a link from the Cancel link on the Checkout page back to your website. If a customer on your website chooses to cancel checkout, they will be redirected to your website. By defining the link back to the appropriate page of your site, you complete integration of the NetSuite checkout page with your site.
- wsdkcancelloginurl Login/registration page Cancel link URL: string
-
The URL you provide is for the Cancel link on the Login/Registration page. If shoppers on your site choose not to complete registration on your site, they can click the Cancel link, and be redirected back to your website. By defining the link back to the appropriate page of your site, you complete integration of the NetSuite Login/Registration page with your site.
- wsdkcompletecheckouturl URL to go to after checkout is complete: string
-
The URL you provide is a link from the Checkout page back to your website. By defining the link back to the appropriate page of your site, you complete integration of the NetSuite checkout page with your site.
- wsdkcompleteloginurl URL to go to after login/registration is complete: string
-
The URL you provide is a link from the Login/Registration page back into your website. By defining the link back to the appropriate page of your site, you complete integration of the NetSuite shopping cart.
webSite-cartcolumnCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: webSite-cartcolumnElement
-
webSite-cartcolumnElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
webSite-entrypointsCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: webSite-entrypointsElement
-
webSite-entrypointsElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
webSite-entrypointsElement
This record is available as a beta record.
- entrypath Path: string
- entrytype: object
-
- id Internal identifier.: string LOGOUT , REGISTER , CHECKOUT , HOMEPAGE , LOGIN , CUSTCENTER , CART
- refName Reference Name: string
- key key: integer (int64)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- webapp: object
-
- id Internal identifier.: string
- refName Reference Name: string
webSite-fieldsetCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: webSite-fieldsetElement
-
webSite-fieldsetElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
webSite-imagesizeCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: webSite-imagesizeElement
-
webSite-imagesizeElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
webSite-sitecurrencyCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: webSite-sitecurrencyElement
-
webSite-sitecurrencyElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
webSite-sitecurrencyElement
This record is available as a beta record.
- currency: currency
- currencyname: string
- isdefault: object
-
- id Internal identifier.: string
- refName Reference Name: string
- isonline Online: boolean
- links Links: nsLink
-
nsLink - minimumorderamount Minimum Order Amount: number (double)
- refName Reference Name: string
- sitecurrencygrip: string
- sitecurrencyseqnum: string
webSite-sitelanguageCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: webSite-sitelanguageElement
-
webSite-sitelanguageElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
webSite-sitelanguageElement
This record is available as a beta record.
- isdefault: object
-
- id Internal identifier.: string
- refName Reference Name: string
- isonline Online: boolean
- languagename Language: string
- links Links: nsLink
-
nsLink - locale: object
-
- id Internal identifier.: string
- refName Reference Name: string
- refName Reference Name: string
- sitelanguagegrip: string
- sitelanguageseqnum: string
webSite-storetabCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: webSite-storetabElement
-
webSite-storetabElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
webSiteCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: webSite
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
webSite - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
workOrder
This record is available as a beta record.
- accountingBookDetail: workOrder-accountingBookDetailCollection
- actualProductionEndDate Actual Production End Date: string (date)
-
When the final assembly is built and recorded in the work order transaction, NetSuite automatically populates the Actual Production End Date.
- actualProductionStartDate Actual Production Start Date: string (date)
-
The Actual Production Start Date field is automatically populated when a work order transaction is initiated.
- allocateddemand Allocated Demand: number (float)
-
The number of items already allocated to a group or customer.
- assemblyFullyCompleted: boolean
- assemblyItem: assemblyItem
- autoCalculateLag Auto-calculate Lag: boolean
-
Check the Auto-Calculate Lag box if you want NetSuite to calculate lag times for operation tasks. For more information, see Operations Overlap.
- auxDate: string
- billOfMaterials: bom
- billOfMaterialsRevision: bomRevision
- built Built: number (float)
-
The Built field displays the total number of assemblies that have been completed on associated assembly builds.
- class: classification
- committed Buildable: number (float)
-
The Committed field displays the total number of assemblies that are committed to sales on associated assembly builds.
- componentsFullyIssued: boolean
- createdDate Date Created: string (date-time)
- createdFrom: nsResource
- currency: currency
- currencyPrecision: integer (int64)
- customForm: object
-
- id Internal identifier.: string -9938
- refName Reference Name: string
- customerOrderPriority: number (float)
- department: department
- discountAmount Discount Amount: number (double)
- discountDate Discount Date: string (date)
- dueDate Due Date: string (date)
- effectiveBomControl: string
- endDate Production End Date: string (date)
-
In the Production End Date field, enter the date you expect to complete assembly production. This field defaults to today's date plus lead time. * Demand Planning bases assembly supply on the production end date. * Manufacturing Routing production end date depends on whether NetSuite uses forward or backward scheduling to calculate production requirements. To learn more, see Production Scheduling Methods Overview.
- entity: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- excludeCommission Exclude Commissions: boolean
- excludefromsupplyplanning Exclude from Supply Planning: boolean
- expandAssembly Mark Sub-assemblies Phantom: boolean
-
Check the Mark Sub-Assemblies Phantom box to build member items that are also assemblies used to complete the work order. Sub-assembly components are displayed on the Items subtab. To learn more, see Work Orders and Sub-Assemblies
- externalId External ID: string
- firmed Firmed: boolean
-
Planned work order status is displayed as either Open or Firmed. 1. Firmed planned work orders are not deleted before supply planning runs. Check this box to firm the order. 2. Open planned work orders are deleted before supply planning runs. Clear this box to keep the order open.
- hasAvail: boolean
- hasAvailComponents: boolean
- id Internal ID: string
- isActualProdEndDateEnteredManually Enter Manually: boolean
-
To override an actual production date, below the Actual Production date, click Enter Manually. Select a new date from the calendar and then click Save.
- isActualProdStartDateEnteredManually Enter Manually: boolean
-
To override an actual production date, below the Actual Production date, click Enter Manually. Select a new date from the calendar and then click Save.
- isWip WIP: boolean
-
Check the WIP box to designate the work order to use WIP instead of a standard assembly build. This option is only available when the order status is Released. It cannot be changed once a posting assembly transaction is logged against the work order. To learn more, see Using WIP on Work Orders.
- item: workOrder-itemCollection
- job: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- lastModifiedDate Date Last Modified: string (date-time)
- linkedPO: purchaseOrder
- links Links: nsLink
-
nsLink - location: location
- locationForWip: location
- locationOrderPriority: number (float)
- manufacturingRouting: manufacturingRouting
- maxReloadDate: string (date)
- memo Memo: string
-
Optionally, enter a Memo for this work order. You can search for the memo text to find this work order.
- minReloadDate: string (date)
- nexus: nexus
- operationSequenceEditable: boolean
- options Options: string
- orderStatus: object
-
- origQuantity: number (float)
- originalEndDate: string (date)
- originalManufacturingRouting: string
- originalSchedulingMethod: string
- originalStartDate: string (date)
- originator Originator: string
- otherRefNum PO/Check Number: string
- outsourced Outsourced: boolean
-
Check this box to identify this work order as outsourced.
- outsourcingCharge: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- partners: workOrder-partnersCollection
- prevDate Previous Effective Date: string (date)
- prevPartner Previous Partner: integer (int64)
- prevRep Previous Representative: integer (int64)
- propagateSchedulingMethod: boolean
- quantity Quantity: number (float)
-
Enter the Quantity of assembly items you want to create. This can be a fractional number.
- refName Reference Name: string
- requesteddate Supply Required By Date: string (date)
-
The Supply Required By Date represents the date the item must be shipped to the customer.
- revision: itemRevision
- revisionMemo Revision Memo: string
- salesEffectiveDate Sales Effective Date: string (date)
- salesRep: one of: [ customer, partner, vendor, nsResource, employee, contact ]
- salesTeam: workOrder-salesTeamCollection
- schedulingMethod: object
-
- id Internal identifier.: string BACKWARD , FORWARD
- refName Reference Name: string
- scrapQuantity Quantity Scrapped: number (float)
-
Enter the number of items scrapped during the assembly process.
- soId: string
- soLine: string
- source: object
-
- specOrd: boolean
- startDate Production Start Date: string (date)
-
In the Production Start Date field, enter the date you expect to begin assembly production. This field defaults to today's date. * Demand Planning bases component demand on the production start date. * Manufacturing Routing production start date depends on whether NetSuite uses forward or backward scheduling to calculate production requirements. To learn more, see Production Scheduling Methods Overview.
- status: object
-
- id Internal identifier.: string A , B , C , D , G , H
- refName Reference Name: string
- storeOrder: string
- subsidiary: subsidiary
- supplyPlanId: string
- supplyPlanLineId: string
- supplyPlanOrder: string
- terms: term
- tranDate Date: string (date)
-
NetSuite displays today's Date as the default work order date. You can enter or select another date.
- tranId Order No.: string
-
NetSuite automatically increases the largest work Order # (number) by one. You can enter another number, however the next order number will revert to the standard pattern.
- units Unit of Measure: string
-
The Units field displays the units of the component used in the parent assembly.
- useComponentYield Use Component Yield: boolean
- vendor: vendor
- webSite: string
workOrder-accountingBookDetailCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: workOrder-accountingBookDetailElement
-
workOrder-accountingBookDetailElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
workOrder-accountingBookDetailElement
This record is available as a beta record.
- accountingBook: accountingBook
- exchangeRate Exchange Rate: number (double)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- revRecOnRevCommitment Rev Rec on Rev Commit.: boolean
- subsidiary: subsidiary
- tranIsVsoeBundle Transaction Is VSOE Bundle: boolean
workOrder-item-inventoryDetail
This record is available as a beta record.
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- externalId External ID: string
- inventoryassignment: workOrder-item-inventoryDetail-inventoryassignmentCollection
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemDescription Description: string
-
A more complete Description of the item.
- links Links: nsLink
-
nsLink - location: location
- quantity Quantity: number (float)
-
In the Quantity to Build field, enter the number of assembly items you want to build. You cannot enter a quantity that exceeds the amount displayed in the Buildable Quantity field.
- refName Reference Name: string
- toLocation: location
- unit Units: string
-
If the assembly uses Units of Measure, the base units are displayed in the Units field.
workOrder-item-inventoryDetail-inventoryassignmentCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: workOrder-item-inventoryDetail-inventoryassignmentElement
-
workOrder-item-inventoryDetail-inventoryassignmentElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
workOrder-item-inventoryDetail-inventoryassignmentElement
This record is available as a beta record.
- binNumber: bin
- expirationDate Expiration Date: string (date)
- internalId Internal ID: integer (int64)
- inventoryDetail Inventory Detail: integer (int64)
- inventoryStatus: inventoryStatus
- issueInventoryNumber: inventoryNumber
- links Links: nsLink
-
nsLink - packCarton Pack Carton: string
- pickCarton Pick Carton: string
- quantity Quantity: number (float)
- quantityAvailable Unpicked Bin Qty: number (float)
- receiptInventoryNumber Serial/Lot Number: string
- refName Reference Name: string
- secondaryQuantity Secondary Quantity: number (float)
- toBinNumber: bin
- toInventoryStatus: inventoryStatus
workOrder-itemCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: workOrder-itemElement
-
workOrder-itemElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
workOrder-itemElement
This record is available as a beta record.
- allocationAlert Reallocate Order Item: string
- amount Amount: number (double)
- assemblyLevel: integer (int64)
- billVarianceStatus: object
-
- id Internal identifier.: string NOVARIANCES , JOURNALNOTPOSTED , JOURNALPOSTED
- refName Reference Name: string
- bomQuantity BoM Quantity: string
- bomRevisionComponent: nsResource
- class: classification
- commitInventory: object
-
- id Internal identifier.: string 1 , 2 , 3
- refName Reference Name: string
- commitmentFirm Commitment Confirmed: boolean
- component: string
- componentYield Component Yield: number (double)
- createPo: object
-
- id Internal identifier.: string CostRtrn , EndrTeg , SpecOrd , AuthDep , InTrnPay , POrdBlnk , ResvShip , Capture , GLAdj , OppClose , LandCost , CountAdj , OrdReval , IntcoAdj , CpFxVar , OrdAlloc , FxAsset , GACAdjst , WaveShip , RfqCtrct , POrdPrep , OwnRcpt , Transfrm , DepRfnd , BillVar , OrdBuild , FftRqFt , DepAppl , Payment , Refund , ColTeg , Reimb , OrdDgrss , KitShip , OrdAuth , WipBuild , CtrctOrd , OrdClose , RevRec , OrdRvCom , PickPack , TOrdCost , SysJrnl , Commissn , COGS , SrcContr , OsrcMfg , EstInvc , RfqVend , OrdDep , WOReval , CostRec , PurchOwn , OppEst , POrdReq , OrdBill , ExpRec , NetAsset , PrepAppl , OrdFftRq , BillRcpt , OrdArrng , PurchRet , CostDef , ShipRcpt , SaleRet , DiscTeg , RcptBill , CostDefR , DropShip , WaveOrd , PayTeg
- refName Reference Name: string
- createWo Create WO: boolean
- createdPo: purchaseOrder
- daysLate Days Late: integer (int64)
- department: department
- description Description: string
- expectedshipdate Expected Ship Date: string (date)
- initOqpBucket Initial OQP Bucket: string
- inventoryDetail: workOrder-item-inventoryDetail
- isClosed Closed: boolean
- isOpen Is Opened: boolean
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemId: string
- itemSource: object
-
- id Internal identifier.: string WORK_ORDER , PHANTOM , PURCHASE_ORDER , STOCK
- refName Reference Name: string
- itemSourceList Item Source options list: string
- itemSubtype: object
-
- id Internal identifier.: string Sale , Purchase , Resale
- refName Reference Name: string
- itemType: object
-
- licenseCode License Code: string
- line Transaction Line: integer (int64)
- linked Linked: boolean
- links Links: nsLink
-
nsLink - location: location
- marginal Marginal: boolean
- matrixType Matrix Type: string
- minQty Minimum Quantity: number (float)
- notInvtCommittable: boolean
- oldexpectedshipdate: string (date)
- operationDisplayText: manufacturingOperationTask
- operationSequenceNumber: integer (int64)
- options Options: string
- oqpBucket Oqp Bucket: string
- orderAllocationStrategy: nsResource
- orderDoc: nsResource
- orderLine Order Line: integer (int64)
- orderPriority Order Priority: number (float)
- origAssemblyQty: number (float)
- plannedIssueDate Planned Component Issue Date: string (date-time)
- poRate PO Rate: number (double)
- poVendor: vendor
- printItems Print Items: boolean
- quantity Quantity: number (float)
- quantityAllocated Quantity Allocated: number (float)
- quantityAvailable Available: number (float)
- quantityBackOrdered Back Ordered: number (float)
- quantityCommitted Committed: number (float)
- quantityDemandAllocated Allocated Demand: number (float)
- quantityFulfilled <NULL>: number (float)
- quantityOnHand On Hand: number (float)
- quantityPacked Quantity Packed: number (float)
- quantityReceived <NULL>: number (float)
- rate Rate: number (double)
- rateIncludingTax Rate: number (double)
- rateSchedule Rate Schedule: string
- refName Reference Name: string
- requesteddate Supply Required By Date: string (date)
- roundUpAsComponent: boolean
- subsidiary: subsidiary
- units Units: string
- vendorList Vendor LIST: string
- woId Work Order ID: string
workOrder-partnersCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: workOrder-partnersElement
-
workOrder-partnersElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
workOrder-partnersElement
This record is available as a beta record.
- contribution Contribution %: number (double)
- isPrimary Primary: boolean
- links Links: nsLink
-
nsLink - partner: partner
- partnerRole: partnerCategory
- refName Reference Name: string
workOrder-salesTeamCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: workOrder-salesTeamElement
-
workOrder-salesTeamElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
workOrderClose
This record is available as a beta record.
- billOfMaterials: bom
- billOfMaterialsRevision: bomRevision
- class: classification
- component: workOrderClose-componentCollection
- createdDate Date Created: string (date-time)
- createdFrom: workOrder
- currencyPrecision Currency Precision: string
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- department: department
- excludeFromGLNumbering Exclude from GL Audit Numbering: boolean
- externalId External ID: string
- id Internal ID: string
- item: assemblyItem
- lastModifiedDate Date Last Modified: string (date-time)
- line: integer (int64)
- links Links: nsLink
-
nsLink - location: location
- manufacturingRouting Manufacturing Routing: integer (int64)
- memo Memo: string
-
Memo displays any text accompanying this work order. You can search for text entered here to find the transaction later.
- orderQuantity Work Order Quantity: number (float)
-
Work Order Quantity identifies the number of items built using this work order.
- postingPeriod: accountingPeriod
- prevDate Previous Effective Date: string (date)
- quantity Quantity: number (float)
-
The number of items, Quantity Built using this work order.
- quantityVarianceAmount Quantity Variance Amount: number (double)
- refName Reference Name: string
- revision: itemRevision
- revisionMemo Revision Memo: string
- routingItem: workOrderClose-routingItemCollection
- scrapAmount Scrap Amount: number (double)
- scrapQuantity: number (float)
-
The number of items, or Quantity Scrapped (loss) using this work order.
- subsidiary: subsidiary
- total Projected Value: number (double)
- tranDate Date: string (date)
-
The Date that this work order was closed.
- tranId Ref No.: string
-
The work order issue Reference # (number).
- woLocation: string
workOrderClose-componentCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: workOrderClose-componentElement
-
workOrderClose-componentElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
workOrderClose-componentElement
This record is available as a beta record.
- assemblyLevel: string
- buildVariance: number (float)
- compItemName Component: string
- hasMembersOnBuild: boolean
- isNonInventory: boolean
- item: string
- itemCost: number (float)
- lineNumber: integer (int64)
- links Links: nsLink
-
nsLink - orderDoc: integer (int64)
- orderLine: integer (int64)
- orderLineQty: number (float)
- orderQuantity Work Order Quantity: number (float)
- quantity Quantity Consumed: number (float)
- refName Reference Name: string
- unitCost: number (float)
workOrderClose-routingItemCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: workOrderClose-routingItemElement
-
workOrderClose-routingItemElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
workOrderClose-routingItemElement
This record is available as a beta record.
- assignmentId: integer (int64)
- item: string
- itemName Item: string
- lineId: integer (int64)
- links Links: nsLink
-
nsLink - operationName Operation Name: string
- operationSequence Operation Sequence: integer (int64)
- orderDoc: integer (int64)
- orderLine: integer (int64)
- refName Reference Name: string
- totalCost: number (float)
- totalTime Total Time (Min): number (float)
- totalTimeHours: number (float)
- unitCost: number (float)
workOrderCloseCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: workOrderClose
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
workOrderClose - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
workOrderCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: workOrder
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
workOrder - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
workOrderCompletion
This record is available as a beta record.
- accountingBookDetail: workOrderCompletion-accountingBookDetailCollection
- billOfMaterials: bom
- billOfMaterialsRevision: bomRevision
- binItem: boolean
- binNumbers Bin Numbers: string
- class: classification
- completedQuantity Completed Quantity: number (float)
-
The quantity to be completed shows in this field.
- component: workOrderCompletion-componentCollection
- createdDate Date Created: string (date-time)
- createdFrom: workOrder
- currencyPrecision Currency Precision: string
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- department: department
- endOperation: manufacturingOperationTask
- excludeFromGLNumbering Exclude from GL Audit Numbering: boolean
- expirationDate Expiration Date: string (date)
- externalId External ID: string
- firstOperation: string
- hasNumberedComponents: boolean
- id Internal ID: string
- inventoryDetail: workOrderCompletion-inventoryDetail
- inventoryDetailAvail: string
- inventoryDetailReq: boolean
- inventoryDetailUiType: string
- inventoryDetail_upd: string
- isBackflush Backflush: boolean
-
Check the Backflush box to enter the completions with backflush. Using backflush means that component consumption is recorded at the same time. Component consumption is based on the proportion designated on the original work order and the build quantity.
- isLotNumberedAssembly: boolean
- isNumbered: boolean
- isNumberedAssembly: boolean
- isSerial: boolean
- item: assemblyItem
- itemBinList: string
- lastModifiedDate Date Last Modified: string (date-time)
- line: integer (int64)
- links Links: nsLink
-
nsLink - location: location
- manufacturingRouting: manufacturingRouting
- memo Memo: string
-
Optionally enter a memo for this transaction. You can search for text entered here to find the transaction later.
- operation: workOrderCompletion-operationCollection
- orderQuantity Work Order Quantity: number (float)
-
The quantity of assemblies from the work order displays in this field.
- originalCompletedQuantity: number (float)
- originalEndOperation: integer (int64)
- originalStartOperation: integer (int64)
- postingPeriod: accountingPeriod
- prevDate Previous Effective Date: string (date)
- qtyLmit: number (float)
- quantity Quantity: number (float)
-
Enter the number of assemblies to record as being completed.
- refName Reference Name: string
- revision: itemRevision
- revisionMemo Revision Memo: string
- scrapQuantity: number (float)
-
Enter the quantity to record as being scrapped.
- serialNumbers Serial Numbers: string
- startOperation: manufacturingOperationTask
- subsidiary: subsidiary
- total Projected Value: number (double)
-
Unlike on an assembly build, the Projected Value field on a work order completion displays the cost of the assembly, not individual components (unless you use backflush.)
- tranDate Date: string (date)
-
Select or verify the date for this transaction. The current date autofills this field.
- tranId Ref No.: string
-
In the Reference # field, you can enter a reference number to track this transaction.
- transformId: string
- unitCost Unit Cost: number (float)
- units Unit of Measure: string
-
The unit of measure for this item is displayed in this field.
- woLocation: string
workOrderCompletion-accountingBookDetailCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: workOrderCompletion-accountingBookDetailElement
-
workOrderCompletion-accountingBookDetailElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
workOrderCompletion-accountingBookDetailElement
This record is available as a beta record.
- accountingBook: accountingBook
- exchangeRate Exchange Rate: number (double)
- links Links: nsLink
-
nsLink - refName Reference Name: string
- revRecOnRevCommitment Rev Rec on Rev Commit.: boolean
- subsidiary: subsidiary
- tranIsVsoeBundle Transaction Is VSOE Bundle: boolean
workOrderCompletion-component-componentInventoryDetail
This record is available as a beta record.
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- externalId External ID: string
- inventoryassignment: workOrderCompletion-component-componentInventoryDetail-inventoryassignmentCollection
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemDescription Description: string
-
A more complete Description of the item.
- links Links: nsLink
-
nsLink - location: location
- quantity Quantity: number (float)
-
In the Quantity to Build field, enter the number of assembly items you want to build. You cannot enter a quantity that exceeds the amount displayed in the Buildable Quantity field.
- refName Reference Name: string
- toLocation: location
- unit Units: string
-
If the assembly uses Units of Measure, the base units are displayed in the Units field.
workOrderCompletion-component-componentInventoryDetail-inventoryassignmentCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: workOrderCompletion-component-componentInventoryDetail-inventoryassignmentElement
-
workOrderCompletion-component-componentInventoryDetail-inventoryassignmentElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
workOrderCompletion-component-componentInventoryDetail-inventoryassignmentElement
This record is available as a beta record.
- binNumber: bin
- expirationDate Expiration Date: string (date)
- internalId Internal ID: integer (int64)
- inventoryDetail Inventory Detail: integer (int64)
- inventoryStatus: inventoryStatus
- issueInventoryNumber: inventoryNumber
- links Links: nsLink
-
nsLink - packCarton Pack Carton: string
- pickCarton Pick Carton: string
- quantity Quantity: number (float)
- quantityAvailable Unpicked Bin Qty: number (float)
- receiptInventoryNumber Serial/Lot Number: string
- refName Reference Name: string
- secondaryQuantity Secondary Quantity: number (float)
- toBinNumber: bin
- toInventoryStatus: inventoryStatus
workOrderCompletion-componentCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: workOrderCompletion-componentElement
-
workOrderCompletion-componentElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
workOrderCompletion-componentElement
This record is available as a beta record.
- assemblyLevel: string
- binItem: string
- binNumbers Bin Numbers: string
- buildVariance: number (float)
- compItemName Component: string
- componentInventoryDetail: workOrderCompletion-component-componentInventoryDetail
- componentInventoryDetailAvail: string
- componentInventoryDetailReq: string
- componentInventoryDetail_Upd: string
- componentNumbers: string
- componentUiType: string
- fulfillmentBin: string
- hasMembersOnBuild: boolean
- isNonInventory: boolean
- isNumbered: boolean
- isSerial: boolean
- item: string
- itemBinList: string
- itemCost: number (float)
- lineNumber: integer (int64)
- links Links: nsLink
-
nsLink - operationKey: string
- operationSequenceNumber Operation: string
- operationUrl: string
- orderDoc: integer (int64)
- orderLine: integer (int64)
- orderLineQty: number (float)
- quantity Quantity: number (float)
- quantityLimit: number (float)
- quantityPer Quantity Per: number (float)
- refName Reference Name: string
- unitCost: number (float)
workOrderCompletion-inventoryDetail
This record is available as a beta record.
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- externalId External ID: string
- inventoryassignment: workOrderCompletion-inventoryDetail-inventoryassignmentCollection
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemDescription Description: string
-
A more complete Description of the item.
- links Links: nsLink
-
nsLink - location: location
- quantity Quantity: number (float)
-
In the Quantity to Build field, enter the number of assembly items you want to build. You cannot enter a quantity that exceeds the amount displayed in the Buildable Quantity field.
- refName Reference Name: string
- toLocation: location
- unit Units: string
-
If the assembly uses Units of Measure, the base units are displayed in the Units field.
workOrderCompletion-inventoryDetail-inventoryassignmentCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: workOrderCompletion-inventoryDetail-inventoryassignmentElement
-
workOrderCompletion-inventoryDetail-inventoryassignmentElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
workOrderCompletion-inventoryDetail-inventoryassignmentElement
This record is available as a beta record.
- binNumber: bin
- expirationDate Expiration Date: string (date)
- internalId Internal ID: integer (int64)
- inventoryDetail Inventory Detail: integer (int64)
- inventoryStatus: inventoryStatus
- issueInventoryNumber: inventoryNumber
- links Links: nsLink
-
nsLink - packCarton Pack Carton: string
- pickCarton Pick Carton: string
- quantity Quantity: number (float)
- quantityAvailable Unpicked Bin Qty: number (float)
- receiptInventoryNumber Serial/Lot Number: string
- refName Reference Name: string
- secondaryQuantity Secondary Quantity: number (float)
- toBinNumber: bin
- toInventoryStatus: inventoryStatus
workOrderCompletion-operationCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: workOrderCompletion-operationElement
-
workOrderCompletion-operationElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
workOrderCompletion-operationElement
This record is available as a beta record.
- completedQuantity Completed Quantity: number (float)
- enabled: boolean
- inputQuantity Input Quantity: number (float)
- laborResources Labor Resources: number (float)
- laborResourcesLimit: number (float)
- laborRunTime Labor Run Time (Min): number (float)
- laborSetupTime Labor Setup Time (Min): number (float)
- links Links: nsLink
-
nsLink - machineResources Machine Resources: number (float)
- machineResourcesLimit: number (float)
- machineRunTime Machine Run Time (Min): number (float)
- machineSetupTime Machine Setup Time (Min): number (float)
- operationName Operation Name: string
- operationSequence Operation Sequence: integer (int64)
- overallCompletedQuantity: number (float)
- predecessorCompletedQuantity Predecessor Completed Quantity: number (float)
- quantityRemaining Quantity Remaining: number (float)
- recordSetup Record Setup Time: boolean
- refName Reference Name: string
- runRate: number (float)
- setupTime: number (float)
- taskId: integer (int64)
- timeId: integer (int64)
- workCenter Manufacturing Work Center: string
workOrderCompletionCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: workOrderCompletion
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
workOrderCompletion - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
workOrderIssue
This record is available as a beta record.
- billOfMaterials: bom
- billOfMaterialsRevision: bomRevision
- class: classification
- component: workOrderIssue-componentCollection
- createdDate Date Created: string (date-time)
- createdFrom: workOrder
- currencyPrecision Currency Precision: string
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- department: department
- endOperation: manufacturingOperationTask
- excludeFromGLNumbering Exclude from GL Audit Numbering: boolean
- externalId External ID: string
- firstOperation: string
- id Internal ID: string
- item: assemblyItem
- lastModifiedDate Date Last Modified: string (date-time)
- line: integer (int64)
- links Links: nsLink
-
nsLink - location: location
- manufacturingRouting: manufacturingRouting
- memo Memo: string
-
Optionally enter a memo for this transaction. You can search for text entered here to find the transaction later.
- postingPeriod: accountingPeriod
- prevDate Previous Effective Date: string (date)
- refName Reference Name: string
- revision: itemRevision
- revisionMemo Revision Memo: string
- startOperation: manufacturingOperationTask
- subsidiary: subsidiary
- tranDate Date: string (date)
-
Select or verify the date for this transaction. The current date autofills this field.
- tranId Ref No.: string
-
In the Reference # field, you can enter a reference number to track this transaction.
- woLocation: string
workOrderIssue-component-componentInventoryDetail
This record is available as a beta record.
- customForm: object
-
- id Internal identifier.: string
- refName Reference Name: string
- externalId External ID: string
- inventoryassignment: workOrderIssue-component-componentInventoryDetail-inventoryassignmentCollection
- item: one of: [ inventoryItem, assemblyItem, kitItem, nsResource, discountItem, markupItem, subtotalItem, descriptionItem, paymentItem, salesTaxItem, taxGroup, shipItem, downloadItem, giftCertificateItem, subscriptionPlan, nonInventorySaleItem, nonInventoryResaleItem, nonInventoryPurchaseItem, serviceSaleItem, serviceResaleItem, servicePurchaseItem, otherChargeSaleItem, otherChargeResaleItem, otherChargePurchaseItem ]
- itemDescription Description: string
-
A more complete Description of the item.
- links Links: nsLink
-
nsLink - location: location
- quantity Quantity: number (float)
-
In the Quantity to Build field, enter the number of assembly items you want to build. You cannot enter a quantity that exceeds the amount displayed in the Buildable Quantity field.
- refName Reference Name: string
- toLocation: location
- unit Units: string
-
If the assembly uses Units of Measure, the base units are displayed in the Units field.
workOrderIssue-component-componentInventoryDetail-inventoryassignmentCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: workOrderIssue-component-componentInventoryDetail-inventoryassignmentElement
-
workOrderIssue-component-componentInventoryDetail-inventoryassignmentElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
workOrderIssue-component-componentInventoryDetail-inventoryassignmentElement
This record is available as a beta record.
- binNumber: bin
- expirationDate Expiration Date: string (date)
- internalId Internal ID: integer (int64)
- inventoryDetail Inventory Detail: integer (int64)
- inventoryStatus: inventoryStatus
- issueInventoryNumber: inventoryNumber
- links Links: nsLink
-
nsLink - packCarton Pack Carton: string
- pickCarton Pick Carton: string
- quantity Quantity: number (float)
- quantityAvailable Unpicked Bin Qty: number (float)
- receiptInventoryNumber Serial/Lot Number: string
- refName Reference Name: string
- secondaryQuantity Secondary Quantity: number (float)
- toBinNumber: bin
- toInventoryStatus: inventoryStatus
workOrderIssue-componentCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: workOrderIssue-componentElement
-
workOrderIssue-componentElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
workOrderIssue-componentElement
This record is available as a beta record.
- assemblyLevel: string
- binItem: string
- binNumbers Bin Numbers: string
- buildVariance: number (float)
- compItemName Component: string
- componentInventoryDetail: workOrderIssue-component-componentInventoryDetail
- componentInventoryDetailAvail: string
- componentInventoryDetailReq: string
- componentInventoryDetail_Upd: string
- componentNumbers: string
- componentUiType: string
- fulfillmentBin: string
- hasMembersOnBuild: boolean
- isNonInventory: boolean
- isNumbered: boolean
- isSerial: boolean
- item: string
- itemBinList: string
- itemCost: number (float)
- lineNumber: integer (int64)
- links Links: nsLink
-
nsLink - operationKey: string
- operationSequenceNumber Operation: string
- operationUrl: string
- orderDoc: integer (int64)
- orderLine: integer (int64)
- orderLineQty: number (float)
- quantity Quantity: number (float)
- quantityDefault: number (float)
- quantityLimit: number (float)
- refName Reference Name: string
- unitCost: number (float)
workOrderIssueCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: workOrderIssue
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
workOrderIssue - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
workplace
This record is available as a beta record.
- externalId External ID: string
- fullName Full Name: string
- id Internal ID: string
- internalId Internal ID: integer (int64)
- isInactive Workplace is Inactive: boolean
-
Check this box to make this workplace inactive. This workplace no longer appears on workplace lists unless you check the Show Inactives box at the bottom of the list page. Inactive workplaces no longer appear in lists or fields on forms and reports.
- jurisdictionhist: workplace-jurisdictionhistCollection
- links Links: nsLink
-
nsLink - mainAddress: workplace-mainAddress
- name Name: string
-
Enter the name for this workplace. This name appears in the Workplace list on transactions and reports.
- parent: workplace
- refName Reference Name: string
- subsidiary: subsidiary
workplace-jurisdictionhistCollection
This record is available as a beta record.
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items: workplace-jurisdictionhistElement
-
workplace-jurisdictionhistElement - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)
workplace-mainAddress
This record is available as a beta record.
- addr1 Address 1: string
- addr2 Address 2: string
- addr3 Address 3: string
- addrPhone Phone: string
- addrText Address: string
- addressee Addressee: string
- attention Attention: string
- city City: string
- country: object
-
- id Internal identifier.: string PR , PS , PT , PW , PY , QA , AD , AE , AF , AG , AI , AL , AM , AN , AO , AQ , AR , AS , RE , AT , AU , AW , AX , AZ , RO , BA , BB , RS , BD , RU , BE , BF , RW , BG , BH , BI , BJ , BL , BM , BN , BO , SA , SB , BQ , SC , BR , SD , BS , SE , BT , SG , BV , SH , BW , SI , SJ , BY , SK , BZ , SL , SM , SN , SO , CA , SR , SS , CC , ST , CD , CF , SV , CG , SX , CH , SY , CI , SZ , CK , CL , CM , CN , CO , TC , CR , CS , TD , TF , CU , TG , CV , TH , CW , CX , TJ , CY , TK , CZ , TL , TM , TN , TO , TR , TT , DE , TV , TW , TZ , DJ , DK , DM , DO , UA , UG , DZ , UM , EA , US , EC , EE , EG , EH , UY , UZ , VA , VC , ER , ES , VE , ET , VG , VI , VN , VU , FI , FJ , FK , FM , FO , FR , WF , GA , GB , WS , GD , GE , GF , GG , GH , GI , GL , GM , GN , GP , GQ , GR , GS , GT , GU , GW , GY , XK , HK , HM , HN , HR , YE , HT , HU , IC , YT , ID , IE , IL , IM , IN , IO , ZA , IQ , IR , IS , IT , ZM , JE , ZW , JM , JO , JP , KE , KG , KH , KI , KM , KN , KP , KR , KW , KY , KZ , LA , LB , LC , LI , LK , LR , LS , LT , LU , LV , LY , MA , MC , MD , ME , MF , MG , MH , MK , ML , MM , MN , MO , MP , MQ , MR , MS , MT , MU , MV , MW , MX , MY , MZ , NA , NC , NE , NF , NG , NI , NL , NO , NP , NR , NU , NZ , OM , PA , PE , PF , PG , PH , PK , PL , PM , PN
- refName Reference Name: string
- externalId External ID: string
- lastModifiedDate Last Modified Date: string (date-time)
- links Links: nsLink
-
nsLink - override Override: boolean
- refName Reference Name: string
- state State/Province: string
- zip Zip: string
workplaceCollection
- count Count: integer (int64)
- hasMore Has More Results: boolean
- items Items: workplace
-
An array field that represents a collection of elements, for example, sublist lines, multiselect items, or search results.
-
workplace - links Links: nsLink
-
nsLink - offset Query Offset: integer (int64)
- totalResults Total Results: integer (int64)