### GET /subscriptionPlan - Get List of Subscription Plans Source: https://github.com/plague69/netsuite-doc-extract/blob/main/extracted_html_files/subscriptionPlan.html Retrieves a list of subscription plan records. Supports filtering and pagination. ```APIDOC ## GET /subscriptionPlan ### Description Retrieves a list of subscription plan records. Supports filtering and pagination. ### Method GET ### Endpoint /subscriptionPlan ### Parameters #### Query Parameters - **Prefer** (string) - Optional - Specifies the server behavior, e.g., 'respond-async' for asynchronous execution. - **X-NetSuite-Idempotency-Key** (string) - Optional - A unique idempotency key for asynchronous requests. - **q** (string) - Optional - The search query to filter results. - **limit** (integer) - Optional - The maximum number of results to return per page (default: 1000). - **offset** (integer) - Optional - The offset for selecting a specific page of results (default: 0). ### Response #### Success Response (200 OK) - **subscriptionPlanCollection** - A collection of subscription plan records. #### Error Response - **nsError** - An error response object. ### Response Example (Success) ```json { "items": [ { "id": "123", "name": "Basic Plan" } ] } ``` ``` -------------------------------- ### GET /promotionCode - Get List of Promotion Codes Source: https://github.com/plague69/netsuite-doc-extract/blob/main/extracted_html_files/promotionCode.html Retrieves a list of promotion codes with options for filtering, limiting, and asynchronous processing. ```APIDOC ## GET /promotionCode ### Description Retrieves a list of promotion codes. This endpoint supports filtering via a search query, pagination with limit and offset, and asynchronous execution. ### Method GET ### Endpoint /promotionCode ### Parameters #### Query Parameters - **Prefer** (string) - Optional - Use 'respond-async' to execute the request asynchronously. - **X-NetSuite-Idempotency-Key** (string) - Optional - A user-defined unique idempotency key for asynchronous requests. - **q** (string) - Optional - The search query to filter results. - **limit** (integer) - Optional - Defaults to 1000. The number of results to return per page. - **offset** (integer) - Optional - Defaults to 0. The page offset for selecting results. ### Request Example ``` GET /promotionCode?q=SUMMER_SALE&limit=50&offset=0 Prefer: respond-async X-NetSuite-Idempotency-Key: "a1b2c3d4-e5f6-7890-1234-567890abcdef" ``` ### Response #### Success Response (200 OK) - **promotionCodeCollection** - A collection of promotion code records. #### Response Example ```json { "items": [ { "id": "123", "code": "SUMMER_SALE", "name": "Summer Sale Discount" } ], "count": 1, "next": null } ``` #### Error Response - **nsError** - An error response object. ``` -------------------------------- ### GET /bin - Get List of Bins Source: https://github.com/plague69/netsuite-doc-extract/blob/main/extracted_html_files/bin.html Retrieves a list of bin records. Supports filtering, pagination, and asynchronous processing. ```APIDOC ## GET /bin ### Description Retrieves a list of bin records. Supports filtering, pagination, and asynchronous processing. ### Method GET ### Endpoint /bin ### Parameters #### Query Parameters - **q** (string) - Optional - The search query that is used to filter results. - **limit** (integer) - Optional - The limit used to specify the number of results on a single page. Defaults to 1000. - **offset** (integer) - Optional - The offset used for selecting a specific page of results. Defaults to 0. #### Headers - **Prefer** (string) - Optional - Use 'respond-async' to execute the request asynchronously. - **X-NetSuite-Idempotency-Key** (string) - Optional - A user-defined unique idempotency key for asynchronous requests. ### Response #### Success Response (200 OK) - **binCollection** (object) - List of records. (See [binCollection](https://system.netsuite.com/help/helpcenter/en_US/APIs/REST_API_Browser/record/v1/2025.2/index.html#/definitions/binCollection)) #### Error Response - **nsError** (object) - Error response. (See [nsError](https://system.netsuite.com/help/helpcenter/en_US/APIs/REST_API_Browser/record/v1/2025.2/index.html#/definitions/nsError)) ``` -------------------------------- ### GET /noteType/{id} - Get Note Type Source: https://github.com/plague69/netsuite-doc-extract/blob/main/extracted_html_files/noteType.html Retrieves a specific note type by its ID. ```APIDOC ## GET /noteType/{id} ### Description Retrieves a specific note type by its ID. ### Method GET ### Endpoint /noteType/{id} ### Parameters #### Path Parameters - **id** (integer) - Required - The internal identifier of the note type to retrieve. #### Query Parameters - **Prefer** (string) - Optional - Use 'respond-async' to execute the request asynchronously. - **X-NetSuite-Idempotency-Key** (string) - Optional - A user-defined unique idempotency key for asynchronous requests. ### Request Example ```json { "Prefer": "respond-async" } ``` ### Response #### Success Response (200) - **noteType** - The details of the requested note type record. #### Response Example ```json { "links": [ { "rel": "self", "href": "/noteType/1" } ], "id": "1", "name": "Example Note Type" } ``` ``` -------------------------------- ### GET /vendorPrepaymentApplication Source: https://github.com/plague69/netsuite-doc-extract/blob/main/extracted_html_files/vendorPrepaymentApplication.html Retrieves a list of Vendor Prepayment Application records. Supports filtering, pagination, and asynchronous processing. ```APIDOC ## GET /vendorPrepaymentApplication ### Description Retrieves a list of Vendor Prepayment Application records. Supports filtering, pagination, and asynchronous processing. ### Method GET ### Endpoint /vendorPrepaymentApplication ### Parameters #### Header Parameters - **Prefer** (string) - Optional - The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. - **X-NetSuite-Idempotency-Key** (string) - Optional - A user-defined unique idempotency key for asynchronous requests. #### Query Parameters - **q** (string) - Optional - The search query used to filter results. - **limit** (integer) - Optional - The number of results to return per page. Defaults to 1000. - **offset** (integer) - Optional - The offset for selecting a specific page of results. Defaults to 0. ### Response #### Success Response (200 OK) - **vendorPrepaymentApplicationCollection** (object) - A collection of Vendor Prepayment Application records. #### Error Response - **nsError** (object) - An error response object. ### Response Example (Success) ```json { "items": [ { "id": "123", "recordType": "vendorPrepaymentApplication", "links": [ { "rel": "self", "href": "/vendorPrepaymentApplication/123" } ] } ], "count": 1, "hasMore": false } ``` ``` -------------------------------- ### Complete Workflow for NetSuite Documentation Extraction Source: https://context7.com/plague69/netsuite-doc-extract/llms.txt Demonstrates the full workflow for the NetSuite documentation extractor. This includes configuring source and output paths, verifying the source file's existence and size, running the main extraction function, and verifying the output by listing and showing the size of the first few extracted files. It also shows how to open and parse one of the extracted files using BeautifulSoup. ```python import os import re from bs4 import BeautifulSoup # Step 1: Configure the extractor SOURCE_FILE = 'nsdoc.dat' # The NetSuite documentation file OUTPUT_DIR = 'extracted_html_files' # Step 2: Ensure source file exists if not os.path.exists(SOURCE_FILE): raise FileNotFoundError(f"Source file '{SOURCE_FILE}' not found") print(f"Source file size: {os.path.getsize(SOURCE_FILE) / (1024*1024):.2f} MB") # Output: Source file size: 18.20 MB # Step 3: Run extraction from extract import extract_divs extract_divs() # Step 4: Verify extracted files output_files = sorted(os.listdir(OUTPUT_DIR)) print(f"\nFirst 10 extracted files:") for filename in output_files[:10]: filepath = os.path.join(OUTPUT_DIR, filename) size = os.path.getsize(filepath) print(f" {filename} ({size:,} bytes)") # Sample output: # First 10 extracted files: # account.html (31,671 bytes) # accountingPeriod.html (32,058 bytes) # advIntercompanyJournalEntry.html (32,531 bytes) # analyticalImpact.html (32,058 bytes) # assemblyBuild.html (38,249 bytes) # assemblyItem.html (44,452 bytes) # assemblyUnbuild.html (32,015 bytes) # billingAccount.html (31,972 bytes) # billingRevenueEvent.html (32,187 bytes) # billingSchedule.html (32,015 bytes) # Step 5: Parse an extracted file to access API documentation with open(os.path.join(OUTPUT_DIR, 'account.html'), 'r', encoding='utf-8') as f: soup = BeautifulSoup(f.read(), 'html.parser') ``` -------------------------------- ### GET /location/{id} - Get Location Record Source: https://github.com/plague69/netsuite-doc-extract/blob/main/extracted_html_files/location.html Retrieves a specific location record by its ID. ```APIDOC ## GET /location/{id} ### Description Retrieves a specific location record by its ID. ### Method GET ### Endpoint /location/{id} ### Parameters #### Path Parameters - **id** (integer) - Required - Internal identifier of the location record to retrieve. #### Header Parameters - **Prefer** (string) - Optional - The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. - **X-NetSuite-Idempotency-Key** (string) - Optional - A user-defined unique idempotency key for asynchronous requests. ### Response #### Success Response (200 OK) - **location** (object) - The requested location record. #### Response Example { "example": "location" } #### Error Response - **nsError** (object) - Error response. #### Error Response Example { "example": "nsError" } ``` -------------------------------- ### POST /partner Source: https://github.com/plague69/netsuite-doc-extract/blob/main/extracted_html_files/partner.html Creates a new partner record. Supports asynchronous responses and idempotency. ```APIDOC ## POST /partner ### Description Creates a new partner record. Supports asynchronous responses, idempotency keys, and strict validation options for property names and values. ### Method POST ### Endpoint /partner ### Parameters #### Header Parameters - **Prefer** (string) - Optional - Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response. - **X-NetSuite-Idempotency-Key** (string) - Optional - A user-defined unique idempotency key for asynchronous requests to ensure they are executed only once. Uses UUID format (RFC 4122). Ignored for synchronous requests. - **X-NetSuite-PropertyNameValidation** (string) - Optional - Sets the strictness of property name validation. Allowed values: 'Error', 'Warning', 'Ignore Warning'. - **X-NetSuite-PropertyValueValidation** (string) - Optional - Sets the strictness of property value validation. Allowed values: 'Error', 'Warning', 'Ignore Error'. #### Query Parameters - **replace** (string) - Optional - The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. Names are delimited by a comma. #### Request Body - **partner** (object) - Required - The partner record to be created. The structure of this object is defined by the partner schema linked in the NetSuite documentation. ### Request Example ```json { "partner": { "companyName": "Example Partner Corp", "email": "contact@examplepartner.com" // ... other partner fields } } ``` ### Response #### Success Response (204 No Content) Indicates the record was successfully inserted. #### Response Example (No response body for 204 No Content) #### Error Response - **nsError** - An error response object. ``` -------------------------------- ### GET /manufacturingOperationTask/{id} - Get Record Source: https://github.com/plague69/netsuite-doc-extract/blob/main/extracted_html_files/manufacturingOperationTask.html Retrieves a specific manufacturing operation task record by its ID. ```APIDOC ## GET /manufacturingOperationTask/{id} ### Description Retrieves a specific manufacturing operation task record by its ID. ### Method GET ### Endpoint /manufacturingOperationTask/{id} ### Parameters #### Path Parameters - **id** (integer) - Required - The internal identifier of the manufacturing operation task to retrieve. #### Headers - **Prefer** (string) - Optional - Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response. ### Response #### Success Response (200) - **manufacturingOperationTask** (object) - The manufacturing operation task record. - **id** (string) - The unique identifier for the manufacturing operation task. - **taskName** (string) - The name of the task. - **status** (string) - The status of the task. #### Response Example ```json { "id": "123", "taskName": "Assembly Task", "status": "PENDING" } ``` #### Error Response - **nsError** (object) - Error response. ``` -------------------------------- ### POST /subscriptionPlan - Insert Subscription Plan Source: https://github.com/plague69/netsuite-doc-extract/blob/main/extracted_html_files/subscriptionPlan.html Creates a new subscription plan record. Allows for asynchronous operations. ```APIDOC ## POST /subscriptionPlan ### Description Creates a new subscription plan record. Allows for asynchronous operations. ### Method POST ### Endpoint /subscriptionPlan ### Parameters #### Query Parameters - **replace** (string) - Optional - Specifies sublist names to be replaced. #### Headers - **Prefer** (string) - Optional - Specifies the server behavior, e.g., 'respond-async' for asynchronous execution. - **X-NetSuite-Idempotency-Key** (string) - Optional - A unique idempotency key for asynchronous requests. - **X-NetSuite-PropertyNameValidation** (string) - Optional - Sets the strictness of property name validation ('Error', 'Warning', 'Ignore Warning'). - **X-NetSuite-PropertyValueValidation** (string) - Optional - Sets the strictness of property value validation ('Error', 'Warning', 'Ignore Error'). #### Request Body - **subscriptionPlan** - The subscription plan object to be inserted. ### Request Example ```json { "name": "Premium Plan", "price": 99.99 } ``` ### Response #### Success Response (204 No Content) - Indicates successful insertion. #### Error Response - **nsError** - An error response object. ``` -------------------------------- ### GET /location - Get List of Locations Source: https://github.com/plague69/netsuite-doc-extract/blob/main/extracted_html_files/location.html Retrieves a list of location records. Supports filtering and pagination. ```APIDOC ## GET /location ### Description Retrieves a list of location records. Supports filtering and pagination. ### Method GET ### Endpoint /location ### Parameters #### Query Parameters - **Prefer** (string) - Optional - The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. - **X-NetSuite-Idempotency-Key** (string) - Optional - A user-defined unique idempotency key for asynchronous requests. - **q** (string) - Optional - The search query used to filter results. - **limit** (integer) - Optional - The number of results on a single page. Defaults to 1000. - **offset** (integer) - Optional - The offset for selecting a specific page of results. Defaults to 0. ### Response #### Success Response (200 OK) - **locationCollection** (object) - A collection of location records. #### Response Example { "example": "locationCollection" } #### Error Response - **nsError** (object) - Error response. #### Error Response Example { "example": "nsError" } ``` -------------------------------- ### GET /usage/{id} - Get record Source: https://github.com/plague69/netsuite-doc-extract/blob/main/extracted_html_files/usage.html Retrieves a specific usage record by its ID. Supports asynchronous retrieval. ```APIDOC ## GET /usage/{id} ### Description Retrieves a single usage record based on its unique identifier. The request can be processed asynchronously. ### Method GET ### Endpoint /usage/{id} ### Parameters #### Path Parameters - **id** (integer) - Required - The internal identifier of the usage record to retrieve. #### Header Parameters - **Prefer** (string) - Optional - Specifies asynchronous response behavior ('respond-async'). - **X-NetSuite-Idempotency-Key** (string) - Optional - Unique key for asynchronous requests to ensure execution once. Use UUID format. ### Response #### Success Response (200) - **usage** (object) - The requested usage record object. (Refer to usage definition for schema) #### Response Example ```json { "id": "123", "type": "usage", "name": "Example Usage Record", "value": 100 } ``` #### Error Response - **nsError** - Error response object. ``` -------------------------------- ### POST /vendorReturnAuthorization Source: https://github.com/plague69/netsuite-doc-extract/blob/main/extracted_html_files/vendorReturnAuthorization.html Creates a new Vendor Return Authorization record. ```APIDOC ## POST /vendorReturnAuthorization ### Description Creates a new Vendor Return Authorization record. ### Method POST ### Endpoint /vendorReturnAuthorization ### Parameters #### Query Parameters - **Prefer** (string) - Optional - Specifies the server behavior, use 'respond-async' for asynchronous execution. - **X-NetSuite-Idempotency-Key** (string) - Optional - A unique key for asynchronous requests to ensure execution only once. - **replace** (string) - Optional - Specifies sublists to be replaced with lines from the request. #### Header Parameters - **X-NetSuite-PropertyNameValidation** (string) - Optional - Sets the strictness of property name validation (Error, Warning, Ignore Warning). - **X-NetSuite-PropertyValueValidation** (string) - Optional - Sets the strictness of property value validation (Error, Warning, Ignore Error). ### Request Body - **vendorReturnAuthorization** - The Vendor Return Authorization object to be created. ### Response #### Success Response (204) No Content, indicating successful insertion. #### Error Response - **nsError** - An error response object. ``` -------------------------------- ### POST /vendorPrepaymentApplication Source: https://github.com/plague69/netsuite-doc-extract/blob/main/extracted_html_files/vendorPrepaymentApplication.html Inserts a new Vendor Prepayment Application record. Supports asynchronous processing and various validation options. ```APIDOC ## POST /vendorPrepaymentApplication ### Description Inserts a new Vendor Prepayment Application record. Supports asynchronous processing and various validation options. ### Method POST ### Endpoint /vendorPrepaymentApplication ### Parameters #### Header Parameters - **Prefer** (string) - Optional - The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. - **X-NetSuite-Idempotency-Key** (string) - Optional - A user-defined unique idempotency key for asynchronous requests. - **X-NetSuite-PropertyNameValidation** (string) - Optional - Sets the strictness of property name validation (Error, Warning, Ignore Warning). - **X-NetSuite-PropertyValueValidation** (string) - Optional - Sets the strictness of property value validation (Error, Warning, Ignore Error). #### Query Parameters - **replace** (string) - Optional - The names of sublists on this record to be replaced with lines specified in the request. #### Request Body - **vendorPrepaymentApplication** (object) - The Vendor Prepayment Application record to insert. ### Request Example ```json { "entity": {"id": "100"}, "paymentMethod": {"id": "1"}, "amount": 100.00 } ``` ### Response #### Success Response (204 No Content) Indicates that the record was successfully inserted. #### Error Response - **nsError** (object) - An error response object. ``` -------------------------------- ### GET /topic/{id} - Get Record Source: https://github.com/plague69/netsuite-doc-extract/blob/main/extracted_html_files/topic.html Retrieves a single topic record by its ID. Supports asynchronous execution. ```APIDOC ## GET /topic/{id} ### Description Retrieves a single topic record by its ID. Supports asynchronous execution. ### Method GET ### Endpoint /topic/{id} ### Parameters #### Path Parameters - **id** (integer) - Required - Internal identifier of the topic record to retrieve. #### Header Parameters - **Prefer** (string) - Optional - Use 'respond-async' to execute the request asynchronously. - **X-NetSuite-Idempotency-Key** (string) - Optional - A user-defined unique idempotency key for asynchronous requests. ### Response #### Success Response (200) - **topic** - The retrieved topic record. #### Response Example { "example": "[topic object reference]" } ``` -------------------------------- ### GET /subscription/{id} - Get Record Source: https://github.com/plague69/netsuite-doc-extract/blob/main/extracted_html_files/subscription.html Retrieves a specific subscription record by its ID. Supports asynchronous responses. ```APIDOC ## GET /subscription/{id} ### Description Retrieves a specific subscription record identified by its unique ID. Asynchronous execution is supported. ### Method GET ### Endpoint /subscription/{id} ### Parameters #### Path Parameters - **id** (integer, int32) - Required - The internal identifier of the subscription record to retrieve. #### Header Parameters - **Prefer** (string) - Optional - Specifies the server behavior, e.g., 'respond-async' for asynchronous execution. - **X-NetSuite-Idempotency-Key** (string) - Optional - A unique key for asynchronous requests to ensure execution only once (RFC 4122 format). ### Response #### Success Response (200 OK) - **subscription** - The subscription record object. #### Error Response - **nsError** - Error response object. ### Response Example (Success) ```json { "subscription": { "id": 123, "field1": "value1" } } ``` ``` -------------------------------- ### POST /assemblyBuild - Insert Assembly Build Record Source: https://github.com/plague69/netsuite-doc-extract/blob/main/extracted_html_files/assemblyBuild.html Creates a new assembly build record. Supports various header and query parameters for customization and idempotency. ```APIDOC ## POST /assemblyBuild ### Description Creates a new assembly build record. Supports various header and query parameters for customization and idempotency. ### Method POST ### Endpoint /assemblyBuild ### Parameters #### Header Parameters - **Prefer** (string) - Optional - Use 'respond-async' to execute the request asynchronously. - **X-NetSuite-Idempotency-Key** (string) - Optional - A user-defined unique idempotency key for asynchronous requests. - **X-NetSuite-PropertyNameValidation** (string) - Optional - Sets the strictness of property name validation (Error, Warning, Ignore Warning). - **X-NetSuite-PropertyValueValidation** (string) - Optional - Sets the strictness of property value validation (Error, Warning, Ignore Error). #### Query Parameters - **replace** (string) - Optional - Comma-delimited names of sublists to replace. #### Request Body - **assemblyBuild** (object) - Required - The assembly build object to be inserted. Refer to the [assemblyBuild definition](https://system.netsuite.com/help/helpcenter/en_US/APIs/REST_API_Browser/record/v1/2025.2/index.html#/definitions/assemblyBuild). ### Request Example ```json { "assembly": "FURNITURE", "memo": "New build for furniture" } ``` ### Response #### Success Response (204 No Content) - Indicates successful insertion of the record. #### Error Response - **nsError** - Error response object. ### Response Example (Success) (No content is returned on success) ``` -------------------------------- ### GET /revRecTemplate/{id} - Get Record Source: https://github.com/plague69/netsuite-doc-extract/blob/main/extracted_html_files/revRecTemplate.html Retrieves a specific revRecTemplate record by its ID. Supports asynchronous processing. ```APIDOC ## GET /revRecTemplate/{id} ### Description Retrieves a specific revRecTemplate record using its internal identifier. Supports asynchronous processing. ### Method GET ### Endpoint /revRecTemplate/{id} ### Parameters #### Path Parameters - **id** (integer) - Required - The internal identifier of the revRecTemplate record to retrieve. #### Headers - **Prefer** (string) - Optional - Use 'respond-async' to execute the request asynchronously. - **X-NetSuite-Idempotency-Key** (string) - Optional - A user-defined unique idempotency key for asynchronous requests. ### Response #### Success Response - **revRecTemplate** - The requested revRecTemplate record details. #### Error Response - **nsError** - Error response details. ``` -------------------------------- ### POST /couponCode Source: https://github.com/plague69/netsuite-doc-extract/blob/main/extracted_html_files/couponCode.html Creates a new coupon code record. This endpoint supports asynchronous responses and idempotency keys. ```APIDOC ## POST /couponCode ### Description Creates a new coupon code record. This endpoint supports asynchronous responses and idempotency keys. ### Method POST ### Endpoint /couponCode ### Parameters #### Query Parameters - **replace** (string) - Optional - The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The names are delimited by comma. #### Headers - **Prefer** (string) - Optional - Use 'respond-async' to execute the request asynchronously. - **X-NetSuite-Idempotency-Key** (string) - Optional - A user-defined unique idempotency key for asynchronous requests. - **X-NetSuite-PropertyNameValidation** (string) - Optional - Sets the strictness of property name validation (Error, Warning, Ignore Warning). - **X-NetSuite-PropertyValueValidation** (string) - Optional - Sets the strictness of property value validation (Error, Warning, Ignore Error). ### Request Body - **couponCode** (object) - Required - The coupon code record to be inserted. ### Response #### Success Response (204 No Content) - Indicates successful insertion of the record. #### Error Response - **nsError** - An error response object. ``` -------------------------------- ### GET /priceLevel/{id} - Get Price Level Source: https://github.com/plague69/netsuite-doc-extract/blob/main/extracted_html_files/priceLevel.html Retrieves a specific price level record by its unique ID. ```APIDOC ## GET /priceLevel/{id} ### Description Retrieves a specific price level record by its unique ID. ### Method GET ### Endpoint /priceLevel/{id} ### Parameters #### Path Parameters - **id** (integer) - Required - The internal identifier of the price level to retrieve. #### Header Parameters - **Prefer** (string) - Optional - Use 'respond-async' to execute the request asynchronously. - **X-NetSuite-Idempotency-Key** (string) - Optional - A user-defined unique idempotency key for asynchronous requests. ### Response #### Success Response (200) - **priceLevel** (object) - The requested price level record. #### Response Example ```json { "example": "[priceLevel](https://system.netsuite.com/help/helpcenter/en_US/APIs/REST_API_Browser/record/v1/2025.2/index.html#/definitions/priceLevel)" } ``` #### Error Response - **nsError** (object) - Error response. ``` -------------------------------- ### GET /discountItem Source: https://github.com/plague69/netsuite-doc-extract/blob/main/extracted_html_files/discountItem.html Retrieves a list of discount items. Supports filtering, pagination, and asynchronous processing. ```APIDOC ## GET /discountItem ### Description Retrieves a list of discount items. Supports filtering, pagination, and asynchronous processing. ### Method GET ### Endpoint /discountItem ### Parameters #### Query Parameters - **Prefer** (string) - Optional - Use 'respond-async' to execute the request asynchronously. - **X-NetSuite-Idempotency-Key** (string) - Optional - A user-defined unique idempotency key for asynchronous requests. - **q** (string) - Optional - The search query to filter results. - **limit** (integer) - Optional - The number of results to return per page. Defaults to 1000. - **offset** (integer) - Optional - The offset for selecting a specific page of results. Defaults to 0. ### Response #### Success Response (200 OK) - **discountItemCollection** - A collection of discount items. #### Error Response - **nsError** - An error object if the request fails. ### Response Example (Success) ```json { "items": [ { "id": "123", "name": "Sample Discount Item" } ], "count": 1 } ``` ``` -------------------------------- ### GET /otherName/{id} - Get Record Source: https://github.com/plague69/netsuite-doc-extract/blob/main/extracted_html_files/otherName.html Retrieves a specific 'otherName' record by its ID. Supports asynchronous processing. ```APIDOC ## GET /otherName/{id} ### Description Retrieves a specific 'otherName' record by its ID. Supports asynchronous processing. ### Method GET ### Endpoint /otherName/{id} ### Parameters #### Path Parameters - **id** (integer) - Required - The internal identifier of the 'otherName' record to retrieve. #### Headers - **Prefer** (string) - Optional - Use 'respond-async' to execute the request asynchronously. If the request is executed asynchronously, 'Preference-applied: respond-async' is returned in the response. - **X-NetSuite-Idempotency-Key** (string) - Optional - A user-defined unique idempotency key applied to asynchronous requests to ensure the request is executed only once. Use UUID format (RFC 4122). Ignored for synchronous requests. ### Response #### Success Response (200 OK) - **otherName** (object) - The requested 'otherName' record. #### Response Example ```json { "id": "123", "name": "Example OtherName", "customField": "someValue" } ``` #### Error Response - **nsError** (object) - Error response object. ``` -------------------------------- ### POST /webSite - Insert Record Source: https://github.com/plague69/netsuite-doc-extract/blob/main/extracted_html_files/webSite.html Creates a new web site record. Supports asynchronous creation and various validation options for property names and values. ```APIDOC ## POST /webSite ### Description Inserts a new web site record. Supports asynchronous execution and custom validation settings. ### Method POST ### Endpoint /webSite ### Parameters #### Query Parameters - **Prefer** (string) - Optional - Use 'respond-async' to execute the request asynchronously. - **replace** (string) - Optional - Comma-delimited list of sublists to replace. #### Header Parameters - **X-NetSuite-Idempotency-Key** (string) - Optional - A unique idempotency key for asynchronous requests (RFC 4122 UUID format). - **X-NetSuite-PropertyNameValidation** (string) - Optional - Sets the strictness of property name validation ('Error', 'Warning', 'Ignore Warning'). - **X-NetSuite-PropertyValueValidation** (string) - Optional - Sets the strictness of property value validation ('Error', 'Warning', 'Ignore Error'). #### Request Body - **webSite** - The web site record to insert. ### Response #### Success Response (204 No Content) - Indicates the record was successfully inserted. #### Error Response - **nsError** - Error response object. ``` -------------------------------- ### GET /otherChargePurchaseItem/{id} - Get Record Source: https://github.com/plague69/netsuite-doc-extract/blob/main/extracted_html_files/otherChargePurchaseItem.html Retrieves a specific OtherChargePurchaseItem record by its ID. Supports asynchronous operations. ```APIDOC ## GET /otherChargePurchaseItem/{id} ### Description Retrieves a specific OtherChargePurchaseItem record using its unique internal identifier. Supports asynchronous execution. ### Method GET ### Endpoint /otherChargePurchaseItem/{id} ### Parameters #### Path Parameters - **id** (integer, int32) - Required - The internal identifier of the OtherChargePurchaseItem record to retrieve. #### Headers - **Prefer** (string) - Optional - Use 'respond-async' to execute the request asynchronously. - **X-NetSuite-Idempotency-Key** (string) - Optional - A user-defined unique idempotency key for asynchronous requests (UUID format). (Note: Idempotency key is typically ignored for GET requests but listed as per provided spec). ### Response #### Success Response (200 OK) - **otherChargePurchaseItem** (object) - The requested OtherChargePurchaseItem record. - (Schema for otherChargePurchaseItem object goes here) #### Error Response - **nsError** (object) - An error response object. ### Response Example (Success) ```json { "id": "123", "name": "Example Item", "amount": 100.50 } ``` ### Response Example (Error) ```json { "error": { "code": "RECORD_NOT_FOUND", "message": "The specified record could not be found." } } ``` ``` -------------------------------- ### List Deposit Applications Source: https://github.com/plague69/netsuite-doc-extract/blob/main/extracted_html_files/depositApplication.html Retrieves a list of deposit application records. Supports filtering, pagination, and asynchronous execution. ```APIDOC ## GET /depositApplication ### Description Retrieves a list of deposit application records. Supports filtering using a search query, pagination with limit and offset, and asynchronous execution. ### Method GET ### Endpoint /depositApplication ### Parameters #### Query Parameters - **q** (string) - Optional - The search query that is used to filter results. - **limit** (integer) - Optional - The limit used to specify the number of results on a single page. Defaults to 1000. - **offset** (integer) - Optional - The offset used for selecting a specific page of results. Defaults to 0. #### Headers - **Prefer** (string) - Optional - Use 'respond-async' to execute the request asynchronously. - **X-NetSuite-Idempotency-Key** (string) - Optional - A user-defined unique idempotency key for asynchronous requests. ### Response #### Success Response (200 OK) - **depositApplicationCollection** (object) - A collection of deposit application records. #### Response Example ```json { "items": [ { "internalId": "123", "name": "Deposit App 1" }, { "internalId": "456", "name": "Deposit App 2" } ], "totalResults": 2 } ``` #### Error Response - **nsError** (object) - An error object if the request fails. ``` -------------------------------- ### POST /downloadItem Source: https://github.com/plague69/netsuite-doc-extract/blob/main/extracted_html_files/downloadItem.html Inserts a new record into NetSuite. Supports asynchronous operations and various validation preferences. ```APIDOC ## POST /downloadItem ### Description Inserts a new record. Supports asynchronous processing, and allows specifying preferences for property name and value validation. Sublist lines can be replaced if the 'replace' query parameter is used. ### Method POST ### Endpoint /downloadItem ### Parameters #### Query Parameters - **replace** (string) - Optional - The names of sublists to replace with lines specified in the request. #### Headers - **Prefer** (string) - Optional - Use 'respond-async' to execute the request asynchronously. - **X-NetSuite-Idempotency-Key** (string) - Optional - A user-defined unique idempotency key for asynchronous requests. - **X-NetSuite-PropertyNameValidation** (string) - Optional - Sets the strictness of property name validation (Error, Warning, Ignore Warning). - **X-NetSuite-PropertyValueValidation** (string) - Optional - Sets the strictness of property value validation (Error, Warning, Ignore Error). ### Request Body - **downloadItem** - The record data to be inserted. ### Response #### Success Response (204) - No Content. Indicates successful insertion. #### Error Response - **nsError** - Error response details. ``` -------------------------------- ### GET /nexus/{id} - Get Record Source: https://github.com/plague69/netsuite-doc-extract/blob/main/extracted_html_files/nexus.html Retrieves a specific record from NetSuite by its ID. Supports asynchronous operations. ```APIDOC ## GET /nexus/{id} ### Description Retrieves a specific record from NetSuite using its unique identifier. Asynchronous execution is supported for this operation. ### Method GET ### Endpoint /nexus/{id} ### Parameters #### Path Parameters - **id** (integer) - Required - The internal identifier of the record to retrieve. #### Headers - **Prefer** (string) - Optional - Use 'respond-async' to execute the request asynchronously. If used, 'Preference-applied: respond-async' is returned in the response. - **X-NetSuite-Idempotency-Key** (string) - Optional - A user-defined unique idempotency key for asynchronous requests. UUID format (RFC 4122). ### Response #### Success Response (200) - **nexus** - The requested record object. #### Error Response - **nsError** - Error response details. ### Response Example ```json { "id": "123", "name": "Example Record", "fields": { "customfield1": "value1" } } ``` ``` -------------------------------- ### GET /estimate/{id} - Get Estimate Source: https://github.com/plague69/netsuite-doc-extract/blob/main/extracted_html_files/estimate.html Retrieves a specific estimate record by its ID. Supports asynchronous operations. ```APIDOC ## GET /estimate/{id} ### Description Retrieves a specific estimate record by its ID. Supports asynchronous operations. ### Method GET ### Endpoint /estimate/{id} ### Parameters #### Path Parameters - **id** (integer) - Required - The internal identifier of the estimate record to retrieve. #### Header Parameters - **Prefer** (string) - Optional - The server behavior requested by the client. Use 'respond-async' to execute the request asynchronously. - **X-NetSuite-Idempotency-Key** (string) - Optional - A user-defined unique idempotency key for asynchronous requests. ### Response #### Success Response (200) - **estimate** - The requested estimate record. #### Error Response - **nsError** - Error response. ``` -------------------------------- ### GET /assemblyBuild - Get List of Assembly Builds Source: https://github.com/plague69/netsuite-doc-extract/blob/main/extracted_html_files/assemblyBuild.html Retrieves a list of assembly build records. Supports filtering, pagination, and asynchronous response. ```APIDOC ## GET /assemblyBuild ### Description Retrieves a list of assembly build records. Supports filtering, pagination, and asynchronous response. ### Method GET ### Endpoint /assemblyBuild ### Parameters #### Header Parameters - **Prefer** (string) - Optional - Use 'respond-async' to execute the request asynchronously. - **X-NetSuite-Idempotency-Key** (string) - Optional - A user-defined unique idempotency key for asynchronous requests. #### Query Parameters - **q** (string) - Optional - The search query to filter results. - **limit** (integer, int32) - Optional (default: 1000) - The maximum number of results to return per page. - **offset** (integer, int32) - Optional (default: 0) - The number of results to skip for pagination. ### Response #### Success Response (200 OK) - **assemblyBuildCollection** - A collection of assembly build records. #### Error Response - **nsError** - Error response object. ### Response Example (Success) ```json { "items": [ { "id": "123", "name": "Example Build" } ], "count": 1, "totalResults": 10 } ``` ``` -------------------------------- ### GET /bin Source: https://github.com/plague69/netsuite-doc-extract/blob/main/extracted_html_files/bin.html Retrieves a bin record. Supports expanding sub-resources and formatting enumeration values. ```APIDOC ## GET /bin ### Description Retrieves a bin record. You can control the expansion of sub-resources and the format of enumeration values. ### Method GET ### Endpoint /bin ### Parameters #### Query Parameters - **expandSubResources** (boolean) - Optional - Set to 'true' to automatically expand all sublists, sublist lines, and subrecords on this record. - **simpleEnumFormat** (boolean) - Optional - Set to true to return enumeration values in a format that only shows the internal ID value. - **fields** (string) - Optional - The names of the fields and sublists on the record. Only the selected fields and sublists will be returned in the response. ### Response #### Success Response (200 OK) - **(Record Structure)** - The retrieved bin record. #### Response Example ```json { "internalId": "123", "name": "Bin 1", "location": { "internalId": "456" } } ``` #### Error Response - **nsError** - Details of the error. #### Error Response Example ```json { "status": 400, "message": "Invalid request" } ``` ``` -------------------------------- ### GET /expenseReport - Get List of Expense Reports Source: https://github.com/plague69/netsuite-doc-extract/blob/main/extracted_html_files/expenseReport.html Retrieves a list of expense reports, with options for filtering and pagination. ```APIDOC ## GET /expenseReport ### Description Retrieves a list of expense reports. Supports filtering via a search query and pagination using limit and offset. ### Method GET ### Endpoint /expenseReport ### Parameters #### Query Parameters - **Prefer** (string) - Optional - Specifies the server behavior, e.g., 'respond-async' for asynchronous execution. - **X-NetSuite-Idempotency-Key** (string) - Optional - A unique idempotency key for asynchronous requests (RFC 4122 UUID format). - **q** (string) - Optional - The search query to filter results. - **limit** (integer, int32) - Optional - The number of results per page. Defaults to 1000. - **offset** (integer, int32) - Optional - The offset for selecting a specific page of results. Defaults to 0. ### Response #### Success Response (200 OK) - Returns an `expenseReportCollection` which is a list of expense report records. #### Response Example (Success) ```json { "items": [ { "id": "123", "expenseDate": "2023-01-01", "total": 50.00 } ], "count": 1 } ``` #### Error Response - Returns an `nsError` object for errors. ``` -------------------------------- ### POST /itemAccountMapping Source: https://github.com/plague69/netsuite-doc-extract/blob/main/extracted_html_files/itemAccountMapping.html Creates a new item account mapping record. ```APIDOC ## POST /itemAccountMapping ### Description Creates a new item account mapping record. ### Method POST ### Endpoint /itemAccountMapping #### Query Parameters - **replace** (string) - Optional - The names of sublists on this record. All sublist lines will be replaced with lines specified in the request. The names are delimited by comma. #### Headers - **Prefer** (string) - Optional - Use 'respond-async' to execute the request asynchronously. - **X-NetSuite-Idempotency-Key** (string) - Optional - A user-defined unique idempotency key for asynchronous requests. - **X-NetSuite-PropertyNameValidation** (string) - Optional - Sets the strictness of property name validation (Error, Warning, Ignore Warning). - **X-NetSuite-PropertyValueValidation** (string) - Optional - Sets the strictness of property value validation (Error, Warning, Ignore Error). #### Request Body - **itemAccountMapping** (object) - Required - The item account mapping object to be created. ### Request Example ```json { "itemAccountMapping": { "item": "someItemId", "account": "someAccountId", "subsidiary": "someSubsidiaryId" } } ``` ### Response #### Success Response (204) - No content returned on successful creation. #### Error Response - **nsError** - Error response. ``` -------------------------------- ### GET /webSite/{id} - Get Record Source: https://github.com/plague69/netsuite-doc-extract/blob/main/extracted_html_files/webSite.html Retrieves a specific web site record by its ID. Supports asynchronous retrieval. ```APIDOC ## GET /webSite/{id} ### Description Retrieves a specific web site record by its ID. Supports asynchronous execution. ### Method GET ### Endpoint /webSite/{id} ### Parameters #### Path Parameters - **id** (integer, int32) - Required - The internal identifier of the web site record to retrieve. #### Header Parameters - **Prefer** (string) - Optional - Use 'respond-async' to execute the request asynchronously. - **X-NetSuite-Idempotency-Key** (string) - Optional - A unique idempotency key for asynchronous requests (RFC 4122 UUID format). ### Response #### Success Response (200 OK) - **webSite** - The requested web site record. #### Error Response - **nsError** - Error response object. ```