---
title: Read
slug: netsuite/ocab-read
docTags: 
createdAt: 2025-01-30T16:04:48.776Z
---

To read Billing Schedules, please use the parameters below.

### Supported “*where*” Filters

| **Field Name** | **Data Type** | **Description**                                                                            |
| -------------- | ------------- | ------------------------------------------------------------------------------------------ |
| internalId     | String        | Internal ID of the Cash Refund. Multiple values can be passed in a comma-separated string. |
| isInactive     | Boolean       | Specified whether a Billing Schedule is Inactive or Active                                 |

### Example

:::CodeblockTabs
Request

```apex
Map<String, Object> filters = new Map<String, Object>();
filters.put('internalId', '1,2'); // provide the internal id of the Billing Schedules here
// Encode additionalFilter after constructing it with +and+ for multi-filters

// field filters and additionalFilter for where param
Map<String, Object> filterMap = new Map<String, Object>();
filterMap.put('where', new Map<String, Object>{'keyValueMap'=>filters}); 

Map<String, Object> requestJSONMap = new Map<String, Object>();
requestJSONMap.put('customParameters', filterMap);

String reqJSON = JSON.serialize(requestJSONMap);

Map<String, Object> reqObj = new Map<String, Object>();
reqObj.put('version', '1.0');
reqObj.put('action', 'readBillingSchedule');
reqObj.put('updateSF', true);
reqObj.put('requestJSON', reqJSON);

// Place a request to Breadwinner Global API
Map<String, Object> resp = breadwinner_ns.BreadwinnerNetSuiteAPI.call(reqObj);
System.debug(resp);
```

Response

```json
{
  action=readBillingSchedule,
  responseJSON={
    "billingSchedules": [
      {
        "scheduleType": "_standard",
        "repeatEvery": "_3",
        "project": null,
        "numberRemaining": 8,
        "name": "25% Down, Quarterly - 2 Years",
        "isPublic": true,
        "isInactive": false,
        "internalId": "1",
        "initialTerms": {
          "typeId": null,
          "type": null,
          "name": "Net 15",
          "internalId": "1",
          "externalId": null
        },
        "initialAmount": "25.0%",
        "inArrears": false,
        "frequency": "_monthly",
        "dayPeriod": null,
        "billForActuals": null,
        "applyToSubtotal": false
      },
      {
        "scheduleType": "_standard",
        "repeatEvery": null,
        "project": null,
        "numberRemaining": 0,
        "name": "100% Upfront",
        "isPublic": true,
        "isInactive": false,
        "internalId": "2",
        "initialTerms": {
          "typeId": null,
          "type": null,
          "name": "Net 30",
          "internalId": "2",
          "externalId": null
        },
        "initialAmount": "100.0%",
        "inArrears": true,
        "frequency": "_never",
        "dayPeriod": null,
        "billForActuals": null,
        "applyToSubtotal": false
      }
    ],
    "customParamters": {
      "where": {
        "value": null,
        "keyValueMap": {
          "internalId": "5,6"
        }
      }
    },
    "currentPageRecords": 2,
    "totalRecords": 2,
    "totalPages": 1,
    "searchId": "WEBSERVICES_TD2876965_04282025208306621156539071_68a11246570",
    "pageIndex": 1,
    "errors": [
      
    ],
    "status": "200"
  },
  timestamp=1745839789359,
  validRequest=true,
  version=1.0
}
```
:::