Credit Memo

A credit memo record exposes a credit memo to REST web services.

To access this record in NetSuite, go to Transactions > Customers > Issue Credit Memos.

A credit memo is used to refund or credit a customer account. For more information, see Customer Credit Memos.

This record has the following subrecords:

• Accounting Books (accountingbookdetail)

• Applied Rules (appliedrules)

• Apply (apply)

• Item Line Address (iladdrbook)

• Credit Memo Item (item)

• Partner (partner)

• Promotions (promotions)

• Sales Team (salesteam)

• Shipment (shipgroup)

• Taxes (taxdetails)

The REST API Browser includes information about the field names and field types of the credit memo record and about the HTTP methods, request parameters, and operations available to this record.

For details, see the REST API Browser's credit memo reference page.

For information about using the REST API browser, see The REST API Browser.

This record has fields related to taxation features. Refer to the following table for details:

Tax Feature	ID	Label	Type
TAX_OVERHAULING	entitytaxregnum	Customer Tax Reg. Number	SELECT
	handlingtaxamount	Handling Tax Amount	CURRENCY
	shippingtaxamount	Shipping Tax Amount	CURRENCY
	subsidiarytaxregnum	Subsidiary Tax Reg. Number	SELECT
	taxdetails	Taxes	SUBLIST
	taxdetailsoverride	Tax Details Override	CHECKBOX
	taxpointdate	Tax Point Date	DATE
	taxpointdateoverride	Tax Point Date Override	CHECKBOX
	taxregoverride	Tax Registration Override	CHECKBOX
	totalaftertaxes	Total After Taxes	CURRENCY
NOTTAX_OVERHAULING	handlingtax1rate	Tax Rate	RATE
	handlingtax2rate	Tax Rate	RATE
	handlingtaxcode	Handling Tax Code	SELECT
	istaxable	Taxable	CHECKBOX
	shippingtax1rate	Tax Rate	RATE
	shippingtax2rate	Tax Rate	RATE
	shippingtaxcode	Shipping Tax Code	SELECT
	tax2total	PST	CURRENCY
	taxitem	Tax Item	SELECT
	taxrate	Tax Rate	FLOAT
	vatregnum	VAT Registration	TEXT

To view the complete list of fields, go to Credit Memo in the SuiteScript Records Browser.

Note:

REST web services do not support legacy tax features. To work with taxation through REST web services, you must have the SuiteTax feature enabled. For more information about using SuiteTax, see SuiteTax.

Record ID

The record ID for the credit memo record is creditmemo.

Prerequisites

Before you can use this record through REST web services, you must first enable the Accounts Receivable feature. Go to Setup > Company > Setup Tasks > Enable Features. On the Accounting subtab, check the A/R box, and then click Save.

Usage Notes

To use the Choose Team and Update Customer fields in the Sales Team subtab, an administrator must first enable the Team Selling feature. Go to Setup > Company > Enable Features. Select the CRM subtab. Under Sales, check the Team Selling box, and then click Save.

To use the Update Customer field in the Relationships subtab, an administrator must first enable the Multi-Partner Management feature. Go to Setup > Company > Setup Tasks > Enable Features. Select the CRM subtab. Under Partners, check the Multi-Partner Management box, and then click Save.

Code Sample

The following example is for credit memos.

Create a Credit Memo

              POST: https://demo123.suitetalk.api.netsuite.com/services/rest/record/v1/creditmemo { "entity": { "id": "4" }, "item": { "items": [ { "amount": 1000.0, "item": { "id": "5" } } ] }, "subsidiary": { "id": "1" } "location": "5"
} 

            

Read a Credit Memo

              GET: https://demo123.suitetalk.api.netsuite.com/services/rest/record/v1/creditmemo/101 

            

Update a Credit Memo

              PATCH: https://demo123.suitetalk.api.netsuite.com/services/rest/record/v1/creditmemo/101
{"memo": 'test memo'} 

            

Update a Credit Memo with a Line Item

              PATCH {{REST_SERVICES}}/record/v1/creditmemo/{id}
{
    "tranDate": "2026-01-20",
    "tranId": "Updated Credit Memo ID",
    "item": {
        "items": [
            {
                "item": {
                    "id": "7"
                },
                "line": 1, // including line field will update the existing line at this index, excluding will add a new line
                "quantity": 1.0
            }
        ]
    }
} 

            

Set the Sales Order's Sales Team Members to Match Sales Group 164

              "salesGroup": {
    "id": 164 } 

            

Update the Customer's Partner Team to Match the Transaction Partners

              "syncPartnerTeams": true 

            

Update the Customer's Sales Team to Match the Transaction Sales Team

              "syncSalesTeams": true 

            

Related Topics

• REST Web Services Supported Records
• Overview of SuiteTalk REST Web Services
• Working with Records
• NetSuite Record Structure
• The REST API Browser

General Notices