NetSuite REST icon

NetSuite REST

Call NetSuite SuiteTalk REST operations.

Actions979

Billing Schedule → Insert or update record

AI-generated

Summary

Update an existing Billing Schedule record in NetSuite by its external identifier, setting or modifying its properties and custom fields. This operation performs a full or partial update based on the provided fields.

Inputs

  • Id (required) — The external identifier of the Billing Schedule record to update. This ID is part of the URL path for the update request.
  • Additional Fields — A collection of standard fields to set or update on the Billing Schedule record. Includes properties like 'Name', 'Frequency', 'Initial Amount', 'Milestone' details, 'Recurrence' details, and various boolean flags for billing behavior (e.g., 'Apply To Subtotal', 'In Arrears', 'Inactive').
  • Custom Fields — A list of custom fields to apply to the Billing Schedule record. Each custom field requires a 'Field Name', 'Field Type', and a corresponding 'Value'.
  • Replace — Comma-separated names of sublists whose lines should be entirely replaced by the lines specified in the request. If omitted, sublist lines are typically merged.
  • Replace Selected Fields — When set to 'true', any fields intended for deletion in the update request, including body fields, must be explicitly included in the 'Replace' parameter. This enables precise control over field deletion during updates.
  • Prefer — Determines server behavior for the request. Set to 'respond-async' to execute the request in the background, which will return a 'Preference-applied: respond-async' header in the response.
  • X - Net Suite - Idempotency - Key — A unique, user-defined UUID in string format (RFC 4122) that ensures asynchronous requests are executed only once. This key is ignored for synchronous requests.
  • X - Net Suite - Property Name Validation — Sets the strictness level for property name validation ('Error', 'Warning', or 'Ignore').
  • X - Net Suite - Property Value Validation — Sets the strictness level for property value validation ('Error', 'Warning', or 'Ignore').
  • Debug Mode — Enable to include the full request and response information in the output for debugging purposes.

Output shape

A single JSON object representing the updated NetSuite Billing Schedule record.

The output reflects the Billing Schedule record after the successful update. If 'Debug Mode' is enabled, the output will also contain detailed request and response information.

Examples

Example 1: Update the name of an existing billing schedule.

Set 'Id' to the target schedule's external ID. Under 'Additional Fields', set 'Name' to the new desired name.

Example 2: Change a billing schedule's frequency and mark it inactive.

Provide the 'Id'. Under 'Additional Fields', set 'Frequency' with a new 'id' (e.g., 'MONTHLY') and set 'Inactive' to 'true'.

Discussion