1. SuiteCloud Platform
  2. SuiteTalk Web Services
  3. SuiteTalk REST Web Services Records Guide
  4. REST Web Services Supported Records
  5. Cash Refund

Cash Refund

The cash refund record exposes a cash refund to REST web services.

To access this record in NetSuite, go to Transactions > Customers > Refund Cash Sales.

A cash refund transaction records the return of money to a customer who immediately paid for goods or services using cash, a check or a credit card. For details about this type of transaction, see Refunding a Cash Sale.

This record has the following subrecords:

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

For details, see the REST API Browser's cash refund 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

 

 

 

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 Cash Refund 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 a cash refund REST record is cashrefund.

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

Using this record requires you to specify an item line number that is 1-indexed.

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 Samples

These samples show common use cases for cash refunds.

Create a Cash Refund

              POST: https://demo123.suitetalk.api.netsuite.com/services/rest/record/v1/cashrefund
{ "account": { "id": "155", "refName": "660 US Bank USD" }, "currency": { "id": "1", "refName": "USA" }, "entity": { "id": "110", "refName": "Anonymous Customer" }, "item": { "items": [ { "item": { "id": "98" }, "quantity": 1 } ] }, "location": { "id": "6", "refName": "US ONLY LOCATION" }
}

Read a Cash Refund

              GET: https://demo123.suitetalk.api.netsuite.com/services/rest/record/v1/cashrefund/318

Update a Cash Refund

              PATCH: https://demo123.suitetalk.api.netsuite.com/services/rest/record/v1/cashrefund/318
{ "account": { "id": "155", "refName": "660 US Bank USD" }, "currency": { "id": "1", "refName": "USA" }, "entity": { "id": "110", "refName": "Anonymous Customer" }, "item": { "items": [ { "line": 1, "refName": "Custom", "rate": 49.95, "item": { "id": "98" }, "quantity": 2 } ] }, "location": { "id": "6", "refName": "US ONLY LOCATION" }
}

Update a Cash Refund with a Line Item

              PATCH {{REST_SERVICES}}/record/v1/cashrefund/{id}
{
    "tranDate": "2026-01-20",
    "tranId": "Updated Cash Refund 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
            }
        ]
    }
}

Delete a Cash Refund

              DELETE: https://demo123.suitetalk.api.netsuite.com/services/rest/record/v1/cashrefund/318

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

General Notices